CKS reference

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.

Returns the horizontal coordinate of the point.

The two shared component adapters retain an eight-byte encoded reference pair, with a zero or four-byte adjustment to its second dword.

Returns the horizontal coordinate of the point.

Returns the vertical coordinate of the point.

Sets the horizontal and vertical coordinates and returns the updated point.

Rescales the point's integer coordinates toward the requested vector length, modifying the point in place. Integer arithmetic and truncation can make the resulting length differ from the requested value.

The argument is the requested length. On the documented calculation path, each coordinate is multiplied by that value and divided with truncation toward zero. Products use 32-bit arithmetic. Behavior with a zero computed divisor, invalid references, or values that cause overflow is not fully documented.

Returns the integer square root of the sum of the squared coordinates.

Rotates a referenced integer point through an integer angle using sine and cosine.

Checks whether the point lies inside the rectangle, including its boundaries.

Limits the point's coordinates to the rectangle's boundaries.

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

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.

Returns the first dword of a rect value.

Returns the second dword of a rect value.

Returns the third dword of a rect value.

Returns the fourth dword of a rect value.

Returns the inclusive width: right minus left plus one.

Returns the height of the rectangle, including its boundaries.

Returns an eight-byte reference pair unchanged for point x and rect left.

Preserves the first dword of an encoded reference pair and adds four to its second dword for point y and rect top.

Advances a rect reference address by eight bytes.

Advances a rect reference address by twelve bytes.

rect::Set pops four integer coordinates and a rect reference pair, writing them into memory in standard left, top, right, bottom offset order.

Returns the integer center point of the rectangle.

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.

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

IntArray size returns -1 for a null begin pointer and otherwise returns the four-byte slot span minus one.

Behavior awaiting documentation.

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

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

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

StrArray size returns native span count minus one.

Behavior awaiting documentation.

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

Behavior awaiting documentation.

Behavior awaiting documentation.

StrMap size returns native count field.

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.

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.

Clears the Obj reference held by the variable on which it is called, leaving it without an associated object.

Modifies the reference stored in that variable. The reviewed operation writes a null reference; it does not issue an order to remove the object from the map. Behavior with an invalid reference container has not been checked dynamically.

Returns a Unit reference when the object has a compatible unit category.

Returns a Building reference when the object has a compatible building category.

Returns a Hero reference when the object has the hero category; otherwise returns a null reference.

Resolves the object reference and attempts a dynamic conversion to Druid. Returns a Druid reference on a match or a null reference otherwise.

Narrows an Obj reference to the Ghost interface and returns its registered reference.

returns a narrowed handle only when the resolved object carries category bit [field].

Casts an Obj reference to the Wagon interface and returns a Wagon reference.

Attempts a dynamic conversion of an Obj reference to Catapult and returns a Catapult reference on success.

Resolves an Obj and queries its ItemHolder interface to build an ItemHolder handle.

Narrows an Obj reference to the Barrack interface and returns its registered reference.

Resolves an Obj and queries its Sacrifice interface to build a Sacrifice handle.

Casts an Obj reference to the Ship interface and returns a Ship reference.

Behavior awaiting documentation.

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

Obj::race returns the dword at [field] of the resolved object's template and returns zero for an invalid object.

Returns the canonical race key for the resolved object template race, or an empty string for invalid resolution.

Returns the one-character prefix associated with the object's civilization.

Returns the civilization prefix in lowercase, or an empty string for an invalid value.

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.

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Returns the object's current health, or zero for an invalid object.

Obj::stamina returns the resolved object's four-byte field at [field] or zero for an invalid handle.

Returns the object's maximum health, or zero for an invalid object.

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::sight returns the 32-bit value at resolved object [field] and returns zero for an invalid object.

Returns the object's position as a point. An invalid object returns zero coordinates.

Resolves an Obj handle and returns an eight-byte point from virtual slot [field].

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Shared native accessor that returns object dword [field] for both damage and attack script members.

Obj::damage_type resolves an Obj, follows its pointer at [field], and returns the dword at [field], with integer 3 as the invalid-object fallback.

