Global functions

Pauses the current script. The duration unit is not documented here.

Stops the current script.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Returns the absolute value of an integer.

Consumes four bytes and delegates the integer to format %ld in the shared formatting buffer.

Returns the smaller of the two values.

Returns the larger of the two values.

Limits a value to the supplied lower and upper bounds.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Returns the square root of a value.

Converts the binary64 input to an integer through truncation and retains the 32-bit result.

Consumes an eight-byte floating-point value and formats it with %f in the shared formatting buffer.

Returns the smaller of the two values.

Returns the larger of the two values.

Limits a value to the supplied lower and upper bounds.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Consumes 256 bytes, copies the packed string, terminates payload at its unsigned length byte, and delegates format %s.

Consumes the eight-byte managed string cell, delegates its pointer plus four to format %s, then decrements and conditionally releases the reference.

Behavior awaiting documentation.

Behavior awaiting documentation.

Compares two strings. Returns a negative number, zero or a positive number; it is not a boolean equality check.

Appends the second string to the first, modifying the first string.

Splits text at its first comma, returning a trimmed token and updating the output string.

Checks whether a string contains another string.

Parses comma-delimited entries and compares each source key token against the supplied key for the source token length.

Finds a named space-delimited entry and returns its comma-terminated remainder as a managed string.

Behavior awaiting documentation.

Returns the position of the first matching character, or -1 if it is not found. The position's indexing convention is not specified here.

The final int is popped before the eight-byte str.

Checks whether the string pointer is null. A nonnull string also undergoes reference-count cleanup.

Returns the length of a CKS string in bytes.

Clamps the requested count with signed comparisons and copies from payload plus the unchanged start index.

Converts a string to an integer. Conversion edge cases are not described here yet.

Behavior awaiting documentation.

Behavior awaiting documentation.

Checks whether the two integer values share any set bits.

Sets or clears the requested bits in an integer passed by reference.

Creates a point from its horizontal coordinate x and vertical coordinate y, in that order.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

returns the integer square root of dx squared plus dy squared.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

IntersectRects returns componentwise signed max,max,min,min of its two four-dword rectangles.

Computes the union of two rectangles with signed integer coordinates.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Scans the active VM frame bytes and formats them as hexadecimal.

Walks a local instruction pointer while formatting diagnostics into a shared buffer.

GetMapSize pushes the two 32-bit bound differences plus one from the pointer stored at [field].

Routes a managed filename to a map worker and conditionally reports a nonzero return.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Returns the resolved named class dword at [field], or -1 when lookup returns null.

Converts a race ID to its canonical name and returns it as a CKS string.

Maps race indices zero through seven to one-character strings and returns an empty string otherwise.

Maps race indices zero through seven to lowercase single-character strings and returns an empty string otherwise.

Clears the selection when the supplied player is the current player.

cmdparam returns a global command parameter or a fallback active-order string.

Returns the current selection's command-waiting string or an empty fallback.

Concatenates two selected strings and pushes an owned managed string result.

Builds command rollover text from an order description, resource costs, and current affordability.

Builds object rollover text from order costs, class statistics, and optional affordability detail.

Composes rollover text from an order description, a localized supplied key, and a secondary description.

Composes localized rollover text and conditionally appends the secondary order description.

Returns the cached gold cost or obtains it from the current script command context.

Returns the current food command cost from the cache or active order.

Returns the cached population cost or obtains it from the current script command context.

Returns the cached stamina cost or obtains it from the current script command context.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Returns the active player's selected objects as an ObjList.

Increments a shared 32-bit value. The implementation reports status zero.

Creates an object of the named class at a map position for the specified player, when placement is possible.

Validates the player and routes a compatible created unit to forced entry in the named holder.

Clamps a supplied point to map margins and routes placement with an optional script handle.

Routes class creation and placement across a signed grid, aborting on factory or template failure.

Prepares a named group and routes compatible grid objects to its insertion virtual.

Allocates and populates a command-shaped object before game submission.

Looks up a named group query and conditionally constructs and registers a replacement before returning its managed Query value.

⚠ Only partly documented so far.

Looks up a named group and returns its list count or zero.

