Settlement

Reads the settlement's current population count.

Reads the settlement's maximum population capacity.

Copies the selected settlement name bytes into a VM string result with a chained four-byte metadata trailer.

CKS-exposed Settlement::ForceAddUnit, adding a unit to the settlement's Holder bypassing capacity.

CKS-exposed Settlement::AddUnit, adding a unit to the settlement's Holder without bypassing capacity.

CKS-exposed Settlement::IsFull, comparing the settlement's Holder occupancy to capacity.

Attempts nonforced holder entry for eligible members of a supplied ObjList and returns the number of successful entries.

Returns an ObjList view of a settlement holder's unit collection for the Settlement::Units registration.

CKS-exposed Settlement::UnitsCount, returning the settlement's Holder member count at [field].

Returns the capacity at the Settlement's resolved Holder [field] field.

Settlement::health resolves Settlement[field] and returns the linked Holder health field serialized at [field].

Settlement::max_health resolves Settlement[field] and returns the linked Holder maximum-health field serialized at [field].

The registered stamina getter returns a nested registry dword at [field].

The registered max_stamina getter returns a nested registry dword at [field].

Reads raw loyalty and returns it scaled down by 10 for display.

Writes raw loyalty directly from a 0-100 input, bypassing the change accumulator.

Subtracts a scaled non-negative amount from the loyalty change accumulator.

Returns current gold from the settlement's registered resource store.

Returns maximum gold from the settlement's registered resource store.

Returns current food from the settlement's registered resource store.

Returns maximum food from the settlement's registered resource store.

Sets current gold on the resource store to an absolute value, clamped to the store's maximum gold.

Sets current food on the resource store to an absolute value, clamped to the store's maximum food.

Writes current population, clamped to at most the settlement's maximum population.

Applies an unconditional signed delta to current population, with no guard or clamp.

CKS AddToMaxPopulation adapter that adds a dword delta after guarded receiver resolution.

Converts the settlement's owning PlayerInfo identifier to the one-based scripting player number.

Changes the settlement's owner. When the player differs from the current one, the stored gold moves to the new owner's statistics and every building of the settlement gets the new owner.

CKS native primitive that tests whether an Obj handle is valid; used generically, including on settlement handles.

CKS loan adapter that performs wrapped signed scaling of settlement offset [field].

CKS SetLoan adapter that overwrites settlement offset [field] with wrapped signed scaling and calls a helper.

Returns the registry handle stored in the settlement's central-building field.

CKS FoodProduction adapter that reads the settlement dword at offset [field].

CKS GoldProduction adapter that reads the settlement dword at offset [field].

Writes the settlement's food production rate unconditionally.

Writes the settlement's gold production rate unconditionally.

Settlement::Buildings returns an ObjList view at settlement [field], or an allocated empty list for an invalid settlement handle.

Find consumes str then Settlement, compares template string bytes and returns the first equal member handle.

CKS FirstBldClass adapter returning a copy of the Settlement string at [field].

Description pending.

AllowCapture stores the zero-extended argument byte at Settlement [field].

Builds an ObjList of settlement-associated objects matching a requested script class.

Delegates to a random building with point lookup using point type 12. The meaning of that type is not documented here.

Delegates to a random building with point lookup using point type 13. The meaning of that type is not documented here.

Delegates to a random building with point lookup using point type 14. The meaning of that type is not documented here.

Delegates to a random building with point lookup using point type 15. The meaning of that type is not documented here.

Selects the first eligible settlement member with the greatest strictly positive signed damage accumulator and template mask 4096.

ClearDamageTaken writes zero to dword [field] of every iterated settlement member.

Searches settlement type12 points and selects the first strict minimum of a transformed integer distance metric.

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.

Settlement::PopulationDied resolves the settlement handle and returns the integer count at offset [field], returning 0 on failure.

Adds an amount to a player-level gold-converted accounting counter without mutating the resource store.

CKS GoldSpent adapter that adds an amount to a selected structure's dword at offset [field].

GetSentry calls [field] with field [field] minus one when that field is signed positive, returning integer one; otherwise it returns zero.