Obj::range returns a resolved object's dword at [field] and returns zero for an invalid Obj handle.

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::radius returns the dword at [field] of the resolved object's template and returns zero for an invalid object.

Behavior awaiting documentation.

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

Obj::IsHeirOf delegates class ancestry testing for a resolved Obj.

Checks whether the object belongs to the Sentry class or a derived class.

Checks whether the object belongs to the Gate class or a derived class.

Tests whether the resolved object class inherits from the cached RamUnit descriptor.

Resolves an Obj handle and returns a sentinel-based property test.

Checks whether the object belongs to the Military class or a derived class.

Tests whether the resolved object class inherits from the cached BaseMage descriptor.

Checks whether the object belongs to the Peaceful or Animal class.

Checks whether the object belongs to the Peasant class or a derived class.

Tests whether the resolved object class inherits from the cached PeasantAmbient descriptor.

Resolves an Obj and forwards an integer to virtual slot [field].

SetMaxHealth and SetMaxStamina directly write their integer arguments at object [field] and [field].

Resolves an Obj handle and delegates an integer stamina value through virtual slot [field].

SetMaxHealth and SetMaxStamina directly write their integer arguments at object [field] and [field].

Behavior awaiting documentation.

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

GetStaminaDecTime returns max(signed object [field], zero) after an unguarded field dereference.

Returns the number of commands in the object's queue. Returns zero if the reference cannot be resolved or the object is considered destroyed.

This overload reads the command count without filtering by name. CmdCount(str) is a distinct overload. Zero can also come from an invalid reference or a destroyed object, so it is not sufficient by itself to test object validity. How every special command, such as idle, contributes to the count is not established here.

Counts queued commands with the specified name.

Clears commands on an eligible resolved object outside the guarded global mode.

Cancels or updates a valid object's command state when the local gates allow it.

creates and enqueues a named command on a target object.

Adds a named command with a point as its target.

Adds a named command with an object as its target.

Creates a named command under local guards, submits two candidates and updates command state.

Creates and submits a named command for the object, without an additional target.

Creates and submits a named command for the object with a point as its target.

Creates and submits a named command for the object with another object as its target.

Builds a one-receiver packet for default-command dispatch with point, target identifier and normalized flags.

Validates an object and named command, then dispatches it with script arguments.

Resolves the supplied command name through registry virtual [field] and dispatches nonnegative results through object virtual [field].

Resolves the supplied command name through registry virtual [field] and dispatches nonnegative results through object virtual [field].

Checks whether the object reference resolves to an available object. This does not describe whether that object is alive.

returns true when the handle's registry base plus subobject offset is nonzero, and false when the registry slot is empty.

Obj::DistTo computes distance from an Obj to a point and subtracts its template offset.

Returns the distance between the edges of two objects. The result retains its sign; the distance unit is not specified here.

Checks whether the objects belong to enemy players. Returns false for allies or invalid objects.

Evaluates whether an object is alive by querying its virtual destruction slot at [field] and inverting the result.

Returns true when the object is dead or the reference cannot be resolved.

Resolves two object handles and tests the target with a receiver virtual predicate.

Behavior awaiting documentation.

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

Requests a visibility update for the object using the supplied boolean. Conditions that can affect visibility still need a practical explanation.

Obj::IsVisible returns the inverse of bit 21 in the resolved object's dword at [field], or false when resolution fails.

Resolves an Obj and selects one of two virtual status operations from a boolean argument.

Obj::CanSee combines a target flag with an observer-mask intersection.

Tests the receiver target-eligibility gate and radius-adjusted signed inclusive attack range.

Forwards Obj::Erase to a receiver virtual method.

Obj::player reads the resolved object's owner record index, adds one, and returns minus one for an invalid object.

Changes the object's owner. Player numbers start at one.

Applies a nonnegative damage amount through an object's virtual damage operation after an optional related-object call.

Increases health up to the object's maximum health.

HealStamina forwards a wrap32 stamina sum bounded by a signed maximum comparison to receiver virtual [field].

Behavior awaiting documentation.

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