Looks up a named group, processes its live unit members through the world-spawn helper, and returns its resulting ObjList.

Resolves a named group and named holder, forces eligible group units into that holder, and returns the processed-unit ObjList.

Resolves a named group and an Obj receiver's virtual holder, forces eligible group units into it, and returns the processed-unit ObjList.

Looks up a named query and routes its current member through spawn and handle allocation.

Resolves a named group and dispatches one of three level deltas according to the game difficulty value.

Creates or reuses a composite Query node of operation code zero for two Query operands.

Builds a composite Query from two resolved handles using selector 1 and returns its handle.

Behavior awaiting documentation.

Creates or reuses a composite Query node of operation code two for two Query operands.

Behavior awaiting documentation.

Validates a player and class name, then returns a cached or newly built player-class Query.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Validates a player and class string, requests a mode-two cached query and returns its managed Query value.

⚠ Only partly documented so far.

Constructs a class-filtered Query for a specified player.

Behavior awaiting documentation.

Returns a query with the objects inside the map area named by its first argument. Works with both rectangular and circular areas.

A rectangle or circle map query is used depending on the area's shape. The meaning of the second string and the exact query filter are not documented here.

Builds a query from an inclusive rectangle and a resolved script-class filter.

Returns a class-filtered spatial query centered on a point with a supplied radius.

Builds a class-filtered query of objects visible to a resolved object.

Builds a visibility-mode class-filtered Query around a resolved Obj.

Validates an Obj and class name, then returns a cached or newly built object-range Query.

Builds a class-filtered query of units attached to a resolved hero.

Pushes a singleton query handle with its owned VM footer.

Behavior awaiting documentation.

Divides an unsigned experience amount across query members and adds the remainder to the first registry-live recipient.

Routes Query and area name to the shared dispatcher with the advance literal.

Routes Query and area name to the shared dispatcher with the move literal.

Behavior awaiting documentation.

Behavior awaiting documentation.

Returns a NamedObj reference for a named query, creating that query if it does not exist yet.

Builds a wrapped bounding rectangle and returns the spatial callback accumulator as a boolean.

Implements this function, testing the Building research-active interval flag.

Routes four script integers through class selection and catapult creation.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

max_train_1_level pushes the dword stored at [field].

Stores the supplied 32-bit value in a field of the selected player record.

GetExperienceModifier returns the selected player record dword at [field].

Builds an ObjList of units for a one-based player number.

Builds an ObjList of a player's units using a resolved script class filter.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

ExpFromLevel replaces the input dword with the global dword at [field].

Converts an experience dword using an inline signed threshold scan and returns the resulting level dword.

Passes a class string and decremented player index to a hero selector and returns a new script string.

Consumes a skill-name string and returns the index found by a case-sensitive descriptor-name scan.

Returns an owned script string from the 25-entry display-name table or an empty-string fallback.

Allocates an editor object and dispatches construction with the data/subai literal.

Consumes a managed directory string and dispatches the editor constructor.

Shared no-argument handler for two CKS registrations that allocates and constructs a dialog using the literal EditorIni/ string.

Consumes a CKS string and passes its character data to the dialog constructor.

Shared no-argument handler for two CKS registrations that allocates and constructs a dialog using the literal EditorIni/ string.

Retains a native dialog pointer until its result text becomes available.

Dispatches enumeration on the known class-template registry and returns a managed copy.

Enumerates a VFS path and returns matching entry names joined by newlines.

Filters VFS enumeration names by an ASCII case-insensitive suffix and joins matches with newlines.

Appends the string member of each terrain record followed by a newline.

Branches on the minimap holder and either constructs its supporting message/UI objects or invokes close/destruction slots.

Consumes a script rectangle, narrows its coordinates to words, shifts/clamps it against native bounds, and updates an existing minimap.

Consumes a managed script string and forwards a temporary native string to the minimap builder.

Invokes a virtual operation on the shared zoom-map interface.

Invokes a virtual operation on the shared zoom-map interface.

Invokes a virtual operation on the shared zoom-map interface.

CKS primitive bound to "_ZoomMapLastShownTime", querying the game tick when the tactical map was last opened.

Behavior awaiting documentation.