PutSentry calls [field] with wrapped [field] plus one and then increments dword [field].

Decrements one of two settlement sentry counters with a zero floor on the fallback field.

GetNumSentries and GetMaxSentries copy the resolved Settlement dwords [field] and [field] respectively, with zero fallback.

AddSentries adds its integer argument modulo 2^32 to [field], then calls [field] with wrapped [field] plus the same argument.

GetNumSentries and GetMaxSentries copy the resolved Settlement dwords [field] and [field] respectively, with zero fallback.

Settlement::AddMaxSentries adds its signed integer argument directly to the resolved Settlement's dword at [field].

Description pending.

Delegates wagon creation with food mode one and returns a Wagon handle or sentinel.

Resolves a Settlement and delegates the amount to helper [field], returning a Wagon handle or sentinel.

Calls the linked building spawn helper with the script amount and mode values one, one, then returns a Wagon handle or null.

Calls the linked building spawn helper with the script amount and mode values zero, one, then returns a Wagon handle or null.

CreateShip constructs a class-named object, applies owner and placement calls, attempts forced holder entry, and restores temporary global state on its normal valid-receiver path.

SendMule and SendBoat call the same helper with mode zero or one when their linked target passes a relation-bit gate, otherwise clearing that target id.

SendMule and SendBoat call the same helper with mode zero or one when their linked target passes a relation-bit gate, otherwise clearing that target id.

Description pending.

Description pending.

UnloadWagon adds the wagon quantity to the linked settlement resource dword and clamps the wrapping sum by a signed comparison to its capacity.

Follows a fixed chain of settlement registry references and returns the final settlement handle.

Compiles the requested script with a Settlement argument declaration and dispatches it after successful compilation.

Sums a native evaluation value across live members of the settlement holder.

Counts settlement members whose class inherits from Tower.

NumTowersBroken counts live Tower descendants whose broken-state field equals 3.

Counts live settlement members that can be converted to Gate.

Counts settlement members convertible to Gate whose original-object broken state is 3.

EvalDefences computes a presence score of 300 or 1000 for towers plus 4000 for gates.

CKS adapter with unreconciled twenty-byte native input consumption that forwards an extra selector to class lookup and cached point selection.

BestGate selects the first Gate with a strictly smaller native position score plus signed field [field] divided by five.

OpenAllGates traverses gate members and submits opengate commands for gates whose target-state field is not 1.

IdleAllGates invokes gate virtual slot [field] with argument 1 when its current string does not equal idle.

Description pending.

Calls the BaseTownhall-family predicate on a resolved settlement.

Returns the village-class predicate for a valid Settlement.

Tests whether the supplied settlement object inherits from the Outpost script class.

Description pending.

Returns whether the linked object template inherits BaseShipyard, including the ordinary first-use literal lookup and cache path.

Settlement IsAlly resolves the settlement owner and tests bit zero of the indexed player-relation table entry.

Returns the inverse low-bit predicate from a player relation table for a valid settlement.

Settlement::IsOwn returns true only when a valid Settlement owner's zero-based index equals idPlayer minus one.

Returns true when the resolved settlement has linked owner code 14 or 15.

Description pending.

Returns a numeric relation code from the associated owner index and the queried player matrix bit.

Settlement::MaxPopulation resolves a Settlement and returns its dword at [field], with zero as the invalid-object fallback.

Counts same-owner buildings of a requested class that are associated with the specified settlement.

Description pending.

Selects an eligible barracks in the settlement with the lowest score accepted by its selection procedure. Returns an invalid reference if no candidate is selected.

Returns the first settlement member whose template derives from a requested class name.

Finds a unit linked to a named research descriptor and returns its Building handle.

Tests positive signed resource quotients after subtracting the keyed reservation from available gold.

Resolves a Settlement and named command, then returns whether a cost check succeeds.

Compares the requested count with the signed native command affordability count.

Returns the signed native command affordability count after selecting reservation treatment.

CKS scripting primitive reporting whether a settlement is permitted to begin researching an upgrade that is not already researched or in progress.