Clamps the supplied point and invokes virtual placement with two true flags.

Selects one of two virtual operations on a mask according to the supplied boolean.

Initializes an object command context, sets its facing point and conditionally invokes its command-update virtual method.

Returns two 32-bit components from the resolved Obj. If resolution fails, returns the default vector (0, 1).

Implements a VM wait phase around an object's queued command progress.

Requests a script wait associated with an object's command progress, using the supplied duration. This overload uses the integer argument in the script wait counter and records the progress start and end times.

Training and research scripts commonly obtain the duration from cmddelay, sometimes adjusting it by a percentage. The argument's relationship to real-time units and the details of script resumption are not fully documented.

Returns the delay-related value read from an object's command queue. Returns zero if the object cannot be resolved or the link to the queried command data is missing.

Game scripts use this value as the duration passed to Progress, for example Progress(cmddelay). Its unit and the full interpretation of the value are not yet documented.

Looks up the string key and returns the normalized result of found-group virtual [field] for the resolved Obj.

Adds the object to a named group, creating the group if necessary.

Looks up the supplied string key and calls [field] with the found object and resolved Obj when lookup status is zero.

Resolves one Obj reference, visits a temporary query snapshot and invokes a member-removal helper for each snapshot node.

Passes the string payload pointer and the resolved Obj to an implementation operation.

Adds an eligible Obj to active-player selection when the supplied player matches the current player.

Calls the selection helper with mode one only when the supplied player slot matches game [field].

Removes the object from the selection.

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

Requests a script-object animation and returns the VM suspension code.

GetAnimTime decrements its integer index and reads selected descriptor entry [field], returning zero for missing descriptors.

Prepares and requests an animation with an optional target point.

Normalizes an equal-current point and forwards a decremented animation identifier with a final integer.

Wraps an object action-window query and returns the remaining time to its action moment.

Returns the positive difference between animation finish time and the object's clock.

Obj::GetAnim returns Obj [field] plus one when nonnegative and zero otherwise.

Forwards a decremented state identifier and preserves an anomalous invalid-receiver VM zero push.

Attempts to add an item with the specified name and returns whether it succeeded.

Transfers an owned item to another live object. If the destination cannot accept it, the transfer attempts to return it to the source.

⚠ Only partly documented so far.

Transfers items from a holder into an eligible object's inventory.

Moves an inventory item into the specified item holder.

Requests that a specified receiver item be dropped at a point while returning false.

Behavior awaiting documentation.

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

RemoveItem int dispatches removal after signed one-based bounds.

RemoveItem str dispatches removal after nonnegative name lookup.

RemoveAllItems repeats virtual removal until count is zero.

ExchangeItem returns true after a gated replacement dispatch.

GetItem builds a handle from the virtual lookup result.

Removes all inventory items with the specified type name and returns the number removed.

GetItemIndex increments the virtual index result.

items_count returns virtual slot [field] or zero.

free_item_slots subtracts two virtual values without clamping.

Returns the receiver item count through virtual slot [field], or zero for an invalid handle.

Returns the resolved object's item-capacity value through virtual slot [field].

Obj::ClipDestToMap ignores the object handle and clamps the point coordinates to the global map bounding rect at offset [field] of [shared state].

Formats the supplied HX string under a receiver-field gate and releases it on every normal path.

Formats the supplied integer through chat dispatch when the receiver field matches the global gate.

Formats the unresolved payload handle pair when the receiver field matches the global gate.

GetDebug compares resolved object dword [field] with dword[[field]].

SetDebug normalizes its byte Boolean to a dword 0/1 and forwards it through object virtual [field].

Returns a managed copy of a resolved object's class-template name.

Obj::command copies the resolved object's small-string field at [field] into a managed CKS string, or returns an empty string for an invalid handle.

Returns a queued command's name by index, starting at zero. Returns an empty string for an invalid object or index.

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 a 32-bit field of the resolved object, or the all-bits-set 32-bit sentinel if object resolution fails.

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.

IsWaterUnit returns whether the dword at object class [field] is nonzero.

SetCmdEnable writes normalized bool to object [field] only after virtual [field] returns zero.