Behavior awaiting documentation.

Returns the first settlement whose name matches the supplied text.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Adapts a CKS string through the engine conversion helpers and returns a managed result string.

Behavior awaiting documentation.

CKS native primitive that starts and presents a conversation directly by name.

⚠ Only partly documented so far.

Concatenates string keys from two native tree containers into a managed result.

Pops value and key managed strings and delegates their payloads to the environment writer.

Behavior awaiting documentation.

Consumes a managed key string, calls the environment string reader and pushes a managed string result.

Pops a managed key string and pushes the 32-bit result of the environment integer helper.

Encodes a resolved object identifier as decimal marker text and delegates it with the key.

Delegates key lookup and writes an eight-byte result with initialized low16 identifier and zero offset.

CKS native primitive that writes a string value under a key into a settlement's Env key-value store.

Formats a settlement-scoped environment path and writes a decimal integer value.

Builds a settlement-scoped environment path and returns the string obtained from the environment lookup helper.

EnvReadInt builds a settlement property path and reads its integer value.

Behavior awaiting documentation.

Behavior awaiting documentation.

Requests a string write under an environment key scoped to the specified building and its settlement. Arguments are the building, the key and the string.

If the building cannot be resolved, this overload skips the write. The key path includes the game environment, settlement and building. Available dynamic verification covers one specific call; it establishes neither cross-game persistence nor duplicate-key rules. Those storage properties remain unresolved.

Formats a building-scoped environment path and delegates an integer value as decimal text to the environment writer.

Formats a building-scoped environment path and returns a managed string from its reader helper.

Formats a building-scoped environment path and returns the integer produced by its reader helper.

Formats a building-scoped key and encodes an object identifier for the environment writer.

Formats a building-scoped key and writes an Obj result with initialized low16 identifier and zero offset.

Writes a string under a key in the specified player's environment. Arguments are, in order, the player number, the key, and the string to write.

This overload scopes the key to the specified player. Scripts use it, for example, to record research states. Retention of this data across games and complete player-number validation are not documented.

Formats a player-scoped environment path and writes a decimal integer value.

Builds a player-scoped environment path and returns the string obtained from the environment lookup helper.

Formats a player-scoped environment path and returns the integer reader result.

Formats a player-scoped key and encodes an object identifier for the environment writer.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Consumes a filename and dispatches the serializer-produced buffer to a VFS stream.

Behavior awaiting documentation.

Parses command-definition triples and dispatches settlement property writes.

Gates on research command type and dispatches player property writes from command triples.

Validates a named sequence and starts the matching sequence when validation succeeds.

Prints a status line for every registered script sequence.

IsRunning tests exact provider text Running.

IsWaiting tests exact provider text Waiting.

IsFinished tests exact provider text Finished.

Converts the native viewport midpoint to a world point and pushes it on the CKS VM stack.

Pops a world point and lock boolean from the CKS VM stack and forwards them to the native camera-centering helper.

PlayMusic dispatches a guarded named sound request.

plays a global 2D non-spatial sound effect via the sound manager.

PlaySound player overload gates its request on the local player index.

MusicPlaying tests the low16 result of a virtual manager query.

SetSpeed prepares and submits a command when game field230 is zero.

GetSpeed reads game field1244 with a null fallback.

TogglePause alternates submitted values between one and saved speed.

_Run returns true only after both compile and map scheduling helpers return zero.

Adapts the verified global Run overload with 0 integer arguments to named script compilation and dispatch.

Adapts the verified global Run overload with 1 integer arguments to named script compilation and dispatch.

Adapts the verified global Run overload with 2 integer arguments to named script compilation and dispatch.

Adapts the verified global Run overload with 3 integer arguments to named script compilation and dispatch.

Adapts the verified global Run overload with 4 integer arguments to named script compilation and dispatch.

Adapts the verified global Run overload with 5 integer arguments to named script compilation and dispatch.

Adapts the verified global IRun overload with 0 integer arguments to named script compilation and dispatch.

Adapts the verified global IRun overload with 1 integer arguments to named script compilation and dispatch.

Adapts the verified global IRun overload with 2 integer arguments to named script compilation and dispatch.

