CKS TYPECKS reference

Query

Browse its members and the signatures that accept or return this type.

34 members25 return it20 accept it

Members

Expand a member to read its notes or open its full entry. Each overload keeps its own identity.

Return this type

Member	Signature and description
`Group`Global	`Query Group(str)` Looks up a named group query and conditionally constructs and registers a replacement before returning its managed Query value.
`Union`Global	`Query Union(Query, Query)` Creates or reuses a composite Query node of operation code zero for two Query operands.
`Intersect`Global	`Query Intersect(Query, Query)` Builds a composite Query from two resolved handles using selector 1 and returns its handle.
`Substract`Global	`Query Substract(Query, Query)`Description pending Description pending.
`Subtract`Global	`Query Subtract(Query, Query)` Creates or reuses a composite Query node of operation code two for two Query operands.
`ClassPlayerAreaObjs`Global	`Query ClassPlayerAreaObjs(str, int, str)`Description pending Description pending.
`ClassPlayerObjs`Global	`Query ClassPlayerObjs(str, int)` Validates a player and class name, then returns a cached or newly built player-class Query.
`BuildingsInSettlement`Global	`Query BuildingsInSettlement(str, str)`Description pending Description pending.
`UnitsInSettlement`Global	`Query UnitsInSettlement(str, str)`Description pending Description pending.
`UnitsAroundSettlement`Global	`Query UnitsAroundSettlement(str, str)`Description pending Description pending.
`UnitsGuardingSettlement`Global	`Query UnitsGuardingSettlement(str, str)`Description pending Description pending.
`UnitsInSettlement`Global	`Query UnitsInSettlement(Settlement, str)`Description pending Description pending.
`UnitsAroundSettlement`Global	`Query UnitsAroundSettlement(Settlement, str)`Description pending Description pending.
`UnitsGuardingSettlement`Global	`Query UnitsGuardingSettlement(Settlement, str)`Description pending Description pending.
`EnemyObjs`Global	`Query EnemyObjs(int, str)` Validates a player and class string, requests a mode-two cached query and returns its managed Query value.
`FriendlyObjs`Global	`Query FriendlyObjs(int, str)` Constructs a class-filtered Query for a specified player.
`ControllableObjs`Global	`Query ControllableObjs(int, str)`Description pending Description pending.
`AreaObjs`Global	`Query AreaObjs(str, str)` Returns a query with the objects inside the map area named by its first argument. Works with both rectangular and circular areas.
`ObjsInRect`Global	`Query ObjsInRect(rect, str)` Builds a query from an inclusive rectangle and a resolved script-class filter.
`ObjsInCircle`Global	`Query ObjsInCircle(point, int, str)` Returns a class-filtered spatial query centered on a point with a supplied radius.
`ObjsInSight`Global	`Query ObjsInSight(Obj, str)` Builds a class-filtered query of objects visible to a resolved object.
`VisibleObjsInSight`Global	`Query VisibleObjsInSight(Obj, str)` Builds a visibility-mode class-filtered Query around a resolved Obj.
`ObjsInRange`Global	`Query ObjsInRange(Obj, str, int)` Validates an Obj and class name, then returns a cached or newly built object-range Query.
`AttachedUnits`Global	`Query AttachedUnits(Hero, str)` Builds a class-filtered query of units attached to a resolved hero.
`PartyQuery`Global	`Query PartyQuery()` Pushes a singleton query handle with its owned VM footer.

Accept this type