GetCmdEnable tests object [field] only when virtual [field] returns zero.

Passes the resolved Obj to the next operation without checking for a null reference.

Passes the resolved Obj to the next operation without checking for a null reference.

Returns true when a search of the resolved receiver for a particular state entry finds no match. The meaning of that entry is not documented.

Adapts script string and object arguments to the spatial sound playback method [field] and releases the string reference.

Submits string payload with a virtual point whose second coordinate is decreased by 120.

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.

Invokes a virtual operation on query members that lack a particular object flag. The meaning of that flag is not documented.

Passes the script player value minus one to each live Query member's virtual slot [field].

Calls virtual damage slot [field] on eligible Query members and counts nonzero call results.

Adds a signed amount to eligible query members' health and clamps each result to maximum health.

Adds an integer amount to eligible Query members' stamina and caps it at each member's maximum.

Resolves Query and optional Obj, passes point, target ID or 65535 and two normalized flags to the default-command dispatch chain.

Behavior awaiting documentation.

Behavior awaiting documentation.

Returns the result container's count for a resolved Query, or zero for an invalid receiver.

Returns whether a resolved Query's virtual emptiness predicate is nonzero, with true for an invalid receiver.

Passes an Obj value to a resolved Query's membership predicate and returns its boolean result.

For each live member of a resolved Query, calls virtual [field] with zero while the global gate is zero.

For each live Query member, calls [field] with zero while the global gate is zero.

Dispatches factory mode zero for each live Query member and installs nonnull results with the normalized bool.

Dispatches factory mode one with the unchanged point pair for each live Query member and installs nonnull results.

Dispatches factory mode two with the raw Obj pair after validating its low-word registry slot, installing nonnull results on live Query members.

Transforms each live member position by requested point minus live-member average, then dispatches mode one without local clamping.

Calls virtual [field](0) before mode-zero factory dispatch and calls [field](0) after each live member attempt.

Creates and installs the requested point command on each valid object selected by a Query.

Constructs and installs an object-targeted command for each live member of a resolved Query.

Translates member positions relative to the live-member average and clamps them before factory mode-one dispatch, after virtual [field](0).

Returns a new ObjList copied from a resolved Query object's list-producing virtual method, or an empty list when resolution fails.

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.

Behavior awaiting documentation.

Behavior awaiting documentation.

Dispatches live query members to the named group collection.

Removes each live object in the query from the named group.

Behavior awaiting documentation.

Applies a face-point command to each live member of a query.

Assigns a nonnegative food value to every unit-compatible live member of a query.

Counts the query's units that are inside the named settlement.

Attempts forced holder entry for unit-compatible members of the query.

Returns the average direction of the query's objects, or a zero point for an empty or invalid query.

Dispatches unit-compatible query members to a Boolean-selected game virtual operation.

Dispatches a mask to eligible script objects through a virtual operation selected by the boolean argument.

Sets or clears a unit flag for eligible query members.

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

Behavior awaiting documentation.

Returns true for unresolved NamedObj values or an empty list returned by the query after its first virtual call.

Returns the first stored handle from a NamedObj result list after invoking virtual [field], or an invalid handle for missing or empty results.

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

Selects a target from a spatial search around a Building and returns its CKS handle.

Executes a guarded, possibly waiting Building attack that spawns an arrow shot on its firing path.

calculates the entrance point coordinates of a building relative to an approaching unit.

Resolves an exit point from a Building, an Obj template category, and an incoming point.

Resolves an exit point from a Building, an incoming point, and a boolean mode.

Behavior awaiting documentation.

Resolves a Building's own Settlement-link field into a CKS Settlement reference.

Generic CKS-exposed Building::IsBroken, true when the shared broken-status field equals 3.

Reads the template-level is_central_building flag through the object's own template pointer.

Conditionally repairs a broken Building to a health percentage above the broken threshold and refreshes its damage visuals.

Building GetExitVector returns template dwords at [field] and [field], with (-1,-1) for a sentinel first dword.