Adapts the verified global IRun overload with 3 integer arguments to named script compilation and dispatch.

Adapts the verified global IRun overload with 4 integer arguments to named script compilation and dispatch.

Adapts the verified global IRun overload with 5 integer arguments to named script compilation and dispatch.

ToggleFPS writes the zero test of global [field].

Looks up and returns an integer gameplay configuration constant from the global constants table by name string.

Looks up a key under GamePlay and returns the resulting string or an empty fallback.

rand passes a zero-based bound to the game RNG virtual method.

Dispatches input-block flags and refreshes then destroys the control-group HUD holder.

Dispatches input-unblock flags and ensures the control-group HUD exists.

Validates a player index and delegates a center and radius to a map exploration helper.

Gates a named-area reveal call by a signed player index.

Copies the game object's container at [field] into a new ObjList wrapper.

GetTime takes no arguments and pushes the 32-bit game clock counter at [shared state][field], the same field that CKS Clock divides by 1000 to obtain seconds.

Converts a one-based player input to a zero-based index and delegates its address with the lose flag to the game virtual method.

IsMultiplayer tests whether the session byte contains any set bit.

SelAvgLevel averages eligible primary-selection values.

Computes a rounded average of the food-related field across eligible selected units and nested members.

SelAvgStamina averages eligible direct and nested values.

Computes a rounded average of armor across eligible selected units and nested members.

SelAvgDamage computes an unsigned rounded selection average.

Adds together current health values for the selection, including nested objects.

Adds together maximum health values for the selection, including nested objects.

LockView sets global [field], the flag read by IsViewLocked and shared with camera-follow activation.

UnlockView clears global [field].

IsViewLocked returns whether global [field] is nonzero.

StartViewFollow resolves the target unit and activates camera tracking by setting [shared state] at [field] to 1 and storing the unit ID at [field].

Writes zero to a shared 32-bit value and the all-bits-set sentinel to a shared 16-bit value.

Resolves a managed NamedObj packet to a live unit and conditionally installs view-follow state.

SetDifficulty admits exactly zero one and two.

GetDifficulty copies the dword at pointer field [field].

Returns the map bounds as a rectangle, in left, top, right, bottom order.

MapName selects inline or pointed storage at game[field] and pushes an eight-byte managed string.

Changes to the map whose map.xml name matches the first string. If several maps share a name, the first folder in string order is used.

The first string is the map name, not the folder number. If no map has that name, "ChangeMap: No map is named …" is logged and nothing changes. The second string is not documented here.

SetNextSeason stores codes3,2,1 only for complete winter,autumn,spring matches.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Calculates and returns the average composite score across all players on a specified team.

Scales a wrapped integer point difference using signed division by an integer helper return.

Returns an inverse map bitmap bit after signed bounds checks.

Tests a point and its eight surrounding offsets through a map passability bitmap helper.

Passes an inverted script boolean to a UI control helper and stores the original byte at Game[field].

Forwards a point and decremented player value to the exploration receiver.

SelectionGold sums selected wagon subtype-zero amounts.

SelectionFood sums selected wagon subtype-one amounts.

NoTents negates an object predicate over the map vector.

RandomOffset calls virtual slot [field] twice on Game[field] with the pair (-r,r), then writes (second,first).

Constructs a point from radial and angular samples and clamps it to map bounds.

PlayMovie returns the saved movie helper result as a bool.

Translate resolves a string through primary and fallback translation tables.

Selects a translation table and formats one string value against a key.

Translatef chooses a translation table and formats a key with two strings.

Resolves a translation key and formats it with three string arguments.

SaveAdventure builds profile[field] slash payload dot-adv and forwards it on the initial phase.

WasSelectionAssigned group overload tests the stored assignment mask.

WasSelectionAssigned player overload tests any stored assignment bit.

Validates player and selection indices and reports whether the selected selection contains any units.

IsSelectionAssigned player overload scans ten live counts.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

Crash attempts an absolute zero-address dword write before its normal status-zero tail.

Returns area coordinates selected by its geometry mode field.

Clears a resolved area state field before a conditional thread request.

Dispatches a successfully resolved area to an enable helper.

Returns a helper point or a fixed pair when area lookup fails.

