Obj

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

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.

Description pending.

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.

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.

Description pending.

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].

Description pending.

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.

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.

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.

Description pending.

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].

Description pending.

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.

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.

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.

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.

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.

Description pending.

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.

Returns a 32-bit field of the resolved object, or the all-bits-set 32-bit sentinel if object resolution fails.

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.

Queries the resolved Obj for its Gate component and returns a Gate reference or an invalid-reference sentinel.

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

Obj::LSA resolves a handle and forwards the full helper result.

Calls a resolved object's virtual item-name lookup and returns whether its integer result is nonnegative.

Finds a named item on an Obj and runs its OnUse script when present.

Processes a temporary collection, accepting nonnull entries only when they carry a particular flag and their registered reference is null or matches the resolved receiver.

For a nonnull resolved Obj, MagicActionEnd forwards the word at receiver[field] to helper [field]; null resolution skips dispatch.

Consumes one reference and queries an interface derived from the receiver. If that query is nonnull, invokes the corresponding operation on the returned interface.

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.

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

Description pending.

Description pending.

Description pending.

Description pending.

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

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

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

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

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

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

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.

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

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

Description pending.

Returns the first live ObjList member matching a resolved class-template ancestry test.

Returns the first live class-matching ObjList member with the selected relation bit set.

Returns the first live class-matching ObjList member with the selected relation bit clear.

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

Description pending.

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

Description pending.

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

Returns a target object handle selected by the GAIKA target search helper for a resolved Unit.

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

Scores hostile squad leader neighborhoods by relation-count balance and a product, preferring a normal leader result over a same-player sacrifice override.

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

Description pending.

Description pending.

Description pending.

Description pending.

Description pending.

Adds a named command with an object 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.

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.

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

Description pending.

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

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

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

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

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.

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

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.

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

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

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

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

Description pending.

Description pending.

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

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

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

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

Description pending.

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

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.

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

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

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.

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

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

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.

Tests whether a list contains the low-16-bit slot of an Obj handle.

Appends an Obj's slot to the list if no matching slot is already present.

Removes the first matching Obj slot from a list.

After validating the supplied Obj handle, creates a named object-target command with selector 2 for each eligible member and submits it through virtual [field] using the Boolean.

Resolves the optional Obj handle to its object identifier at +8 and delegates the list, point, identifier, two Booleans and -1 to [field].

Looks up the supplied command string through the command-order registry virtual [field]; on success passes the resolved command and remaining arguments to [field], while the failure path reports an invalid command.

After validating the receiver and target Obj, calls virtual [field] with zero on each eligible member, creates an object-target command with selector 2, submits it through virtual [field] with false, and updates command state.

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

Description pending.

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

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

Description pending.

Forwards a target object handle to the targeted use helper after resolving the Item base.

Updates squad command state and submits an object-target command to eligible member units.

The handler pops two integers and two object handles.

Stores the final state argument before validating the target and delegates member siege planning.

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

Partitions squad members and forwards train and enter state arguments to separate regrouping calls.

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

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.

Description pending.

Stores squad state/time and submits teleport plus point commands for live members.

Description pending.

DumpStats resolves an Obj and formats its unit statistics.

Implements the registered WaitObjInQuery blocking predicate and timeout paths.

Description pending.

Description pending.

Description pending.

Description pending.

Description pending.

Shared address-taken handler that decrements the VM cursor by eight bytes and returns zero.

Consumes three strings, an integer and an Obj, resolves two strings and conditionally forwards the packet with mode 2 before pushing the helper result.

Consumes two strings and an Obj, resolves both strings under a manager gate and submits mode 1 before pushing the helper result.

Consumes two strings and an Obj, applies an additional native gate and submits translated strings with mode 0 before pushing the helper result.