Resolves the Building, checks its class descriptor and converts an embedded interface to a town hall interface before passing it to a UI allocation operation.

Looks up the first global-spell vector entry associated with a resolved town hall and pushes its initial dword.

Starts a global-spell operation for a town hall when the first integer is in the range zero through five.

Starts a global-spell operation for a town hall with three script integers when the first is in the range zero through five.

Stops a town hall's global-spell entry by delegating to the global spell manager.

Passes a town hall and an integer to a global-spell vector updater.

Stonehenge-gated Building primitive with two-path candidate collection and capped signed level-to-XP dispatch, retaining concrete storage and override prerequisites.

⚠ Only partly documented so far.

Invokes a rectangle scan that reduces a linked object counter and qualifying wagon food.

Scans matching buildings and adds 300 divided by the script argument to linked settlement gold.

Collects eligible Druid objects for a Stonehenge town hall and invokes their divine-sacrifice operation.

Counts buildings found by the SoothingRain map scan while passing zero to its gold mutator.

Tests whether a Stonehenge-centered map scan yields a positive counter.

Returns a counter from a Stonehenge-centered map scan.

Returns the Building template string registered as Building::itemtypes.

Returns the Building template dword registered as Building::minlevel.

Returns the Building template dword registered as Building::levelperitem.

Building::ClearDamageTaken writes zero to the resolved Building's dword at [field].

Returns a count of eligible script objects in a Stonehenge-centered circle.

Building::SetUITarget writes the target object's 16-bit registry slot to Building [field], or 65535 when the target does not resolve.

Building::GetUITarget returns the handle stored at building [field] and returns a null handle when resolution fails.

Building::GetNumSentrySlots returns the sentry slot count dword at template [field] and lacks a safe fallback for invalid handles.

Building::GetSentryClassName returns the Building template string stored at [field].

Resolves a named command descriptor and invokes research with temporary command-cost context.

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

Routes four script integers through class selection and catapult creation.

Catapult::IsBuilt pops an 8-byte Catapult handle, validates it through the global unit registry, and pushes a 1-byte boolean indicating whether the 32-bit field at Catapult offset [field] is non-zero.

Behavior awaiting documentation.

Behavior awaiting documentation.

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.

Evaluates surrounding targets across the spatial index within the catapult's attack range and returns the best candidate object handle.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Behavior awaiting documentation.

Catapult GetCurrentTarget encodes the stored target word with an unassigned upper halfword and a four-byte invalid result.

Stores a target handle on a catapult and propagates it to associated CatapultTower objects.

Clears a catapult's own target and propagates tower-target clearing to associated catapult towers.

Clears the stored target on CatapultTower objects associated with a catapult.

Reads the linked speed dword for a Unit handle.

Unit[field] defaults to 100, is exposed by the speed-factor getter/setter, and divides base step duration as a percentage.

Reads the stamina dword for a Unit handle.

Reads the user dword for a Unit handle.

Reads the food dword for a Unit handle.

Reads the linked maximum food dword for a Unit handle.

Reads the linked maximum stamina dword for a Unit handle.

Scripting VM bridge reading the cumulative raw experience counter directly from unit [field].

Scripting VM bridge calling virtual method vtable[[field]]() to obtain effective unit or hero level.

Scripting VM bridge computing unit inherent level on-the-fly from raw experience via LevelFromExp.

Stores a speed factor dword on a resolved Unit.

Stores a user dword on a resolved Unit.

Stores the supplied food value on a resolved Unit and dispatches a value-dependent virtual state update.

Returns the resolved Unit's feeding flag as a byte.

Updates the resolved Unit's feeding flag from a bool argument.

Clamps the point to map bounds and coordinates a Unit path controller, movement command, wait ticks and terminal bool through native status 0, 1 or 2; its path destination call passes final flag 1.

Follows the point-route wait and completion branches while passing final flag 0 to the path destination call at [field]; the sibling Goto point handler passes 1.

Resolves an optional Obj and required Unit, clears Unit tracking at [field] when set, then delegates the movement state machine to [field]; invalid Unit pushes false.

Prepares target tracking and delegates cooperative attack routing.