Computes a nonnegative area distance value after name resolution.

Spawns an AdvArea and forwards rectangle, name and string setup.

Spawns and configures a circular adventure area from script arguments.

Shows the player the map objective whose id matches the text, as defined in the map's Notes.xml.

In play it shows a notice with an icon and the objective title. An unknown id shows nothing. The objectives window and the minimap marker were not checked.

Converts the script name to a native string and dispatches to the note-manager removal helper.

Dispatches a zero argument to the notes-dialog helper and returns normally.

Dispatches note-tree erasure and resets its header links and logical count to the empty state.

Returns whether the input name has an exact case-sensitive key in the note-manager tree.

Resolves a Unit and a feedback class name, looks up its class template, and spawns the feedback visual/audio effect.

Resolves a unit and named class and dispatches feedback construction with the supplied duration integer.

Constructs named feedback at a supplied point and initializes its scheduling field from the current game field.

Constructs named feedback at a supplied point and initializes its scheduling field with the integer offset.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Evaluates whether player 1 has a ceasefire with player 2 by querying bit 0 of the player's diplomacy record.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Evaluates whether player 1 has granted shared control to player 2 by querying bit 5 of the player's diplomacy record.

inspects diplomacy mask bit 2 to determine if two players share support.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Evaluates whether a given map coordinate corresponds to a water terrain tile by querying the global map terrain grid.

Deducts a script-supplied amount from a registry object's dword and invokes its virtual slot zero when nonpositive.

Returns a field from the active item's script context or zero when context resolution fails.

Returns the item reference stored by the current item script while its registry entry remains nonnull.

Clamps a world point to map bounds and samples terrain height there.

Scales an input point vector to a requested integer magnitude.

GetAngleByDir forms a wrapped unsigned squared length and applies a finite-path asin/quadrant pipeline before low-dword integer conversion.

Handler for this function, point GetDirByAngle(int): returns cosine and sine of a degree angle scaled by 100.

Implements this function, returning the global map maximum X bound.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

NumSquads returns a per-player squad pointer-span length divided by four for input IDs 1 through 16 and zero otherwise.

Handler for this function, Squad GetSquad(int, int): packs player and index into a 4-byte Squad value.

Returns the number of GAIKA records in the shared AI record range.

Leaves the four-byte argument slot unchanged so that its value becomes the GAIKA result.

Resolves an Obj handle and pushes the zero-extended low word returned by its object-position GAIKA helper.

Obtains the GAIKA value associated with the point's coordinates in the AI map. Returns zero if that AI map is unavailable.

The result is obtained from an unsigned 16-bit value. Zero is a default return value in the case described, but it has not been established as a universally invalid GAIKA. Map topology and complete behavior for coordinates outside its bounds are not documented here.

Resolves two integer coordinates through the global AI map and returns a zero-extended 16-bit GAIKA value.

Returns the first 16-bit value of the selected AI entry after checked player and index lookup, or zero on failure.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Applies priority 100 or -1 to player AI records whose points lie inside a named area.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Validates three distinct GAIKA identifiers and delegates a relation update to the global AI context.

DumpMAIKA filters and visits six-byte route records.

SettlementCount counts class-matching settlements below a strict unsigned metric threshold.

Scans settlement slots and returns the last randomly accepted matching ruins handle.

Selects a prioritized nearby training target and queues approach and engagement commands.

Starts a named AI script task in the current player context and returns its task identifier or -1.

Starts a typed AI script task in the current script player's AI context and returns its task identifier.

Attempts to start an AI script task for the supplied one-based player and returns its task identifier or -1.

Checks the current script player's AI context and delegates the input script ID to an AI break helper.

Routes an interruption request for the identified script to the specified player's AI system. Arguments are the player number followed by the script ID.

The request is routed when the corresponding AI context exists. Immediate interruption and effects on pending scripts or tasks are not documented. The player-number check does not cover every invalid value; use valid player numbers.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

IsAIShow physically pushes one equality byte.

Uses a persistent blocking frame to interpolate a projected viewport center and schedule retries.

Returns the point fields of a record selected by the low 16 bits of the input.

Averages resolved squad-member coordinates using unsigned division by the stored total count.

