ObjList
Browse its members and the signatures that accept or return this type.
Members
42Expand a member to read its notes or open its full entry. Each overload keeps its own identity.
| Member | Signature and description |
|---|---|
| int ObjList::count()ObjList::count returns the 32-bit member count at resolved ObjList object offset [field]. |
| ObjList | bool ObjList::Contains(Obj)Tests whether a list contains the low-16-bit slot of an Obj handle. |
| ObjList | void ObjList::Add(Obj)Appends an Obj's slot to the list if no matching slot is already present. |
| ObjList | void ObjList::Remove(Obj)Removes the first matching Obj slot from a list. |
| void ObjList::ClearDead()Removes list members lacking a registry object or reporting nonzero at virtual slot [field]. |
| void ObjList::AddList(ObjList)Iterates a source object list and appends objects not already present in the destination list. |
| ObjList | void ObjList::RemoveList(ObjList)Removes receiver members matching handles encountered in a second list. |
| void ObjList::Clear()Empties the object list on which it is called. The objects that were listed remain in the game. |
| void ObjList::AddToGroup(str)The handler looks up the named group, creates a group object on the nonzero lookup branch, then traverses the receiver list. |
| ObjList | void ObjList::RemoveFromGroup(str)The handler looks up the supplied group name. |
| void ObjList::RemoveFromAllGroups()Traverses groups and input list members, conditionally erasing matching members from each group. |
| void ObjList::KillCommand()For each resolved member whose virtual [field] predicate returns zero, invokes [field] with zero to update command state. |
| void ObjList::ClearCommands()Iterates an ObjList and clears commands on members accepted by a virtual eligibility predicate. |
| void ObjList::AddCommand(bool, str)Creates and enqueues a named command for every eligible object-list member. |
| void ObjList::AddCommand(bool, str, point)For each resolved eligible member, creates a named point command with selector 1 and submits it through virtual [field] using the supplied Boolean. |
| void ObjList::AddCommand(bool, str, Obj)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. |
| void ObjList::AddCommandOffset(bool, str, point)Creates point-targeted commands for object-list members while preserving their offsets from the list center. |
| void ObjList::ExecDefaultCmd(point, Obj, bool, bool)Resolves the optional Obj handle to its object identifier at +8 and delegates the list, point, identifier, two Booleans and -1 to [field]. |
| void ObjList::ExecCmd(str, point, Obj, bool)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. |
| void ObjList::SetCommand(str)For each resolved eligible member, calls virtual [field] with zero, creates the named command with selector 0, submits it through virtual [field] with false, and updates command state. |
| void ObjList::SetCommand(str, point)For each resolved eligible member, calls virtual [field] with zero, creates a named point command with selector 1, submits it through virtual [field] with false, and updates command state. |
| void ObjList::SetCommand(str, Obj)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. |
| void ObjList::SetCommandOffset(str, point)Computes the list center, offsets each eligible member position from that center, clamps the translated target to map bounds, then creates and submits a selector-1 point command after virtual [field]. |
| ObjList ObjList::GetCanExecCmd(str)Allocates a new ObjList, resolves the command through the command-order registry virtual [field], and copies slots of valid source members whose virtual [field] predicate accepts that command. |
| ObjList ObjList::FilterClosest(point, int)Creates an ObjList through a bounded distance-selection helper using a point and count. |
| ObjList | void ObjList::Face(point)After popping the point and receiver list, the handler traverses member slots. |
| ObjList | void ObjList::SetFood(int)The handler rejects a negative input. |
| ObjList | void ObjList::SetPlayer(int)The handler accepts input player numbers 1 through 16. |
| int ObjList::InHolder(str)Finds the settlement whose stored name matches the supplied string, then counts list members convertible to Unit whose stored holder identifier matches that settlement. |
| ObjList | void ObjList::AddToHolder(str)Moves compatible units from the list into the named settlement. |
| void ObjList::SetVisible(bool)Applies a visibility boolean to an object list and to eligible nested visibility controllers of its members. |
| ObjList ObjList::ObjPlayer(int)Builds a new ObjList containing source members owned by the requested script player. |
| ObjList | ObjList ObjList::ObjEnemy(int)Filters an ObjList using the zero state of a player relation bit. |
| ObjList | ObjList ObjList::ObjAlly(int)Filters an ObjList using the set state of a player relation bit. |
| ObjList | ObjList ObjList::ObjClass(str)Filters an ObjList by class-template ancestry. |
| void ObjList::ObjSpecial(int)Selects ObjList member slots by a numbered special-bit test and constructs an ObjList value. |
| ObjList | ObjList ObjList::ObjInjured()Filters an ObjList by a strict object-field comparison. |
| ObjList | ObjList ObjList::ObjFullStamina()Filters an ObjList by a non-strict object-field comparison. |
| Obj ObjList::Find(str)Returns the first live ObjList member matching a resolved class-template ancestry test. |
| Obj ObjList::FindAlly(int, str)Returns the first live class-matching ObjList member with the selected relation bit set. |
| Obj ObjList::FindEnemy(int, str)Returns the first live class-matching ObjList member with the selected relation bit clear. |
| ObjList | void ObjList::Siege(Obj, int, int)The handler pops two integers and two object handles. |
Return this type
34| Member | Signature and description |
|---|---|
_GetSelectionGlobal | ObjList _GetSelection()Returns the active player's selected objects as an ObjList. |
SpawnGroupGlobal | ObjList SpawnGroup(str)Looks up a named group, processes its live unit members through the world-spawn helper, and returns its resulting ObjList. |
SpawnGroupInHolderGlobal | ObjList SpawnGroupInHolder(str, str)Resolves a named group and named holder, forces eligible group units into that holder, and returns the processed-unit ObjList. |
SpawnGroupInHolderGlobal | ObjList SpawnGroupInHolder(str, Obj)Resolves a named group and an Obj receiver's virtual holder, forces eligible group units into it, and returns the processed-unit ObjList. |
Query::GetObjListQuery | ObjList Query::GetObjList()Returns a new ObjList copied from a resolved Query object's list-producing virtual method, or an empty list when resolution fails. |
Unit::GetUnitsInSameHolderUnit | ObjList Unit::GetUnitsInSameHolder()Returns the objects in the unit's holder as a new ObjList. |
GetPlayerUnitsGlobal | ObjList GetPlayerUnits(int)Builds an ObjList of units for a one-based player number. |
GetPlayerUnitsGlobal | ObjList GetPlayerUnits(int, str)Builds an ObjList of a player's units using a resolved script class filter. |
Hero::armyHero | ObjList Hero::army()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. |
Settlement::UnitsSettlement | ObjList Settlement::Units()Returns an ObjList view of a settlement holder's unit collection for the Settlement::Units registration. |
Settlement::BuildingsSettlement | ObjList Settlement::Buildings()Settlement::Buildings returns an ObjList view at settlement [field], or an allocated empty list for an invalid settlement handle. |
Settlement::ObjectsAroundSettlement | ObjList Settlement::ObjectsAround(str)Builds an ObjList of settlement-associated objects matching a requested script class. |
ObjList::GetCanExecCmdObjList | ObjList ObjList::GetCanExecCmd(str)Allocates a new ObjList, resolves the command through the command-order registry virtual [field], and copies slots of valid source members whose virtual [field] predicate accepts that command. |
ObjList::FilterClosestObjList | ObjList ObjList::FilterClosest(point, int)Creates an ObjList through a bounded distance-selection helper using a point and count. |
ObjList::ObjPlayerObjList | ObjList ObjList::ObjPlayer(int)Builds a new ObjList containing source members owned by the requested script player. |
ObjList::ObjEnemyObjList | ObjList ObjList::ObjEnemy(int)Filters an ObjList using the zero state of a player relation bit. |
ObjList::ObjAllyObjList | ObjList ObjList::ObjAlly(int)Filters an ObjList using the set state of a player relation bit. |
ObjList::ObjClassObjList | ObjList ObjList::ObjClass(str)Filters an ObjList by class-template ancestry. |
ObjList::ObjInjuredObjList | ObjList ObjList::ObjInjured()Filters an ObjList by a strict object-field comparison. |
ObjList::ObjFullStaminaObjList | ObjList ObjList::ObjFullStamina()Filters an ObjList by a non-strict object-field comparison. |
PartyGlobal | ObjList Party()Copies the game object's container at [field] into a new ObjList wrapper. |
Sacrifice::DruidsSacrifice | ObjList Sacrifice::Druids()Copies the Sacrifice object's linked-list member handles into a new ObjList. |
Ship::GetUnitsOnBoardShip | ObjList Ship::GetUnitsOnBoard()Copies the container at [field] of the object selected by the Ship's [field] handle. |
Squad::UnitsSquad | ObjList Squad::Units()Copies the Squad record's [field] member container into a new ObjList. |
GetSettlementsGlobal | ObjList GetSettlements(str, int)Builds an ObjList of map settlements selected by owner and central-building class. |
GAIKA::GetAIControlledUnitsGAIKA | ObjList GAIKA::GetAIControlledUnits(str, int, int, bool)Builds an ObjList of eligible units controlled by a selected GAIKA record under class, relation and limit filters. |
Settlement::TSRecruitArmySettlement | ObjList Settlement::TSRecruitArmy(str, int)Builds an ObjList and delegates Settlement tactical recruitment through TSH_RecruitArmy.vs and the universal command path. |
Settlement::TSGetAllBarracksSettlement | ObjList Settlement::TSGetAllBarracks()Filters settlement building handles into an ObjList of barracks candidates. |
Settlement::TSGetAllArenaeSettlement | ObjList Settlement::TSGetAllArenae()Filters settlement building handles into an ObjList of arena candidates. |
Settlement::TSGetAllTemplesSettlement | ObjList Settlement::TSGetAllTemples()Builds an ObjList of eligible settlement members derived from the race-specific temple class. |
Settlement::TSArenaRecruitSettlement | ObjList Settlement::TSArenaRecruit(int)Builds an ObjList and delegates Settlement tactical recruitment through TSH_ArenaRecruit.vs and the universal command path. |
Settlement::TSTempleRecruitSettlement | ObjList Settlement::TSTempleRecruit(int)Builds an ObjList and delegates Settlement tactical recruitment through TSH_TempleRecruit.vs and the universal command path. |
selGlobal | ObjList sel()Returns an ObjList refreshed from the selection source selected by global state. |
GetShortcutSelGlobal | ObjList GetShortcutSel(int, int)Native CKS binding exporting a numbered control group's primary unit list to a new ObjList, validating the full 0..9 range. |
Accept this type
11| Member | Signature and description |
|---|---|
Settlement::AddUnitsSettlement | int Settlement::AddUnits(ObjList)Attempts nonforced holder entry for eligible members of a supplied ObjList and returns the number of successful entries. |
=Global | void =(ObjList&, ObjList)Description pendingDescription pending. |
[Global | Obj [(ObjList, int)Description pendingDescription pending. |
ObjList::AddListObjList | void ObjList::AddList(ObjList)Iterates a source object list and appends objects not already present in the destination list. |
ObjList::RemoveListObjList | void ObjList::RemoveList(ObjList)Removes receiver members matching handles encountered in a second list. |
Ship::UnboardUnitsShip | void Ship::UnboardUnits(ObjList)Selects candidate positions and dispatches a reserve and movement routine for matching ObjList members. |
AIRunGlobal | int AIRun(str, Settlement, ObjList, Obj, int)Starts a typed AI script task in the current script player's AI context and returns its task identifier. |
AIRunGlobal | int AIRun(int, str, Settlement, ObjList, Obj, int)Attempts to start an AI script task for the supplied one-based player and returns its task identifier or -1. |
SquadizeGlobal | void Squadize(ObjList, SquadList, int)CKS scripting primitive wrapper exposing Squadize(ObjList ol, SquadList *sl, int nState) to scenario and AI scripts. |
SetNoAIFlagGlobal | void SetNoAIFlag(ObjList, bool)The handler traverses the supplied ObjList. |
SetShortcutSelGlobal | void SetShortcutSel(int, int, ObjList)Native CKS binding writing eligible units from an ObjList into a numbered control group, validating the full 0..9 range. |
Coverage and limits
42 / 42 members with a published description.
These lists come from published signatures. “Accept” counts explicit parameters, excluding the method receiver; reference variants (&) are included. No inheritance hierarchy is asserted. Undocumented names, units and effects remain unresolved.