Constructs a path object on the first blocking invocation or reuses its saved pointer, calls its virtual [field] with a calculated step time, and returns native status 1 while a step remains or 0 after destroying the object.

For a nonzero continuation state, clears target tracking and requests an active-path stop with wait status 1, or clears the controller and returns true. For zero state, checks a virtual path operation, returns its boolean outcome and clears a unit flag.

Returns false for an invalid Unit or when a unit state field differs from -1. Otherwise checks an implementation operation for hero units with a particular flag, or a unit field for nonhero units. The field meanings are not documented.

Returns two signed 16-bit components from path-controller virtual [field] when Unit [field] exists, otherwise from Unit virtual [field]; an invalid Unit returns (-1,-1).

Unit::TimeWithoutWalking returns zero for sentinel -1 at Unit [field], otherwise subtracting it from the dword reached through Unit [field].

Checks whether the resolved Unit records a holder reference different from the invalid-reference sentinel.

Unit::GetHolderSett derives a returned slot word through Unit [field], registry entry [field], and final entry [field].

Follows the Unit holder handle and a linked registry handle, then returns whether the latter resolves.

Follows the Unit holder object's linked registry handle and returns that object's handle or an invalid Ship handle.

CKS-exposed Unit::ExitHolder passes a position to a reserve and movement path that can detach the Unit from its Holder.

CKS-exposed Unit::EnterHolder, resolving a Building argument's Settlement Holder and force-entering it.

Returns the objects in the unit's holder as a new ObjList.

A Unit training-attack primitive that can start native attack mode 2 and return VM handler status 3.

Searches nearby candidates around a resolved Unit and returns the selected object's handle or an invalid handle.

Invokes the flag-setting operation on the resolved Unit for a particular flag.

Invokes the flag-clearing operation on the resolved Unit for a particular flag.

Unit::IsTraining extracts bit 28 from the resolved Unit object's dword at offset [field] and returns it as a boolean.

Implements a cooperative single-target attack sequence using continuation state, eligibility checks, attack dispatch, and wait status.

Implements a cooperative attack sequence with range and eligibility checks before dispatch.

Unit::TimeWithoutAttack returns the 32-bit subtraction [[shared state][field]] - [Unit[field]], with zero as the invalid-unit fallback.

Unit::SetLastAttackTime copies one 32-bit value from [shared state] offset [field] to the resolved Unit at offset [field].

Resolves a Unit, verifies it is alive, and queries the squad sight targeting search engine function, returning the best target object handle.

Calls the squad-sight target search with zero option arguments after validating the Unit.

Calls squad-sight target search with the no-independent option set.

Finds the best tactical target within squad sight matching the supplied class filter string.

Calls squad-sight target search with string data and the exclusive option set.

Calls squad-sight target search with the prefer-undiseased option set.

searches for the best combat target for a unit using its current position and sight radius.

Forwards explicit point coordinates and integer radius to the common target-search helper.

For a valid live unit, returns whether the enemy record associated with its squad contains entries.

Reads an existing record. Captures verified true results for counts of 1 and 2 and false results for a count of 0. They do not establish when the record is refreshed or justify treating this call as a fresh distance, visibility or diplomacy scan. Subsequent behavior with dead units or invalid references is not fully documented.

Builds a diplomacy-filtered spatial query around the Unit and returns whether a matching candidate was found.

Checks a resolved target against a resolved Unit using the common attack-range helper.

Returns an eight-byte Hero handle containing the resolved Unit's linked Hero slot.

Resolves Unit and Hero, rejects invalid or virtual [field] positive operands, then returns whether Unit helper [field] accepts the Hero.

After valid/dead checks, calls Unit helper [field] only when Hero [field] matches Unit [field].

With nonzero continuation, waits on the special virtual [field] coordinate pair; otherwise dispatches action 4 through [field], clears target tracking and returns native status 3. Zero continuation returns 0.

With nonzero continuation, waits on the special virtual [field] coordinate pair; otherwise dispatches action 5 through [field], clears target tracking and returns native status 3. Zero continuation returns 0.