SetToIdx reads the resolved Settlement slot-index field.

IdxToSet returns the handle ID from an indexed global-map settlement pointer, or a null handle for an invalid or empty slot.

Handler for this function, int MaxSetIdx(): returns the number of settlement slots.

Resolves the Unit operand and dispatches the resulting pointer to a native AI hook.

Returns the current script AI player index plus one.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Returns viewport midpoint coordinates divided by128 while discarding the terrain-conversion output.

CKS scripting primitive wrapper exposing Squadize(ObjList ol, SquadList *sl, int nState) to scenario and AI scripts.

CKS scripting primitive evaluating whether a technology or upgrade has been researched, supporting both settlement-anchored and player-direct overloads.

CKS scripting primitive evaluating whether a technology or upgrade has been researched, supporting both settlement-anchored and player-direct overloads.

CKS scripting primitive reporting whether a technology or upgrade is currently in the "researching" state, with a settlement-anchored overload and a player-direct overload.

CKS scripting primitive reporting whether a technology or upgrade is currently in the "researching" state, with a settlement-anchored overload and a player-direct overload.

Looks up a named command and writes its gold and food cost fields to output references.

Resolves the order descriptor for a command name string and returns its required stamina cost from offset [field].

Counts eligible military units for a one-based player through the squad collection helper.

Computes a signed ratio from the second and third outputs of the player collection helper.

Returns a masked collection sum of squad dwords at [field].

Sums the unit helper across player slots whose relation result is not four.

Sums squad evaluation dwords across player slots whose relation result is not four.

Sums the unit helper across player slots whose relation result equals four.

Sums squad evaluation dwords across player slots whose relation result equals four.

EnemyPlayersEval initializes and conditionally writes three outputs.

Strongholds counts same-owner settlements with BaseTownhall central buildings.

AllyStrongholds counts BaseTownhall settlements with numeric relation different from four.

Counts hostile town halls for a requested player while excluding owner id fourteen.

Villages counts same-owner settlements with BaseVillage central buildings.

AllyVillages counts BaseVillage settlements with numeric relation different from four.

EnemyVillages counts BaseVillage settlements with relation four and owner different from fourteen.

Counts live Outpost-class map objects, optionally filtered by player.

AllyOutposts counts Outpost settlements with numeric relation different from four.

EnemyOutposts counts Outpost settlements with relation four and owner different from fourteen.

Count looks up a class count in a player's indexed collection.

AllyCount sums class counts for relation codes other than four.

EnemyCount sums class counts for relation code four.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Checks whether there is a path between two search areas (LSA) for a player. Returns 1 when both LSAs are the same and 0 when they are of different types.

The third argument is the player number counted from 1. The result for two different LSAs of the same type has not been observed.

Reads a 32-bit value from the AI table using the LSA and player indices. The value meaning is not documented.

Returns the relation-four sum of the selected AI row's sixteen dword cells.

Returns the relation-two sum of the selected AI row's sixteen dword cells.

Reads a 32-bit value from the AI table using the LSA and player indices. The value meaning is not documented.

ClrShipNeeds writes zero to the global-AI ship-needs cell selected by lsa and player indices.

IncShipNeeds increments the global-AI ship-needs cell selected by lsa and player indices.

Handler for this function, bool IsWaterLsa(int lsa): tests whether an lsa region is water-majority.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Validates a player, AI profile, and difficulty before replacing that player's AI controller.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Scores eligible friendly hospital strongholds for a squad and returns the best GAIKA index.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

NearestStronghold point overload selects the unfiltered BaseTownhall search.

NearestSet four-argument overload forwards the class, decremented player and supplied relation mask.

NearestSet three-argument overload forwards the class, decremented player and fixed mask one.

NearestSet point overload searches the Building central-building class without player filtering.

Builds an ObjList of map settlements selected by owner and central-building class.

PrepareAiTransportShip conditionally builds an eight-byte handle result.

CheckLP calls the graph helper with fixed node indices 3 and 1, mode 1, an empty string and two minus-one values, then discards its result.

⚠ Only partly documented so far.

SendSquadToLsaX retains a selected-unit pointer as a sixth order operand.