Member	Signature and description
`Union`Global	`Query Union(Query, Query)` Creates or reuses a composite Query node of operation code zero for two Query operands.
`Intersect`Global	`Query Intersect(Query, Query)` Builds a composite Query from two resolved handles using selector 1 and returns its handle.
`Substract`Global	`Query Substract(Query, Query)`Description pending Description pending.
`Subtract`Global	`Query Subtract(Query, Query)` Creates or reuses a composite Query node of operation code two for two Query operands.
`=`Global	`void =(Query&, Query)`Description pending Description pending.
`DistributeExperience`Global	`void DistributeExperience(Query, int)` Divides an unsigned experience amount across query members and adds the remainder to the first registry-live recipient.
`AttackArea`Global	`void AttackArea(Query, str)` Routes Query and area name to the shared dispatcher with the advance literal.
`MoveToArea`Global	`void MoveToArea(Query, str)` Routes Query and area name to the shared dispatcher with the move literal.
`NearestObj`Global	`Obj NearestObj(Query, point)`Description pending Description pending.
`NearestObj`Global	`Obj NearestObj(Query, Obj)`Description pending Description pending.
`WaitIdle`Global	`bool WaitIdle(Query, int)` Implements the registered WaitIdle blocking predicate and timeout paths.
`WaitObjInQuery`Global	`bool WaitObjInQuery(Obj, Query, int)` Implements the registered WaitObjInQuery blocking predicate and timeout paths.
`WaitQueryCountBetween`Global	`bool WaitQueryCountBetween(Query, int, int, int)` Implements the registered WaitQueryCountBetween blocking predicate and timeout paths.
`WaitCommonObjects`Global	`bool WaitCommonObjects(Query, Query, int)` Implements a blocking wait condition over two queries and schedules a retry interval when required.
`WaitHealthBetween`Global	`bool WaitHealthBetween(Query, int, int, int)` Implements the registered WaitHealthBetween blocking predicate and timeout paths.
`WaitConvRequest`Global	`bool WaitConvRequest(Query, Query, int, Obj&, Obj&)`Description pending Description pending.
`WaitUnitsInArea`Global	`bool WaitUnitsInArea(Query, str, int)` WaitUnitsInArea tests a nonempty query collection using the area acceptance helper.
`WaitIdleUnitsInArea`Global	`bool WaitIdleUnitsInArea(Query, str, int)` WaitIdleUnitsInArea tests idle names in a nonempty area-filtered collection.
`WaitEmptyQuery`Global	`bool WaitEmptyQuery(Query, int)` WaitEmptyQuery completes true when query virtual slot [field] returns nonzero.
`WaitNonEmptyQuery`Global	`bool WaitNonEmptyQuery(Query, int)` WaitNonEmptyQuery completes true when query virtual slot [field] returns zero.

Coverage and limits

30 / 34 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.