Scripting VM bridge writing a raw experience value directly through the shared virtual experience setter.

Scripting VM bridge clamping input level, looking up experience threshold, and calling virtual experience setter.

Adds an integer to the resolved Unit's kill counter field.

After formation-state checks and possible holder waits, clears target tracking, creates a path controller when absent, passes formation field [field] to controller virtual [field], sets Unit [field] to 3, and returns status 0; ineligible state returns 2.

For nonzero continuation, clears target tracking, sets movement state 3 and a unit flag, stores wait ticks and reports status 1. For zero continuation, may clear a satisfied controller, clears the flag and reports status 0.

Prepares a point-centered path query for a Unit and returns the native pathfinder result code or a sentinel.

Prepares an object-centered path query for a Unit and returns the native pathfinder result code or a sentinel.

Dispatches a resolved Unit to one of two game virtual operations according to a boolean argument.

Returns the registered Unit GetParty boolean for this function.

Invokes a Unit virtual handle provider and returns its first word as a Sacrifice handle.

Tests a packed global-map bit at the resolved Unit's virtual position.

max_train_1_level pushes the dword stored at [field].

Returns a random unexplored point near the unit, or the point (-1, -1) when it finds none.

With argument -1 the search window is about four times a unit field (probably its sight), between 512 and 3000 map units square. It can return (-1, -1) while much of the map is still unexplored. The game uses it in the Explore order.

Combines a Unit flag test with a class helper to return a boolean.

Returns the registered Unit GetFlags boolean for this function.

Returns a value from the Unit's [field] controller virtual method, or sentinel 900000000 when unavailable.

Behavior awaiting documentation.

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

Returns the nonnegative part of a resolved Unit's signed stamina decrement time field.

Compares the holder-handle words of two resolved Units.

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

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

Sets or clears bit 19 of a resolved Unit's state flags.

Reads bit 19 of a resolved Unit's state flags as a boolean.

Sets or clears bit 20 of a resolved Unit's state flags.

Reads bit 20 of a resolved Unit's state flags as a boolean.

Selects the unit's walking animation from the supplied index. This call does not issue a movement order.

The integer overload stores the supplied index minus one in a 16-bit selector. In verified captures, SetWalkAnim(13) selected internal index 12. The no-argument overload is distinct. Safe indices for each template and subsequent behavior with out-of-range indices or invalid references are not established.

Unit[field] is the current zero-based animation index; the no-argument SetWalkAnim selects index zero and the int overload stores argument minus one.

Selects the carry-water animation for recognized ambient-villager templates. The call selects an animation; it does not collect or transfer resources.

The implementation recognizes GWVillagerAmbient, RWVillagerAmbient, MWVillagerAmbient, TWVillagerAmbient, CWVillagerAmbient, IWVillagerAmbient, BWVillagerAmbient and EWVillagerAmbient, selecting internal index 16. A nonmatching template leaves the selector unchanged. Captures verified calls that reached the selection, but did not visually test all eight templates or exercise the nonmatching branch. Invalid references require separate verification.

Maps recognized villager ambient template names to one of two carry-goods animation state values.

Tests whether a resolved Unit's carry animation selector is zero.

Clears the unit's command state. In verified calls, it also moved the unit to (-1, -1), away from its map position.

Captured units retained their health, and one visual representation became null. This does not establish death, removal of the reference or automatic restoration. Game scripts use additional operations to save the position and restore it later; that complete sequence was not verified in these captures. Subsequent effects and invalid references remain unresolved.

Clears Unit [field] bit [field] and sets it when the bool argument is nonzero.

Sets or clears the Unit minimap flag from a bool argument.

Clears a unit flag, then sets it if the boolean argument is nonzero.

When Unit [field] exists and its virtual [field] returns nonzero, returns the point from path virtual [field]; otherwise returns (-1,-1).

Unit::ForceIdle pops an 8-byte Unit handle, validates it through the global unit registry, and writes 32-bit integer 1 into unit offset [field].

Passes a resolved Unit to helper [field] and returns native status zero; invalid Unit skips the call.

Reads one Unit flag bit as a CKS bool.