Prints widened signed mouse coordinates after calling a terrain conversion whose output is unused.

Maps a class-name string to its zero-based entry in a race-specific six-name recruitable-unit table.

Looks up a managed unit-type string by type and race indices.

Selects a string from a race-indexed technology table and returns it as a managed CKS string.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Handler for this function, bool UEnabled(int mask, int bit): tests one bit of a mask.

CheckUEnabled updates an output bit mask from a unit-class count and threshold.

Finds the shortest usable teleport connection between source and destination regions for a player.

Resolves three referenced output integers, delegates a spatial query, and writes its three results.

Adds up the evaluation of the live units in the group named by the text. Returns 0 if the group does not exist, without creating it.

Only objects still on the map count. The meaning of the evaluation value is not documented here.

IsProtected clamps coordinates and normalizes a local query flag.

Compares a player's sampled unit-level average with a threshold derived from allied players' sampled armies.

Tries indexed AI candidates and dispatches a settlement fallback into the resolved integer-array destination.

Looks up a class by name and returns its class health value. Returns 0 when no class has that name.

The name is spelled "Healt". A result of 0 tells that a class is not loaded; for example, a script can check that a hero class exists before changing maps. It is not a general class-lookup API, and the full health computation is not documented.

Resolves a unit class name through the command order registry and returns the training gold cost at [field].

IsAIPlayer returns true for player ids 1 through 16 whose selected player record has a non-null AI pointer, otherwise false.

The handler traverses the supplied ObjList.

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

SelSquad without arguments submits the primary objects squad members.

SelSquad player-index overload submits resolved squad members.

SelSquadLeader submits the resolved first squad member.

The implementation performs no additional work and reports zero internally. This void signature exposes no return value to the script.

PrGAIKAStrat formats the named strategy query result.

ViewGAIKA queries the converted viewport midpoint.

vg requests camera centering and diagnostics for a narrowed GAIKA.

SS_STR allocates a string for a signed state selector.

GS_STR allocates a string for a signed strategy selector.

AIV integer overload passes a decremented player and empty prefix.

AIV string overload unlinks and releases its prefix operand.

DbgAI formats an AI profile under an upper-only player gate.

DbgArmy queries fifty class names and prints nonzero results.

Emits priority notifications for a bounded prefix of the local player's AI records.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

AIVar returns the selected player AI variable when its player, index, record and table checks pass, otherwise zero.

Three-argument AIVar returns whether a selected bit is set in an indexed AI variable word after guarded player and variable lookup.

SetAIVar updates the selected player AI variable when its player, index, record and table checks pass, discarding the write otherwise.

SetAIVar sets or clears bit (bit argument modulo 32) in an indexed dword reached through the selected player record.

Native adapter for this function resolving a player script and dispatching 0 integer arguments.

Native adapter for this function resolving a player script and dispatching 1 integer arguments.

Native adapter for this function resolving a player script and dispatching 2 integer arguments.

Native adapter for this function resolving a player script and dispatching 3 integer arguments.

Native adapter for this function resolving a player script and dispatching 4 integer arguments.

Native adapter for this function resolving a player script and dispatching 5 integer arguments.

Native adapter for this function resolving a player script and dispatching 0 integer arguments.

Native adapter for this function resolving a player script and dispatching 1 integer arguments.

Native adapter for this function resolving a player script and dispatching 2 integer arguments.

Native adapter for this function resolving a player script and dispatching 3 integer arguments.

Native adapter for this function resolving a player script and dispatching 4 integer arguments.

Native adapter for this function resolving a player script and dispatching 5 integer arguments.

Retries opening a filename and dispatches content through stream virtual methods.

Displays the supplied text in the in-game message log and chat window.

Displays an integer as a decimal number in the game's chat.

Displays true or false in the game's chat.

Invokes a clearing operation on a field of the game state.

Dispatches game vtable slot [field] and returns normal interpreter status if the call returns.

Requests the editor test transition through a helper that writes one to its flag.

Sets one global dword and dispatches two UI virtual operations.

Routes class creation, template validation and player-zero placement from console arguments.

Invalidation toggle primitives normalize their dword globals by a zero test.