Resolves a Settlement and named upgrade, then conditionally submits a research command.

Returns a signed percentage of army expenditure since the reservation snapshot.

Description pending.

Updates keyed reservation percent and command, preserving or initializing the army snapshot by branch.

Returns the parsed army expenditure key on a valid receiver and omits the integer output on an invalid one.

Accumulates an amount in a per-game, per-settlement and per-player persistent army-spending counter.

Returns the parsed technology expenditure key on a valid receiver and omits the integer output on an invalid one.

Adds a signed amount with 32-bit wrap to the keyed technology expenditure value.

Tests technology expenditure plus adjusted command cost against a signed percentage budget.

Settlement WaterLsa and LandLsa return unsigned linked-object words at [field] or [field] when its template inherits BaseShipyard, otherwise returning zero.

Settlement WaterLsa and LandLsa return unsigned linked-object words at [field] or [field] when its template inherits BaseShipyard, otherwise returning zero.

Description pending.

Description pending.

Description pending.

CKS handler that invokes the tactic-selection script for a Settlement and player index.

CKS handler that forwards a tactic ID and resolved settlement to the player-AI tactic-task starter.

CKS property handler that returns the settlement's current tactic ID after checking whether its task slot remains active.

Returns the global AI table word associated with a Settlement.

CancelSupply resolves stoptribute by name and forwards a seven-dword packet beginning with a partially initialized linked-object id to the native dispatch helper.

Description pending.

Scans eligible settlement members and requests one repair command for each member that provides that command and passes the admission checks.

Builds an ObjList and delegates Settlement tactical recruitment through TSH_RecruitArmy.vs and the universal command path.

Filters settlement building handles into an ObjList of barracks candidates.

Filters settlement building handles into an ObjList of arena candidates.

Builds an ObjList of eligible settlement members derived from the race-specific temple class.

Selects a settlement member derived from BaseArena by the minimum unsigned adjusted score stored in an implementation field.

Builds an ObjList and delegates Settlement tactical recruitment through TSH_ArenaRecruit.vs and the universal command path.

Dispatches a hero recruitment strategy script for a Settlement.

Applies a TSH_Research command script with a Settlement, research name and temporary result reference.

Builds an ObjList and delegates Settlement tactical recruitment through TSH_TempleRecruit.vs and the universal command path.

Chooses the lowest-scoring eligible race-specific temple in a settlement.

Compares an associated settlement object's string to TTent and returns a one-byte boolean.

Looks up the named AI script in the owning player's context and, if found, invokes it with the settlement as its context.

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

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

Returns the first settlement whose name matches the supplied text.

Follows a fixed chain of settlement registry references and returns the final settlement handle.

Returns the settlement handle attached to a GAIKA record, or a null handle.

Description pending.

IdxToSet returns the handle ID from an indexed global-map settlement pointer, or a null handle for an invalid or empty slot.

Description pending.

Description pending.

NearestStronghold point overload selects the unfiltered BaseTownhall search.

NearestSet four-argument overload forwards the class, decremented player and supplied relation mask.

NearestSet three-argument overload forwards the class, decremented player and fixed mask one.

NearestSet point overload searches the Building central-building class without player filtering.

Returns the settlement associated with the currently selected settlement object, or the null handle.

Description pending.

Description pending.

Description pending.

Description pending.

Description pending.

Description pending.

CKS native primitive that writes a string value under a key into a settlement's Env key-value store.

Formats a settlement-scoped environment path and writes a decimal integer value.

Builds a settlement-scoped environment path and returns the string obtained from the environment lookup helper.

EnvReadInt builds a settlement property path and reads its integer value.

Description pending.

Description pending.

Description pending.

Parses command-definition triples and dispatches settlement property writes.

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.

SetToIdx reads the resolved Settlement slot-index field.

CKS scripting primitive evaluating whether a technology or upgrade has been researched, supporting both settlement-anchored and player-direct overloads.

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.

Tries indexed AI candidates and dispatches a settlement fallback into the resolved integer-array destination.