CKS TYPECKS reference

bool

Browse its members and the signatures that accept or return this type. This catalog publishes no own members for this type.

0 members242 return it83 accept it

Members

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

No entries in the published catalog.

Return this type

242

Member	Signature and description
`==`Global	`bool ==(int, int)`Description pending Description pending.
`!=`Global	`bool !=(int, int)`Description pending Description pending.
`<`Global	`bool <(int, int)`Description pending Description pending.
`>`Global	`bool >(int, int)`Description pending Description pending.
`<=`Global	`bool <=(int, int)`Description pending Description pending.
`>=`Global	`bool >=(int, int)`Description pending Description pending.
`==`Global	`bool ==(float, float)`Description pending Description pending.
`!=`Global	`bool !=(float, float)`Description pending Description pending.
`<`Global	`bool <(float, float)`Description pending Description pending.
`>`Global	`bool >(float, float)`Description pending Description pending.
`!`Global	`bool !(bool)`Description pending Description pending.
`&&`Global	`bool &&(bool, bool)`Description pending Description pending.
`\|\|`Global	`bool \|\|(bool, bool)`Description pending Description pending.
`^`Global	`bool ^(bool, bool)`Description pending Description pending.
`StrStr`Global	`bool StrStr(str, str)` Checks whether a string contains another string.
`IsNull`Global	`bool IsNull(str)` Checks whether the string pointer is null. A nonnull string also undergoes reference-count cleanup.
`==`Global	`bool ==(str, str)`Description pending Description pending.
`!=`Global	`bool !=(str, str)`Description pending Description pending.
`IsFlagSet`Global	`bool IsFlagSet(int, int)` Checks whether the two integer values share any set bits.
`point::InRect`point	`bool point::InRect(rect)` Checks whether the point lies inside the rectangle, including its boundaries.
`==`Global	`bool ==(point, point)`Description pending Description pending.
`!=`Global	`bool !=(point, point)`Description pending Description pending.
`==`Global	`bool ==(rect, rect)`Description pending Description pending.
`!=`Global	`bool !=(rect, rect)`Description pending Description pending.
`StrMap::exists`StrMap	`bool StrMap::exists(str)`Description pending Description pending.
`==`Global	`bool ==(Obj, Obj)`Description pending Description pending.
`!=`Global	`bool !=(Obj, Obj)`Description pending Description pending.
`Obj::IsHeirOf`Obj	`bool Obj::IsHeirOf(str)` Obj::IsHeirOf delegates class ancestry testing for a resolved Obj.
`Obj::IsSentry`Obj	`bool Obj::IsSentry()` Checks whether the object belongs to the Sentry class or a derived class.
`Obj::IsGate`Obj	`bool Obj::IsGate()` Checks whether the object belongs to the Gate class or a derived class.
`Obj::IsRam`Obj	`bool Obj::IsRam()` Tests whether the resolved object class inherits from the cached RamUnit descriptor.
`Obj::IsRanged`Obj	`bool Obj::IsRanged()` Resolves an Obj handle and returns a sentinel-based property test.
`Obj::IsMilitary`Obj	`bool Obj::IsMilitary()` Checks whether the object belongs to the Military class or a derived class.
`Obj::IsReligious`Obj	`bool Obj::IsReligious()` Tests whether the resolved object class inherits from the cached BaseMage descriptor.
`Obj::IsPeaceful`Obj	`bool Obj::IsPeaceful()` Checks whether the object belongs to the Peaceful or Animal class.
`Obj::IsPeasant`Obj	`bool Obj::IsPeasant()` Checks whether the object belongs to the Peasant class or a derived class.
`Obj::IsPeasantAmbient`Obj	`bool Obj::IsPeasantAmbient()` Tests whether the resolved object class inherits from the cached PeasantAmbient descriptor.
`Obj::IsValid`Obj	`bool Obj::IsValid()` Checks whether the object reference resolves to an available object. This does not describe whether that object is alive.
`Item::IsValid`Item	`bool Item::IsValid()` returns true when the handle's registry base plus subobject offset is nonzero, and false when the registry slot is empty.
`Obj::IsEnemy`Obj	`bool Obj::IsEnemy(Obj)` Checks whether the objects belong to enemy players. Returns false for allies or invalid objects.
`Obj::IsAlive`Obj	`bool Obj::IsAlive()` Evaluates whether an object is alive by querying its virtual destruction slot at [field] and inverting the result.
`Obj::IsDead`Obj	`bool Obj::IsDead()` Returns true when the object is dead or the reference cannot be resolved.
`Obj::IsValidTarget`Obj	`bool Obj::IsValidTarget(Obj)` Resolves two object handles and tests the target with a receiver virtual predicate.
`Obj::IsValidCaptureTarget`Obj	`bool Obj::IsValidCaptureTarget(Obj)`Description pending Description pending.
`Obj::IsVisible`Obj	`bool Obj::IsVisible()` Obj::IsVisible returns the inverse of bit 21 in the resolved object's dword at [field], or false when resolution fails.
`Obj::CanSee`Obj	`bool Obj::CanSee(Obj)` Obj::CanSee combines a target flag with an observer-mask intersection.
`Obj::CanAttack`Obj	`bool Obj::CanAttack(Obj)` Tests the receiver target-eligibility gate and radius-adjusted signed inclusive attack range.
`Obj::Damage`Obj	`bool Obj::Damage(int)` Applies a nonnegative damage amount through an object's virtual damage operation after an optional related-object call.
`Obj::IsInGroup`Obj	`bool Obj::IsInGroup(str)` Looks up the string key and returns the normalized result of found-group virtual [field] for the resolved Obj.
`Obj::AddItem`Obj	`bool Obj::AddItem(str)` Attempts to add an item with the specified name and returns whether it succeeded.
`Obj::GiveItem`Obj	`bool Obj::GiveItem(Item, Obj)` Transfers an owned item to another live object. If the destination cannot accept it, the transfer attempts to return it to the source.
`Obj::OpenItemHolder`Obj	`bool Obj::OpenItemHolder(ItemHolder)` Transfers items from a holder into an eligible object's inventory.
`Obj::PutItem`Obj	`bool Obj::PutItem(Item, ItemHolder)` Moves an inventory item into the specified item holder.
`Obj::DropItem`Obj	`bool Obj::DropItem(Item, point)` Requests that a specified receiver item be dropped at a point while returning false.
`Obj::ExchangeItem`Obj	`bool Obj::ExchangeItem(Item, str)` ExchangeItem returns true after a gated replacement dispatch.
`Obj::GetDebug`Obj	`bool Obj::GetDebug()` GetDebug compares resolved object dword [field] with dword[[field]].
`Obj::IsWaterUnit`Obj	`bool Obj::IsWaterUnit()` IsWaterUnit returns whether the dword at object class [field] is nonzero.
`Obj::GetCmdEnable`Obj	`bool Obj::GetCmdEnable()` GetCmdEnable tests object [field] only when virtual [field] returns zero.
`Obj::IsInState`Obj	`bool Obj::IsInState()` 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.
`Query::IsValid`Query	`bool Query::IsValid()`Description pending Description pending.
`Query::IsEmpty`Query	`bool Query::IsEmpty()` Returns whether a resolved Query's virtual emptiness predicate is nonzero, with true for an invalid receiver.
`Query::Contains`Query	`bool Query::Contains(Obj)` Passes an Obj value to a resolved Query's membership predicate and returns its boolean result.
`NamedObj::IsValid`NamedObj	`bool NamedObj::IsValid()`Description pending Description pending.
`NamedObj::IsDead`NamedObj	`bool NamedObj::IsDead()` Returns true for unresolved NamedObj values or an empty list returned by the query after its first virtual call.
`EnemyInRange`Global	`bool EnemyInRange(point, int, Obj)` Builds a wrapped bounding rectangle and returns the spatial callback accumulator as a boolean.
`Building::Attack`Building	`bool Building::Attack(Obj)` Executes a guarded, possibly waiting Building attack that spawns an arrow shot on its firing path.
`Building::IsBroken`Building	`bool Building::IsBroken()` Generic CKS-exposed Building::IsBroken, true when the shared broken-status field equals 3.
`Building::IsCentralBuliding`Building	`bool Building::IsCentralBuliding()` Reads the template-level is_central_building flag through the object's own template pointer.
`Building::IsStonehengeControlable`Building	`bool Building::IsStonehengeControlable()` Tests whether a Stonehenge-centered map scan yields a positive counter.
`GetResearchHack`Global	`bool GetResearchHack()` Implements this function, testing the Building research-active interval flag.
`Catapult::IsBuilt`Catapult	`bool Catapult::IsBuilt()` 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.
`Catapult::InRange`Catapult	`bool Catapult::InRange(point)`Description pending Description pending.
`Unit::feeds`Unit	`bool Unit::feeds()` Returns the resolved Unit's feeding flag as a byte.
`Unit::Goto`Unit	`bool Unit::Goto(point, int, int, bool, int)` 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.
`Unit::GotoEnter`Unit	`bool Unit::GotoEnter(point, int, int, bool, int)` 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.
`Unit::Goto`Unit	`bool Unit::Goto(Obj, int, int, bool, int)` 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.
`Unit::GotoAttack`Unit	`bool Unit::GotoAttack(Obj, int, bool, int)` Prepares target tracking and delegates cooperative attack routing.
`Unit::Stop`Unit	`bool Unit::Stop(int)` 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.
`Unit::HasPath`Unit	`bool Unit::HasPath()` 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.
`Unit::InHolder`Unit	`bool Unit::InHolder()` Checks whether the resolved Unit records a holder reference different from the invalid-reference sentinel.
`Unit::InShip`Unit	`bool Unit::InShip()` Follows the Unit holder handle and a linked registry handle, then returns whether the latter resolves.
`Unit::TrainAttack`Unit	`bool Unit::TrainAttack(Obj)` A Unit training-attack primitive that can start native attack mode 2 and return VM handler status 3.
`Unit::IsTraining`Unit	`bool Unit::IsTraining()` Unit::IsTraining extracts bit 28 from the resolved Unit object's dword at offset [field] and returns it as a boolean.
`Unit::Attack`Unit	`bool Unit::Attack(Obj)` Implements a cooperative single-target attack sequence using continuation state, eligibility checks, attack dispatch, and wait status.
`Unit::AttackEveryone`Unit	`bool Unit::AttackEveryone(Obj)` Implements a cooperative attack sequence with range and eligibility checks before dispatch.
`Unit::IsEnemyInSquadSight`Unit	`bool Unit::IsEnemyInSquadSight()` Tests a linked sight record field for a live Unit and has a return-width mismatch on invalid paths.
`Unit::EnemiesInSight`Unit	`bool Unit::EnemiesInSight()` Builds a diplomacy-filtered spatial query around the Unit and returns whether a matching candidate was found.
`Unit::InRange`Unit	`bool Unit::InRange(Obj)` Checks a resolved target against a resolved Unit using the common attack-range helper.
`Unit::AttachTo`Unit	`bool Unit::AttachTo(Hero)` Resolves Unit and Hero, rejects invalid or virtual [field] positive operands, then returns whether Unit helper [field] accepts the Hero.
`Unit::GetParty`Unit	`bool Unit::GetParty()` Returns the registered Unit GetParty boolean for this function.
`Unit::_OnImpassable`Unit	`bool Unit::_OnImpassable()` Tests a packed global-map bit at the resolved Unit's virtual position.
`Unit::HasFreedom`Unit	`bool Unit::HasFreedom()` Combines a Unit flag test with a class helper to return a boolean.
`Unit::GetFlags`Unit	`bool Unit::GetFlags(int)` Returns the registered Unit GetFlags boolean for this function.
`Unit::SameHolderAs`Unit	`bool Unit::SameHolderAs(Unit)` Compares the holder-handle words of two resolved Units.
`Unit::GetCommanded`Unit	`bool Unit::GetCommanded()` Reads bit 19 of a resolved Unit's state flags as a boolean.
`Unit::GetEntering`Unit	`bool Unit::GetEntering()` Reads bit 20 of a resolved Unit's state flags as a boolean.
`Unit::DoCarryNothing`Unit	`bool Unit::DoCarryNothing()` Tests whether a resolved Unit's carry animation selector is zero.
`Unit::IsCursed`Unit	`bool Unit::IsCursed()` Reads one Unit flag bit as a CKS bool.
`Unit::IsDiseased`Unit	`bool Unit::IsDiseased()` Reads one Unit flag bit as a CKS bool.
`Unit::HasSpecial`Unit	`bool Unit::HasSpecial(int)` Tests an indexed bit in the Unit special mask.
`Hero::IsHeroArmyFull`Hero	`bool Hero::IsHeroArmyFull()` Compares army count and capacity for this function.
`Hero::HasArmy`Hero	`bool Hero::HasArmy()` Hero::HasArmy returns whether the resolved Hero dword at offset [field] is nonzero.
`Hero::HasFinalPartyOrientationRequest`Hero	`bool Hero::HasFinalPartyOrientationRequest()` Tests the stored orientation request pair for this function.
`Hero::UseSkill`Hero	`bool Hero::UseSkill(int)` Resolves a Hero handle and returns whether the native Hero skill dispatcher accepted the supplied skill ID.
`Hero::SkillInEffect`Hero	`bool Hero::SkillInEffect(int)` Resolves a Hero and tests whether an indexed skill-effect slot differs from the -1 sentinel.
`Hero::autocast`Hero	`bool Hero::autocast()` Resolves a Hero and reads bit 2 from its flags dword at [field].
`Druid::IsSummoningDeath`Druid	`bool Druid::IsSummoningDeath()`Description pending Description pending.
`==`Global	`bool ==(Settlement, Settlement)`Description pending Description pending.
`Settlement::AddUnit`Settlement	`bool Settlement::AddUnit(Unit)` CKS-exposed Settlement::AddUnit, adding a unit to the settlement's Holder without bypassing capacity.
`Settlement::IsFull`Settlement	`bool Settlement::IsFull()` CKS-exposed Settlement::IsFull, comparing the settlement's Holder occupancy to capacity.
`Settlement::IsValid`Settlement	`bool Settlement::IsValid()` CKS native primitive that tests whether an Obj handle is valid; used generically, including on settlement handles.
`Settlement::CanBeCaptured`Settlement	`bool Settlement::CanBeCaptured(Unit)`Description pending Description pending.
`Settlement::IsCity`Settlement	`bool Settlement::IsCity()` Tests whether the settlement's central building's own UnitTemplate name string matches "GTownhall" or "RTownhall", distinguishing a template-name comparison from a class-name identity test.
`ItemHolder::AddItem`ItemHolder	`bool ItemHolder::AddItem(str)` Submits a non-null named candidate to virtual slot [field] and returns candidate existence.
`ItemHolder::HasItem`ItemHolder	`bool ItemHolder::HasItem(str)` Scans indexed holder entries for exact equality with the supplied string.
`ObjList::Contains`ObjList	`bool ObjList::Contains(Obj)` Tests whether a list contains the low-16-bit slot of an Obj handle.
`ActorPresent`Global	`bool ActorPresent(str)`Description pending Description pending.
`IsRunning`Global	`bool IsRunning(str)` IsRunning tests exact provider text Running.
`IsWaiting`Global	`bool IsWaiting(str)` IsWaiting tests exact provider text Waiting.
`IsFinished`Global	`bool IsFinished(str)` IsFinished tests exact provider text Finished.
`MusicPlaying`Global	`bool MusicPlaying()` MusicPlaying tests the low16 result of a virtual manager query.
`_Run`Global	`bool _Run(str)` _Run returns true only after both compile and map scheduling helpers return zero.
`IsMultiplayer`Global	`bool IsMultiplayer()` IsMultiplayer tests whether the session byte contains any set bit.
`IsViewLocked`Global	`bool IsViewLocked()` IsViewLocked returns whether global [field] is nonzero.
`IsPassable`Global	`bool IsPassable(point)` Returns an inverse map bitmap bit after signed bounds checks.
`IsPassable3x3`Global	`bool IsPassable3x3(point)` Tests a point and its eight surrounding offsets through a map passability bitmap helper.
`IsExplored`Global	`bool IsExplored(point, int)` Forwards a point and decremented player value to the exploration receiver.
`NoTents`Global	`bool NoTents()` NoTents negates an object predicate over the map vector.
`PlayMovie`Global	`bool PlayMovie(str)` PlayMovie returns the saved movie helper result as a bool.
`WasSelectionAssigned`Global	`bool WasSelectionAssigned(int, int)` WasSelectionAssigned group overload tests the stored assignment mask.
`WasSelectionAssigned`Global	`bool WasSelectionAssigned(int)` WasSelectionAssigned player overload tests any stored assignment bit.
`IsSelectionAssigned`Global	`bool IsSelectionAssigned(int, int)` Validates player and selection indices and reports whether the selected selection contains any units.
`IsSelectionAssigned`Global	`bool IsSelectionAssigned(int)` IsSelectionAssigned player overload scans ten live counts.
`Sacrifice::AddDruid`Sacrifice	`bool Sacrifice::AddDruid(Druid, int)` For a nonnull Sacrifice, passes the resolved Druid and a wrapping 32-bit sum of an existing receiver value and the integer argument to an operation, then returns whether its result is nonzero. Returns false for a null Sacrifice.
`Sacrifice::IsEmpty`Sacrifice	`bool Sacrifice::IsEmpty()` Sacrifice IsEmpty pushes receiver dword[field] != 0 for a resolved receiver and pushes true when receiver resolution is null.
`Sacrifice::IsInvisibility`Sacrifice	`bool Sacrifice::IsInvisibility()` For a resolved Sacrifice, IsInvisibility selects the string at descriptor+8 from receiver[field] and pushes whether case-insensitive comparison with Hide returns zero; null resolution pushes false.
`IsNoteActive`Global	`bool IsNoteActive(str)` Returns whether the input name has an exact case-sensitive key in the note-manager tree.
`DiplGetCeaseFire`Global	`bool DiplGetCeaseFire(int, int)` Evaluates whether player 1 has a ceasefire with player 2 by querying bit 0 of the player's diplomacy record.
`DiplGetShareView`Global	`bool DiplGetShareView(int, int)`Description pending Description pending.
`DiplGetShareControl`Global	`bool DiplGetShareControl(int, int)` Evaluates whether player 1 has granted shared control to player 2 by querying bit 5 of the player's diplomacy record.
`DiplGetShareSupport`Global	`bool DiplGetShareSupport(int, int)` inspects diplomacy mask bit 2 to determine if two players share support.
`Gate::IsOpened`Gate	`bool Gate::IsOpened()` CKS Gate::IsOpened tests the resolved gate state and animation frame, with true on an invalid receiver.
`Gate::IsClosed`Gate	`bool Gate::IsClosed()` CKS Gate::IsClosed tests the resolved gate state and animation frame, with false on an invalid receiver.
`Gate::AreEnemiesAround`Gate	`bool Gate::AreEnemiesAround()` Gate around predicates test cached dwords.
`Gate::AreFriendsAround`Gate	`bool Gate::AreFriendsAround()` Gate around predicates test cached dwords.
`Ship::AreUnitsToBoard`Ship	`bool Ship::AreUnitsToBoard()` Cleans invalid or destroyed entries from a ship boarding list and reports whether any remain.
`Ship::BoardUnit`Ship	`bool Ship::BoardUnit(Unit)`Description pending Description pending.
`IsPointInWater`Global	`bool IsPointInWater(point)` Evaluates whether a given map coordinate corresponds to a water terrain tile by querying the global map terrain grid.
`Ship::HasAiTransport`Ship	`bool Ship::HasAiTransport()` HasAiTransport returns whether the resolved ship's string at [field] has nonzero length at [field].
`Ship::IsBuilding`Ship	`bool Ship::IsBuilding()` Ship::IsBuilding returns the one-byte predicate signed_dword(Ship[field])>0 for a resolved Ship and false for an unresolved handle.
`Flying::IsInAir`Flying	`bool Flying::IsInAir()` Flying::IsInAir extracts bit 22 from the resolved Flying object's dword at offset [field] and returns it as a boolean.
`Flying::IsLanding`Flying	`bool Flying::IsLanding()` Returns true when a particular object flag is set and a stored 32-bit field is nonzero. The field meanings are not documented.
`OnLeft`Global	`bool OnLeft(point, point)`Description pending Description pending.
`Squad::TestFlags`Squad	`bool Squad::TestFlags(int)` Tests whether a squad satisfies all bits in a specified bitmask against its internal flags at offset [field].
`Squad::InHolder`Squad	`bool Squad::InHolder()` Scans squad members and rejects non-null entries with holder word FFFF.
`Squad::SendFoodWagon`Squad	`bool Squad::SendFoodWagon(int, int)` Selects an eligible nearby food wagon (scanning existing wagons and buildings that can spawn one) and constructs/enqueues a "follow" command targeting a hero; its own selection algorithm is substantially richer than a simple nearby-wagon scan.
`Squad::HasFreedom`Squad	`bool Squad::HasFreedom()` Scans members for a particular object flag or a nonzero class-query result.
`GAIKA::Empty`GAIKA	`bool GAIKA::Empty()` GAIKA::Empty returns whether the selected global GAIKA record dword [field] is zero, with true on explicit resolution failure.
`GAIKA::Prioritized`GAIKA	`bool GAIKA::Prioritized(int)` Looks up the selected AI table entry and returns bit zero of its stored 16-bit value.
`GAIKA::Explored`GAIKA	`bool GAIKA::Explored(int)` Resolves a player's GAIKA-related AI record and returns a mode-dependent explored predicate.
`GAIKA::CanExplore`GAIKA	`bool GAIKA::CanExplore(int)` Selects adjacent or object-derived per-player descriptors passing a native exploration predicate.
`GAIKA::Revealed`GAIKA	`bool GAIKA::Revealed(int)` Resolves a player GAIKA record and delegates a mode-dependent Boolean predicate.
`GAIKA::NoAttack`GAIKA	`bool GAIKA::NoAttack(int)` Reads the no-attack mask in a byte of the resolved GAIKA record.
`GAIKA::NoRecruit`GAIKA	`bool GAIKA::NoRecruit(int)` Reads the no-recruit mask in a byte of the mapped player record.
`GAIKA::AllEnemiesInHolder`GAIKA	`bool GAIKA::AllEnemiesInHolder(int)` Reports the negation of an accumulator set by qualifying squads with a nonempty [field] member and leader word[field] equal to FFFF.
`GAIKA::MilitaryPresence`GAIKA	`bool GAIKA::MilitaryPresence(int)` Returns true for a selected squad with clear flag bit4 or for qualifying positive holder guard count.
`SquadList::IsValid`SquadList	`bool SquadList::IsValid()` Returns whether the signed SquadList index resolves within the native list-entry table.
`SquadList::EOL`SquadList	`bool SquadList::EOL()` Tests whether a squad-list iterator is at its end.
`SquadList::Rewind`SquadList	`bool SquadList::Rewind()` Resolves a SquadList and resets its cursor to the start, returning whether an element is available.
`SquadList::Next`SquadList	`bool SquadList::Next()` Resolves a SquadList value and returns whether its cursor advance helper finds another element.
`Building::IsVeryBroken`Building	`bool Building::IsVeryBroken()` Building::IsVeryBroken returns true when current health is below integer maximum health divided by twenty.
`Settlement::CanBeCaptured`Settlement	`bool Settlement::CanBeCaptured()`Description pending Description pending.
`Settlement::IsStronghold`Settlement	`bool Settlement::IsStronghold()` Calls the BaseTownhall-family predicate on a resolved settlement.
`Settlement::IsVillage`Settlement	`bool Settlement::IsVillage()` Returns the village-class predicate for a valid Settlement.
`Settlement::IsOutpost`Settlement	`bool Settlement::IsOutpost()` Tests whether the supplied settlement object inherits from the Outpost script class.
`Settlement::IsTTent`Settlement	`bool Settlement::IsTTent()`Description pending Description pending.
`Settlement::IsShipyard`Settlement	`bool Settlement::IsShipyard()` Returns whether the linked object template inherits BaseShipyard, including the ordinary first-use literal lookup and cache path.
`Settlement::IsAlly`Settlement	`bool Settlement::IsAlly(int)` Settlement IsAlly resolves the settlement owner and tests bit zero of the indexed player-relation table entry.
`Settlement::IsEnemy`Settlement	`bool Settlement::IsEnemy(int)` Returns the inverse low-bit predicate from a player relation table for a valid settlement.
`Settlement::IsOwn`Settlement	`bool Settlement::IsOwn(int)` Settlement::IsOwn returns true only when a valid Settlement owner's zero-based index equals idPlayer minus one.
`Settlement::IsIndependent`Settlement	`bool Settlement::IsIndependent()` Returns true when the resolved settlement has linked owner code 14 or 15.
`Settlement::IsIndependentGuarded`Settlement	`bool Settlement::IsIndependentGuarded()`Description pending Description pending.
`AttackSetForTraining`Global	`bool AttackSetForTraining(Obj, point, int)` Selects a prioritized nearby training target and queues approach and engagement commands.
`Unit::AI`Unit	`bool Unit::AI()` Queries whether a unit is controlled by AI by verifying player AI state and checking the squad record's active AI flag.
`Building::IsBarrack`Building	`bool Building::IsBarrack()` Evaluates a Building through the native barracks-family class predicate and returns a VM boolean.
`IsResearched`Global	`bool IsResearched(Settlement, str)` CKS scripting primitive evaluating whether a technology or upgrade has been researched, supporting both settlement-anchored and player-direct overloads.
`IsResearched`Global	`bool IsResearched(int, str)` CKS scripting primitive evaluating whether a technology or upgrade has been researched, supporting both settlement-anchored and player-direct overloads.
`IsResearching`Global	`bool IsResearching(Settlement, str)` CKS scripting primitive reporting whether a technology or upgrade is currently in the "researching" state, with a settlement-anchored overload and a player-direct overload.
`IsResearching`Global	`bool IsResearching(int, str)` CKS scripting primitive reporting whether a technology or upgrade is currently in the "researching" state, with a settlement-anchored overload and a player-direct overload.
`GetCmdCost`Global	`bool GetCmdCost(str, int, int)` Looks up a named command and writes its gold and food cost fields to output references.
`Settlement::CanAfford`Settlement	`bool Settlement::CanAfford(int, int)` Tests positive signed resource quotients after subtracting the keyed reservation from available gold.
`Settlement::CanAfford`Settlement	`bool Settlement::CanAfford(str)` Resolves a Settlement and named command, then returns whether a cost check succeeds.
`Settlement::CanAfford`Settlement	`bool Settlement::CanAfford(str, int)` Compares the requested count with the signed native command affordability count.
`Settlement::CanResearch`Settlement	`bool Settlement::CanResearch(str)` CKS scripting primitive reporting whether a settlement is permitted to begin researching an upgrade that is not already researched or in progress.
`Settlement::ReserveFor`Settlement	`bool Settlement::ReserveFor(str, int)` Updates keyed reservation percent and command, preserving or initializing the army snapshot by branch.
`Settlement::CheckTechBudget`Settlement	`bool Settlement::CheckTechBudget(str, int)` Tests technology expenditure plus adjusted command cost against a signed percentage budget.
`IsWaterLsa`Global	`bool IsWaterLsa(int)` Handler for this function, bool IsWaterLsa(int lsa): tests whether an lsa region is water-majority.
`Gate::Inside`Gate	`bool Gate::Inside(Squad)` Tests a native gate/member path predicate universally over squad members.
`Gate::Outside`Gate	`bool Gate::Outside(Squad)` Tests the zero-result gate/member path predicate universally over squad members.
`Settlement::UpgradeBestBarrack`Settlement	`bool Settlement::UpgradeBestBarrack(int)`Description pending Description pending.
`UEnabled`Global	`bool UEnabled(int, int)` Handler for this function, bool UEnabled(int mask, int bit): tests one bit of a mask.
`CheckUEnabled`Global	`bool CheckUEnabled(int, int, int, int, int)` CheckUEnabled updates an output bit mask from a unit-class count and threshold.
`Squad::CalcGoAround`Squad	`bool Squad::CalcGoAround()` Chooses an intermediate GAIKA waypoint and reissues squad-member commands to route around an obstruction.
`Squad::TakeNearbyItems`Squad	`bool Squad::TakeNearbyItems(int)` Selects an item holder near the squad leader and issues a getitems command.
`Obj::HasItem`Obj	`bool Obj::HasItem(str)` Calls a resolved object's virtual item-name lookup and returns whether its integer result is nonnegative.
`Obj::UseItem`Obj	`bool Obj::UseItem(str)` Finds a named item on an Obj and runs its OnUse script when present.
`Squad::UseTeleport`Squad	`bool Squad::UseTeleport(Obj, int, str, point)` Stores squad state/time and submits teleport plus point commands for live members.
`IsProtected`Global	`bool IsProtected(int, point, str)` IsProtected clamps coordinates and normalizes a local query flag.
`NeedTraining`Global	`bool NeedTraining(int)` Compares a player's sampled unit-level average with a threshold derived from allied players' sampled armies.
`IsAIPlayer`Global	`bool IsAIPlayer(int)` IsAIPlayer returns true for player ids 1 through 16 whose selected player record has a non-null AI pointer, otherwise false.
`Settlement::TSResearch`Settlement	`bool Settlement::TSResearch(str)` Applies a TSH_Research command script with a Settlement, research name and temporary result reference.
`Settlement::IsTeutonTent`Settlement	`bool Settlement::IsTeutonTent()` Compares an associated settlement object's string to TTent and returns a one-byte boolean.
`AIVar`Global	`bool AIVar(int, int, int)` Three-argument AIVar returns whether a selected bit is set in an indexed AI variable word after guarded player and variable lookup.
`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.
`WaitSettlementCapture`Global	`bool WaitSettlementCapture(str, int, int)` Implements the registered WaitSettlementCapture blocking predicate and timeout paths.
`WaitSettlementAllied`Global	`bool WaitSettlementAllied(str, int, int)` Waits until a named settlement is not allied with a requested player or a finite timeout expires.
`WaitEnvStringEqual`Global	`bool WaitEnvStringEqual(str, str, int)` Implements the registered WaitEnvStringEqual blocking predicate and timeout paths.
`WaitEnvIntBetween`Global	`bool WaitEnvIntBetween(str, int, int, int)` Implements the registered WaitEnvIntBetween blocking predicate and timeout paths.
`WaitAddNote`Global	`bool WaitAddNote(str, int)` Suspends a VM thread until a named note exists or the requested timeout expires.
`WaitRemoveNote`Global	`bool WaitRemoveNote(str, int)` Suspends a VM thread while a named note remains active, subject to the requested timeout.
`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.
`WaitConvRequest`Global	`bool WaitConvRequest(Obj, Obj, int)`Description pending Description pending.
`HasStarvingArmy`Global	`bool HasStarvingArmy()` Tests whether the notifications manager contains the named army-starving notification.
`HasStarvingArmy`Global	`bool HasStarvingArmy(int)`Description pending Description pending.
`IsAIHelperRunning`Global	`bool IsAIHelperRunning(str)` Consumes a helper-name string and returns the helper name-table membership result.
`SPFFindAreas_Quant`Global	`bool SPFFindAreas_Quant()` Advances one SPF area-finding step and returns a boolean continuation value to CKS.
`SPFCalcConnectHighRes_Quant`Global	`bool SPFCalcConnectHighRes_Quant()`Description pending Description pending.
`SPFIncreaseConnect_Quant`Global	`bool SPFIncreaseConnect_Quant()` Pushes one boolean byte for the nonzero result of [field] on the current SPF task.
`TutorialActive`Global	`bool TutorialActive()` Registered handler that pushes a zero Boolean without reading tutorial state.
`HintsActive`Global	`bool HintsActive()` Checks whether a 32-bit field reached through a shared pointer is nonzero.
`AreHintsAndTutorialsEnabled`Global	`bool AreHintsAndTutorialsEnabled()` Hints and tutorials query returns pointer field [field] nonzero or false.
`GAIKA::GetControlFlag`GAIKA	`bool GAIKA::GetControlFlag(int)` GAIKA::GetControlFlag returns whether mask 32 is set in byte [field] after bounded GAIKA record resolution.
`Hero::IsArmyOutside`Hero	`bool Hero::IsArmyOutside()` Returns whether the hero army list lacks a resolvable member with an active holder field.
`DiplAreAllied`Global	`bool DiplAreAllied(int, int)` Checks whether two players have a reciprocal diplomatic alliance. Returns false if either player number is outside the range 1 to 16, and true when both valid numbers identify the same player.