Invalidation toggle primitives normalize their dword globals by a zero test.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

ProfileStart forwards the profiling start request.

ProfileStop forwards the profiling stop request.

The implementation performs no additional work and reports zero internally. This void signature exposes no return value to the script.

ShrinkEntities invokes one worker and returns status zero.

ReloadConstIni delegates two operations with the constant filename.

Calls [field] and returns native status zero without accessing the VM cursor.

Calls [field] and returns native status zero without accessing the VM cursor.

PrintMemStats formats current and saved counters.

DumpObj preserves a five-byte modal packet while returning one.

Rewrites packed terrain cells across the map through a fixed sixteen-entry conversion table.

CheckClasses dispatches the class registry and diagnostic callback.

Clears one packed map bit per sixteen-unit interior coordinate and returns native status zero.

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Behavior awaiting documentation.

Constructs a twelve-byte fog command and sends it through the game command entry.

Normalizes one VM boolean into a sixteen-byte command payload.

Forwards the map subobject at [field] to one engine call.

Behavior awaiting documentation.

Invokes virtual slot [field] on the global view receiver.

Behavior awaiting documentation.

ActivateScreenShots preserves a nine-byte retry packet until stop.

ToggleScreenShots requests stop or compiles an activation call.

DebugSelected formats selection and script diagnostics.

The no-argument Save and Load adapters construct test.svg and route it to distinct helpers.

Selects a filename and routes a temporary map context to the object export worker.

Selects a filename and routes a temporary map context to the terrain save wrapper.

The no-argument Save and Load adapters construct test.svg and route it to distinct helpers.

Named Save and Load prefix Scenarios/ under a nonzero global or append.svg when no dot is present.

Named Save and Load prefix Scenarios/ under a nonzero global or append.svg when no dot is present.

ChMap consumes its script string and forwards its unchanged payload to [field].

Prints the signed word pair from the input-interface position query.

Allocates a conversation object and passes the fixed test name to its setup worker.

Selects one of two receiver calls and normalizes the selector to its zero test.

Attempts independent argument-sized square grids for players zero and one, then centers a terrain-adjusted point.

Routes a calculated packed-grid extent to zero fill and then processes the viewport refresh path.

Selects complementary mask2 argument triples for the control style helper.

Constructs a menu object and routes a managed name plus fixed layout arguments to virtual calls.

DumpStats resolves an Obj and formats its unit statistics.

Returns an ObjList refreshed from the selection source selected by global state.

Selects a candidate, checks that it supports the script-object interface and returns its encoded object reference.

Returns the currently selected unit handle, or the null handle when the selected object is not a unit.

Selects a candidate with a particular flag and returns its encoded hero reference.

Selects a candidate with a particular flag and returns its encoded building reference.

Returns the settlement associated with the currently selected settlement object, or the null handle.

Selects a candidate with a particular flag and returns its squad selector extended with zero bits.

Routes a selected candidate through direct GAIKA helpers or coordinate fallback and pushes a narrowed selector.

Desync passes a diagnostic file object through two virtual calls.

Consumes one boolean byte and selects two helper sequences around active-pathfinder virtual slot [field].

Inserts a callback into a global list and refreshes the current render-target rectangle.

Behavior awaiting documentation.

Invokes the map passability-mask rebuild routine for the current map bounds.

executes a modal introductory splash video/image sequence from INI configuration.

Behavior awaiting documentation.

Zeroes the global packed height surface, rebuilds the derived slope surface, and processes the pending viewport rectangle.

Pause calls game virtual slot54 with one.

TestLoad calls [field] and returns status zero without a VM packet operation.

Sequentially executes explorer dialog state serialization followed by dialog list cleanup and heap deallocation.

sd delegates without a semantic incoming-register argument.

Dispatches the two UI virtual operations also used after the _Black global store.

Writes an unmasked shifted decor value into the selected packed-grid word and dispatches a callback.

Clears the selected 16-bit halfword of a packed-grid dword and dispatches a callback.

Dispatches a full-extent light worker with fixed constants before printing its completion label.

Forwards three VM integers and the full terrain rectangle to one worker.

Gates on signed X and forwards all four VM integers to a six-argument worker.