Reads one Unit flag bit as a CKS bool.

Configures target filters and delegates curse-target selection to spatial or squad-aware search helpers.

Returns a Building handle containing the resolved Unit's linked Building slot.

Unit::SetBuilding writes the Building argument's 16-bit registry slot to Unit [field], or 65535 when the Building does not resolve.

Tests an indexed bit in the Unit special mask.

For index below 36, a nonzero bool ORs its shifted bit into Unit [field], while false calls [field] to clear it; invalid Unit or out-of-range index is skipped.

Builds a script string from a Unit special-name table entry or fallback.

Unit[field] bit 0 gates parry support, while Unit[field] stores the Boolean mode changed by SetParryMode and returned by GetParryMode.

Changes parry mode when the Unit capability bit allows it.

Delegates a resolved Unit to a status-effect helper with mode zero.

Delegates a resolved Unit to a status-effect helper with mode one.

Sets a Unit disease flag and creates an effect when its slot is empty.

Runs a bounded spatial candidate query and emits an Obj handle.

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.

Resolves a named class template and dispatches Unit mutation or a deferred mutation state.

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.

For nonzero continuation, refreshes formation movement, sets hero state 3 and a flag, stores the integer as VM wait ticks and reports status 1. Zero continuation clears the flag and reports status 0.

After holder-related waits, the point overload clears the Hero path controller, passes the point, two integers, and bool to formation destination change; on success it installs a new controller, enables formation move mode, and sets Hero [field] to 3.

After holder-related waits, clears the hero path controller and selects an object destination change or a point destination derived from the object, depending on an object flag. On success, installs a new controller and sets hero state 3.

Returns the current game tick value minus the Hero's stored last-attack tick, or the current value when the Hero handle is invalid.

Hero::LastAttacker copies Hero [field] into a returned object's low word and zeroes result dword 1.

Hero::army returns an ObjList wrapper pointing to the resolved Hero at [field], increments the list reference counter at [field], and uses an empty newly allocated list if receiver resolution fails.

Reads the Hero army capacity field for this function.

Compares army count and capacity for this function.

For a valid Hero, FormRadius calls [field] on Hero [field] and pushes its four-byte result; an invalid Hero yields zero.

For a valid Hero with a nonnull formation path object at Hero [field] then [field], FormPathLeft returns the result of that object’s virtual method at vtable [field]; otherwise it returns zero.

Hero::HasArmy returns whether the resolved Hero dword at offset [field] is nonzero.

SetFormation resolves the supplied string in the formation map and, when found and Hero [field] exists, passes the string text to the formation object shape-setting helper; unknown names and invalid Heroes call the error helper.

For a valid Hero, the formation getter copies the text of the shape object reached through Hero [field] and formation [field] into a VM string result; an invalid Hero returns an empty string.

Delegates Hero::DetachArmy to the army cleanup routine.

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

Delegates Hero::CancelArmyBoard to a holder and army validation routine.

Stores the transformed orientation request point for this function.

Returns the transformed stored orientation point for this function.

Tests the stored orientation request pair for this function.

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

Resolves the hero reference and delegates the skill-level update.

CKS scripting bridge returning current skill level for a given skill index.

Resolves a Hero handle and returns whether the native Hero skill dispatcher accepted the supplied skill ID.

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

CKS scripting bridge resolving hero pointer and returning unspent available skill points.

Resolves a Hero and tests whether an indexed skill-effect slot differs from the -1 sentinel.

Resolves a Hero and reads bit 2 from its flags dword at [field].

Clears or sets a flag in the resolved Hero according to the boolean argument.

Behavior awaiting documentation.

CKS-exposed AI helper that scans for an ally to apply an experience-gain effect to, sharing the same vision-range/eligibility pattern as the druid's other target-search helpers.

CKS-exposed AI helper that scans for an ally to apply an invisibility-style effect to, sharing the same vision-range/eligibility pattern as the druid's other target-search helpers.

CKS target selector that chooses the greatest positive [field] score among eligible candidates from a squad-member traversal or a radius-bounded map traversal.