Accept this type

Member	Signature and description
`=`Global	`void =(bool&, bool)`Description pending Description pending.
`!`Global	`bool !(bool)`Description pending Description pending.
`&&`Global	`bool &&(bool, bool)`Description pending Description pending.
`\|\|`Global	`bool \|\|(bool, bool)`Description pending Description pending.
`^`Global	`bool ^(bool, bool)`Description pending Description pending.
`SetFlag`Global	`int SetFlag(int&, int, bool)` Sets or clears the requested bits in an integer passed by reference.
`Obj::AddCommand`Obj	`void Obj::AddCommand(bool, str)` creates and enqueues a named command on a target object.
`Obj::AddCommand`Obj	`void Obj::AddCommand(bool, str, point)` Adds a named command with a point as its target.
`Obj::AddCommand`Obj	`void Obj::AddCommand(bool, str, Obj)` Adds a named command with an object as its target.
`Obj::ExecDefaultCmd`Obj	`void Obj::ExecDefaultCmd(point, Obj, bool, bool)` Builds a one-receiver packet for default-command dispatch with point, target identifier and normalized flags.
`Obj::ExecCmd`Obj	`void Obj::ExecCmd(str, point, Obj, bool)` Validates an object and named command, then dispatches it with script arguments.
`Obj::SetVisible`Obj	`void Obj::SetVisible(bool)` Requests a visibility update for the object using the supplied boolean. Conditions that can affect visibility still need a practical explanation.
`Obj::SetMessengerStatus`Obj	`void Obj::SetMessengerStatus(bool)` Resolves an Obj and selects one of two virtual status operations from a boolean argument.
`Obj::SetBlind`Obj	`void Obj::SetBlind(bool)` Selects one of two virtual operations on a mask according to the supplied boolean.
`Obj::SetDebug`Obj	`void Obj::SetDebug(bool)` SetDebug normalizes its byte Boolean to a dword 0/1 and forwards it through object virtual [field].
`rollover`Global	`str rollover(Obj, bool)` Builds command rollover text from an order description, resource costs, and current affordability.
`rollover`Global	`str rollover(Obj, str, bool)` Builds object rollover text from order costs, class statistics, and optional affordability detail.
`rollover_desc`Global	`str rollover_desc(Obj, str, bool)` Composes localized rollover text and conditionally appends the secondary order description.
`Obj::SetCmdEnable`Obj	`void Obj::SetCmdEnable(bool)` SetCmdEnable writes normalized bool to object [field] only after virtual [field] returns zero.
`Query::AddDefCmd`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.
`Query::AddCommand`Query	`void Query::AddCommand(bool, str)` Dispatches factory mode zero for each live Query member and installs nonnull results with the normalized bool.
`Query::AddCommand`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.
`Query::AddCommand`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.
`Query::AddCommandOffset`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.
`Query::SetParty`Query	`void Query::SetParty(bool)` Dispatches unit-compatible query members to a Boolean-selected game virtual operation.
`Query::SetMessengerStatus`Query	`void Query::SetMessengerStatus(bool)` Dispatches a mask to eligible script objects through a virtual operation selected by the boolean argument.
`Query::SetFeeding`Query	`void Query::SetFeeding(bool)` Sets or clears a unit flag for eligible query members.
`Building::GetExitPoint`Building	`point Building::GetExitPoint(point, bool)` Resolves an exit point from a Building, an incoming point, and a boolean mode.
`Unit::SetFeeding`Unit	`void Unit::SetFeeding(bool)` Updates the resolved Unit's feeding flag from a bool argument.
`Unit::Goto`Unit	`bool Unit::Goto(point, int, int, bool, int)` 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.
`Unit::GotoEnter`Unit	`bool Unit::GotoEnter(point, int, int, bool, int)` 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.
`Unit::Goto`Unit	`bool Unit::Goto(Obj, int, int, bool, int)` 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.
`Unit::GotoAttack`Unit	`bool Unit::GotoAttack(Obj, int, bool, int)` Prepares target tracking and delegates cooperative attack routing.
`Unit::SetParty`Unit	`void Unit::SetParty(bool)` Dispatches a resolved Unit to one of two game virtual operations according to a boolean argument.
`Unit::SetCommanded`Unit	`void Unit::SetCommanded(bool)` Sets or clears bit 19 of a resolved Unit's state flags.
`Unit::SetEntering`Unit	`void Unit::SetEntering(bool)` Sets or clears bit 20 of a resolved Unit's state flags.
`Unit::SetNoselectFlag`Unit	`void Unit::SetNoselectFlag(bool)` Clears Unit [field] bit [field] and sets it when the bool argument is nonzero.
`Unit::SetMinimapFlag`Unit	`void Unit::SetMinimapFlag(bool)` Sets or clears the Unit minimap flag from a bool argument.
`Unit::SetNoAIFlag`Unit	`void Unit::SetNoAIFlag(bool)` Clears a unit flag, then sets it if the boolean argument is nonzero.
`Unit::SetSpecial`Unit	`void Unit::SetSpecial(int, bool)` 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.
`Unit::SetParryMode`Unit	`void Unit::SetParryMode(bool)` Changes parry mode when the Unit capability bit allows it.
`Hero::FormSetupAndMoveTo`Hero	`void Hero::FormSetupAndMoveTo(point, int, int, bool)` 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.
`Hero::FormSetupAndMoveTo`Hero	`void Hero::FormSetupAndMoveTo(Obj, int, int, bool)` 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.
`Hero::SetAutocast`Hero	`void Hero::SetAutocast(bool)` Clears or sets a flag in the resolved Hero according to the boolean argument.
`Druid::SetSummoningDeath`Druid	`void Druid::SetSummoningDeath(bool)`Description pending Description pending.
`Settlement::AllowCapture`Settlement	`void Settlement::AllowCapture(bool)` AllowCapture stores the zero-extended argument byte at Settlement [field].
`ObjList::AddCommand`ObjList	`void ObjList::AddCommand(bool, str)` Creates and enqueues a named command for every eligible object-list member.
`ObjList::AddCommand`ObjList	`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.
`ObjList::AddCommand`ObjList	`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.
`ObjList::AddCommandOffset`ObjList	`void ObjList::AddCommandOffset(bool, str, point)` Creates point-targeted commands for object-list members while preserving their offsets from the list center.
`ObjList::ExecDefaultCmd`ObjList	`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].
`ObjList::ExecCmd`ObjList	`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.
`ObjList::SetVisible`ObjList	`void ObjList::SetVisible(bool)` Applies a visibility boolean to an object list and to eligible nested visibility controllers of its members.
`View`Global	`void View(point, bool)` Pops a world point and lock boolean from the CKS VM stack and forwards them to the native camera-centering helper.
`EndGame`Global	`void EndGame(int, bool)` Converts a one-based player input to a zero-based index and delegates its address with the lose flag to the game virtual method.
`BlockMiniMap`Global	`void BlockMiniMap(bool)` Passes an inverted script boolean to a UI control helper and stores the original byte at Game[field].
`SetGlobalBloodlust`Global	`void SetGlobalBloodlust(bool)`Description pending Description pending.
`Sacrifice::Consume`Sacrifice	`int Sacrifice::Consume(int, int, bool)` At entry cursor S, Consume returns native status 1 without changing the cursor when both bytes S-1 and S-2 are nonzero, after storing dword[S-6] through global pointer [field].
`DiplCeaseFire`Global	`void DiplCeaseFire(int, int, bool)`Description pending Description pending.
`DiplShareView`Global	`void DiplShareView(int, int, bool)`Description pending Description pending.
`DiplShareControl`Global	`void DiplShareControl(int, int, bool)`Description pending Description pending.
`DiplShareSupport`Global	`void DiplShareSupport(int, int, bool)`Description pending Description pending.
`GAIKA::EvalNeighbors`GAIKA	`void GAIKA::EvalNeighbors(int, int, int&, int&, int&, bool)` Traverses neighboring GAIKA records, filters them, and accumulates three referenced evaluation outputs.
`GAIKA::Explore`GAIKA	`void GAIKA::Explore(int, bool)` Sets or clears bit 1 in a validated per-player GAIKA record.
`GAIKA::SetNoAttack`GAIKA	`void GAIKA::SetNoAttack(int, bool)` Updates the no-attack mask in a byte of the resolved GAIKA record.
`GAIKA::SetNoRecruit`GAIKA	`void GAIKA::SetNoRecruit(int, bool)` Updates the no-recruit mask in a byte of the mapped player record.
`SetNoAttack`Global	`void SetNoAttack(str, int, bool)`Description pending Description pending.
`SetNoRecruit`Global	`void SetNoRecruit(str, int, bool)`Description pending Description pending.
`AreaAINoRecruit`Global	`void AreaAINoRecruit(str, int, bool)`Description pending Description pending.
`AreaAINoAttack`Global	`void AreaAINoAttack(str, int, bool)`Description pending Description pending.
`AreaAIMaxPriority`Global	`void AreaAIMaxPriority(str, int, bool)` Applies priority 100 or -1 to player AI records whose points lie inside a named area.
`Unit::BestMDPos`Unit	`point Unit::BestMDPos(int, int, int, int, bool)` Ranks filtered hostile squad leaders by a circle relation count with optional friendly penalties and a distance bonus.
`SetNoAIFlag`Global	`void SetNoAIFlag(ObjList, bool)` The handler traverses the supplied ObjList.
`GAIKA::GetAIControlledUnits`GAIKA	`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.
`SetAIVar`Global	`void SetAIVar(int, int, int, bool)` SetAIVar sets or clears bit (bit argument modulo 32) in an indexed dword reached through the selected player record.
`pr`Global	`void pr(bool)` Displays true or false in the game's chat.
`SetFog`Global	`void SetFog(bool)` Normalizes one VM boolean into a sixteen-byte command payload.
`PFPersist`Global	`void PFPersist(bool)` Consumes one boolean byte and selects two helper sequences around active-pathfinder virtual slot [field].
`SetPlayerStatus`Global	`void SetPlayerStatus(int, int, str, bool)` Forwards a player, key, string and importance flag to a global status store.
`SetPlayerStatus`Global	`void SetPlayerStatus(int, int, bool)` Forwards a player, key, and importance bool to the global player-status store when present.
`GAIKA::SetControlFlag`GAIKA	`void GAIKA::SetControlFlag(int, bool)` GAIKA::SetControlFlag sets or clears byte +2 mask 32 in the mapped player record.
`Unit::SetFreedom`Unit	`void Unit::SetFreedom(bool)` Applies a bool argument to the Unit freedom state bit.
`EndGame`Global	`void EndGame(int, bool, str)` The three-argument EndGame stores its message only when the decremented player matches the computed local index.

Coverage and limits

0 / 0 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.