Member	Signature and description
`Erase` Invokes a virtual operation on query members that lack a particular object flag. The meaning of that flag is not documented. Open full entry → Query	`void Query::Erase()` Invokes a virtual operation on query members that lack a particular object flag. The meaning of that flag is not documented.
`SetPlayer` Passes the script player value minus one to each live Query member's virtual slot [field]. Open full entry → Query	`void Query::SetPlayer(int)` Passes the script player value minus one to each live Query member's virtual slot [field].
`Damage` Calls virtual damage slot [field] on eligible Query members and counts nonzero call results. Open full entry → Query	`int Query::Damage(int)` Calls virtual damage slot [field] on eligible Query members and counts nonzero call results.
`Heal` Adds a signed amount to eligible query members' health and clamps each result to maximum health. Open full entry → Query	`void Query::Heal(int)` Adds a signed amount to eligible query members' health and clamps each result to maximum health.
`HealStamina` Adds an integer amount to eligible Query members' stamina and caps it at each member's maximum. Open full entry → Query	`void Query::HealStamina(int)` Adds an integer amount to eligible Query members' stamina and caps it at each member's maximum.
`AddDefCmd` Resolves Query and optional Obj, passes point, target ID or 65535 and two normalized flags to the default-command dispatch chain. Open full entry → Query	`void Query::AddDefCmd(point, Obj, bool, bool)` Resolves Query and optional Obj, passes point, target ID or 65535 and two normalized flags to the default-command dispatch chain.
`IsValid` Behavior awaiting documentation. Open full entry → Query	`bool Query::IsValid()`Description pending Description pending.
`count` Returns the result container's count for a resolved Query, or zero for an invalid receiver. Open full entry → Query	`int Query::count()` Returns the result container's count for a resolved Query, or zero for an invalid receiver.
`IsEmpty` Returns whether a resolved Query's virtual emptiness predicate is nonzero, with true for an invalid receiver. Open full entry → Query	`bool Query::IsEmpty()` Returns whether a resolved Query's virtual emptiness predicate is nonzero, with true for an invalid receiver.
`Contains` Passes an Obj value to a resolved Query's membership predicate and returns its boolean result. Open full entry → Query	`bool Query::Contains(Obj)` Passes an Obj value to a resolved Query's membership predicate and returns its boolean result.
`ClearCommands` For each live member of a resolved Query, calls virtual [field] with zero while the global gate is zero. Open full entry → Query	`void Query::ClearCommands()` For each live member of a resolved Query, calls virtual [field] with zero while the global gate is zero.
`KillCommand` For each live Query member, calls [field] with zero while the global gate is zero. Open full entry → Query	`void Query::KillCommand()` For each live Query member, calls [field] with zero while the global gate is zero.
`AddCommand` Dispatches factory mode zero for each live Query member and installs nonnull results with the normalized bool. Open full entry → Query	`void Query::AddCommand(bool, str)` Dispatches factory mode zero for each live Query member and installs nonnull results with the normalized bool.
`AddCommand` Dispatches factory mode one with the unchanged point pair for each live Query member and installs nonnull results. Open full entry → Query	`void Query::AddCommand(bool, str, point)` Dispatches factory mode one with the unchanged point pair for each live Query member and installs nonnull results.
`AddCommand` Dispatches factory mode two with the raw Obj pair after validating its low-word registry slot, installing nonnull results on live Query members. Open full entry → Query	`void Query::AddCommand(bool, str, Obj)` Dispatches factory mode two with the raw Obj pair after validating its low-word registry slot, installing nonnull results on live Query members.
`AddCommandOffset` Transforms each live member position by requested point minus live-member average, then dispatches mode one without local clamping. Open full entry → Query	`void Query::AddCommandOffset(bool, str, point)` Transforms each live member position by requested point minus live-member average, then dispatches mode one without local clamping.
`SetCommand` Calls virtual [field](0) before mode-zero factory dispatch and calls [field](0) after each live member attempt. Open full entry → Query	`void Query::SetCommand(str)` Calls virtual [field](0) before mode-zero factory dispatch and calls [field](0) after each live member attempt.
`SetCommand` Creates and installs the requested point command on each valid object selected by a Query. Open full entry → Query	`void Query::SetCommand(str, point)` Creates and installs the requested point command on each valid object selected by a Query.
`SetCommand` Constructs and installs an object-targeted command for each live member of a resolved Query. Open full entry → Query	`void Query::SetCommand(str, Obj)` Constructs and installs an object-targeted command for each live member of a resolved Query.
`SetCommandOffset` Translates member positions relative to the live-member average and clamps them before factory mode-one dispatch, after virtual [field](0). Open full entry → Query	`void Query::SetCommandOffset(str, point)` Translates member positions relative to the live-member average and clamps them before factory mode-one dispatch, after virtual [field](0).
`GetObjList` Returns a new ObjList copied from a resolved Query object's list-producing virtual method, or an empty list when resolution fails. Open full entry → Query	`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.
`NearestObj` Behavior awaiting documentation. Open full entry → Query	`Obj Query::NearestObj(point)`Description pending Description pending.
`NearestObj` Behavior awaiting documentation. Open full entry → Query	`Obj Query::NearestObj(Obj)`Description pending Description pending.
`AddToGroup` Dispatches live query members to the named group collection. Open full entry → Query	`void Query::AddToGroup(str)` Dispatches live query members to the named group collection.
`RemoveFromGroup` Removes each live object in the query from the named group. Open full entry → Query	`void Query::RemoveFromGroup(str)` Removes each live object in the query from the named group.
`RemoveFromAllGroups` Behavior awaiting documentation. Open full entry → Query	`void Query::RemoveFromAllGroups()`Description pending Description pending.
`Face` Applies a face-point command to each live member of a query. Open full entry → Query	`void Query::Face(point)` Applies a face-point command to each live member of a query.
`SetFood` Assigns a nonnegative food value to every unit-compatible live member of a query. Open full entry → Query	`void Query::SetFood(int)` Assigns a nonnegative food value to every unit-compatible live member of a query.
`InHolder` Counts the query's units that are inside the named settlement. Open full entry → Query	`int Query::InHolder(str)` Counts the query's units that are inside the named settlement.
`AddToHolder` Attempts forced holder entry for unit-compatible members of the query. Open full entry → Query	`void Query::AddToHolder(str)` Attempts forced holder entry for unit-compatible members of the query.
`GetAverageDirection` Returns the average direction of the query's objects, or a zero point for an empty or invalid query. Open full entry → Query	`point Query::GetAverageDirection()` Returns the average direction of the query's objects, or a zero point for an empty or invalid query.
`SetParty` Dispatches unit-compatible query members to a Boolean-selected game virtual operation. Open full entry → Query	`void Query::SetParty(bool)` Dispatches unit-compatible query members to a Boolean-selected game virtual operation.
`SetMessengerStatus` Dispatches a mask to eligible script objects through a virtual operation selected by the boolean argument. Open full entry → Query	`void Query::SetMessengerStatus(bool)` Dispatches a mask to eligible script objects through a virtual operation selected by the boolean argument.
`SetFeeding` Sets or clears a unit flag for eligible query members. Open full entry → Query	`void Query::SetFeeding(bool)` Sets or clears a unit flag for eligible query members.