CKS TYPECKS reference

int

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

0 members315 return it501 accept it

Members

0

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

315
MemberSignature and description
+=Globalint +=(int&, int)Description pending

Description pending.

-=Globalint -=(int&, int)Description pending

Description pending.

&Globalint &(int, int)Description pending

Description pending.

|Globalint |(int, int)Description pending

Description pending.

+Globalint +(int, int)Description pending

Description pending.

-Globalint -(int, int)Description pending

Description pending.

-Globalint -(int)Description pending

Description pending.

*Globalint *(int, int)Description pending

Description pending.

/Globalint /(int, int)Description pending

Description pending.

%Globalint %(int, int)Description pending

Description pending.

absGlobalint abs(int)

Returns the absolute value of an integer.

MINGlobalint MIN(int, int)

Returns the smaller of the two values.

MAXGlobalint MAX(int, int)

Returns the larger of the two values.

CLAMPGlobalint CLAMP(int, int, int)

Limits a value to the supplied lower and upper bounds.

IntGlobalint Int(float)

Converts the binary64 input to an integer through truncation and retains the 32-bit result.

StrCmpGlobalint StrCmp(str, str)

Compares two strings. Returns a negative number, zero or a positive number; it is not a boolean equality check.

FindChrPosGlobalint FindChrPos(str, int)

Returns the position of the first matching character, or -1 if it is not found. The position's indexing convention is not specified here.

GetChrGlobalint GetChr(str, int)

The final int is popped before the eight-byte str.

StrLenGlobalint StrLen(str)

Returns the length of a CKS string in bytes.

Str2IntGlobalint Str2Int(str)

Converts a string to an integer. Conversion edge cases are not described here yet.

SetFlagGlobalint SetFlag(int&, int, bool)

Sets or clears the requested bits in an integer passed by reference.

point::xpointint& point::x()

Returns the horizontal coordinate of the point.

point::ypointint& point::y()

The two shared component adapters retain an eight-byte encoded reference pair, with a zero or four-byte adjustment to its second dword.

point::xpointint point::x()

Returns the horizontal coordinate of the point.

point::ypointint point::y()

Returns the vertical coordinate of the point.

point::Lenpointint point::Len()

Returns the integer square root of the sum of the squared coordinates.

point::Distpointint point::Dist(point)

returns the integer square root of dx squared plus dy squared.

DistGlobalint Dist(point, point)

returns the integer square root of dx squared plus dy squared.

rect::leftrectint rect::left()

Returns the first dword of a rect value.

rect::toprectint rect::top()

Returns the second dword of a rect value.

rect::rightrectint rect::right()

Returns the third dword of a rect value.

rect::bottomrectint rect::bottom()

Returns the fourth dword of a rect value.

rect::widthrectint rect::width()

Returns the inclusive width: right minus left plus one.

rect::heightrectint rect::height()

Returns the height of the rectangle, including its boundaries.

rect::leftrectint& rect::left()

Returns an eight-byte reference pair unchanged for point x and rect left.

rect::toprectint& rect::top()

Preserves the first dword of an encoded reference pair and adds four to its second dword for point y and rect top.

rect::rightrectint& rect::right()

Advances a rect reference address by eight bytes.

rect::bottomrectint& rect::bottom()

Advances a rect reference address by twelve bytes.

[Globalint& [(IntArray&, int)Description pending

Description pending.

IntArray::sizeIntArrayint IntArray::size()

IntArray size returns -1 for a null begin pointer and otherwise returns the four-byte slot span minus one.

IntArray::findIntArrayint IntArray::find(int)Description pending

Description pending.

StrArray::sizeStrArrayint StrArray::size()

StrArray size returns native span count minus one.

StrArray::findStrArrayint StrArray::find(str)Description pending

Description pending.

StrMap::sizeStrMapint StrMap::size()

StrMap size returns native count field.

GetClassRaceGlobalint GetClassRace(str)

Returns the resolved named class dword at [field], or -1 when lookup returns null.

Obj::raceObjint Obj::race()

Obj::race returns the dword at [field] of the resolved object's template and returns zero for an invalid object.

Obj::armor_slashObjint Obj::armor_slash()

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::armor_pierceObjint Obj::armor_pierce()

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::healthObjint Obj::health()

Returns the object's current health, or zero for an invalid object.

Obj::staminaObjint Obj::stamina()

Obj::stamina returns the resolved object's four-byte field at [field] or zero for an invalid handle.

Obj::maxhealthObjint Obj::maxhealth()

Returns the object's maximum health, or zero for an invalid object.

Obj::maxstaminaObjint Obj::maxstamina()

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::sightObjint Obj::sight()

Obj::sight returns the 32-bit value at resolved object [field] and returns zero for an invalid object.

Obj::damageObjint Obj::damage()

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::attackObjint Obj::attack()

Shared native accessor that returns object dword [field] for both damage and attack script members.

Obj::damage_typeObjint Obj::damage_type()

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::rangeObjint Obj::range()

Obj::range returns a resolved object's dword at [field] and returns zero for an invalid Obj handle.

Obj::min_rangeObjint Obj::min_range()

Obj combat accessors return dwords at [field], [field], [field], [field] and [field], with zero on failed resolution.

Obj::radiusObjint Obj::radius()

Obj::radius returns the dword at [field] of the resolved object's template and returns zero for an invalid object.

Obj::GetStaminaDecTimeObjint Obj::GetStaminaDecTime()

GetStaminaDecTime returns max(signed object [field], zero) after an unguarded field dereference.

Obj::CmdCountObjint Obj::CmdCount()

Returns the command count at object [field] when the resolved object is live, otherwise zero.

Obj::CmdCountObjint Obj::CmdCount(str)

Counts queued commands with the specified name.

Obj::DistToObjint Obj::DistTo(point)

Obj::DistTo computes distance from an Obj to a point and subtracts its template offset.

Obj::DistToObjint Obj::DistTo(Obj)

Returns the distance between the edges of two objects. The result retains its sign; the distance unit is not specified here.

Obj::playerObjint Obj::player()

Obj::player reads the resolved object's owner record index, adds one, and returns minus one for an invalid object.

Obj::cmddelayObjint Obj::cmddelay()

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.

Obj::GetAnimTimeObjint Obj::GetAnimTime(int)

GetAnimTime decrements its integer index and reads selected descriptor entry [field], returning zero for missing descriptors.

Obj::TimeToActionMomentObjint Obj::TimeToActionMoment()

Wraps an object action-window query and returns the remaining time to its action moment.

Obj::TimeToAnimFinishObjint Obj::TimeToAnimFinish()

Returns the positive difference between animation finish time and the object's clock.

Obj::GetAnimObjint Obj::GetAnim()

Obj::GetAnim returns Obj [field] plus one when nonnegative and zero otherwise.

Obj::RemoveItemsOfTypeObjint Obj::RemoveItemsOfType(str)

Removes all inventory items with the specified type name and returns the number removed.

Obj::GetItemIndexObjint Obj::GetItemIndex(Item)

GetItemIndex increments the virtual index result.

Obj::items_countObjint Obj::items_count()

items_count returns virtual slot [field] or zero.

Obj::free_item_slotsObjint Obj::free_item_slots()

free_item_slots subtracts two virtual values without clamping.

Obj::item_countObjint Obj::item_count()

Returns the receiver item count through virtual slot [field], or zero for an invalid handle.

Obj::max_itemsObjint Obj::max_items()

Returns the resolved object's item-capacity value through virtual slot [field].

cmdcost_goldGlobalint cmdcost_gold()

Returns the cached gold cost or obtains it from the current script command context.

cmdcost_foodGlobalint cmdcost_food()

Returns the current food command cost from the cache or active order.

cmdcost_popGlobalint cmdcost_pop()

Returns the cached population cost or obtains it from the current script command context.

cmdcost_staminaGlobalint cmdcost_stamina()

Returns the cached stamina cost or obtains it from the current script command context.

GetPlayerRaceGlobalint GetPlayerRace(int)Description pending

Description pending.

Obj::_LastSelectionTimeObjint Obj::_LastSelectionTime()

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

GetGroupSizeGlobalint GetGroupSize(str)

Looks up a named group and returns its list count or zero.

Query::DamageQueryint Query::Damage(int)

Calls virtual damage slot [field] on eligible Query members and counts nonzero call results.

Query::countQueryint Query::count()

Returns the result container's count for a resolved Query, or zero for an invalid receiver.

Query::InHolderQueryint Query::InHolder(str)

Counts the query's units that are inside the named settlement.

Building::GetGlobalSpellBuildingint Building::GetGlobalSpell()

Looks up the first global-spell vector entry associated with a resolved town hall and pushes its initial dword.

Building::GetSoothingRainObjectsBuildingint Building::GetSoothingRainObjects()

Counts buildings found by the SoothingRain map scan while passing zero to its gold mutator.

Building::StonehengeNumControllingMagesBuildingint Building::StonehengeNumControllingMages()

Returns a counter from a Stonehenge-centered map scan.

Building::minlevelBuildingint Building::minlevel()

Returns the Building template dword registered as Building::minlevel.

Building::levelperitemBuildingint Building::levelperitem()

Returns the Building template dword registered as Building::levelperitem.

Building::CountMagesBuildingint Building::CountMages()

Returns a count of eligible script objects in a Stonehenge-centered circle.

Building::GetNumSentrySlotsBuildingint Building::GetNumSentrySlots()

Building::GetNumSentrySlots returns the sentry slot count dword at template [field] and lacks a safe fallback for invalid handles.

Catapult::AttackWaitCatapultint Catapult::AttackWait()Description pending

Description pending.

Unit::speedUnitint Unit::speed()

Reads the linked speed dword for a Unit handle.

Unit::speed_factorUnitint Unit::speed_factor()

Unit[field] defaults to 100, is exposed by the speed-factor getter/setter, and divides base step duration as a percentage.

Unit::staminaUnitint Unit::stamina()

Reads the stamina dword for a Unit handle.

Unit::userUnitint Unit::user()

Reads the user dword for a Unit handle.

Unit::foodUnitint Unit::food()

Reads the food dword for a Unit handle.

Unit::maxfoodUnitint Unit::maxfood()

Reads the linked maximum food dword for a Unit handle.

Unit::maxstaminaUnitint Unit::maxstamina()

Reads the linked maximum stamina dword for a Unit handle.

Unit::experienceUnitint Unit::experience()

Scripting VM bridge reading the cumulative raw experience counter directly from unit [field].

Unit::levelUnitint Unit::level()

Scripting VM bridge calling virtual method vtable[[field]]() to obtain effective unit or hero level.

Unit::inherentlevelUnitint Unit::inherentlevel()

Scripting VM bridge computing unit inherent level on-the-fly from raw experience via LevelFromExp.

Unit::TimeWithoutWalkingUnitint Unit::TimeWithoutWalking()

Unit::TimeWithoutWalking returns zero for sentinel -1 at Unit [field], otherwise subtracting it from the dword reached through Unit [field].

Unit::TimeWithoutAttackUnitint Unit::TimeWithoutAttack()

Unit::TimeWithoutAttack returns the 32-bit subtraction [[shared state][field]] - [Unit[field]], with zero as the invalid-unit fallback.

Unit::PathToUnitint Unit::PathTo(point, int, int)

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

Unit::PathToUnitint Unit::PathTo(Obj, int, int)

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

max_train_1_levelGlobalint max_train_1_level()

max_train_1_level pushes the dword stored at [field].

Unit::PathLeftUnitint Unit::PathLeft()

Returns a value from the Unit's [field] controller virtual method, or sentinel 900000000 when unavailable.

Unit::GetStaminaDecTimeUnitint Unit::GetStaminaDecTime()

Returns the nonnegative part of a resolved Unit's signed stamina decrement time field.

GetExperienceModifierGlobalint GetExperienceModifier(int)

GetExperienceModifier returns the selected player record dword at [field].

Unit::GetParryModeUnitint Unit::GetParryMode()

Unit[field] bit 0 gates parry support, while Unit[field] stores the Boolean mode changed by SetParryMode and returned by GetParryMode.

ExpFromLevelGlobalint ExpFromLevel(int)

ExpFromLevel replaces the input dword with the global dword at [field].

LevelFromExpGlobalint LevelFromExp(int)

Converts an experience dword using an inline signed threshold scan and returns the resulting level dword.

Hero::TimePastLastAttackHeroint Hero::TimePastLastAttack()

Returns the current game tick value minus the Hero's stored last-attack tick, or the current value when the Hero handle is invalid.

Hero::maxarmyHeroint Hero::maxarmy()

Reads the Hero army capacity field for this function.

Hero::FormRadiusHeroint Hero::FormRadius()

For a valid Hero, FormRadius calls [field] on Hero [field] and pushes its four-byte result; an invalid Hero yields zero.

Hero::FormPathLeftHeroint Hero::FormPathLeft()

For a valid Hero with a nonnull formation path object at Hero [field] then [field], FormPathLeft returns the result of that object’s virtual method at vtable [field]; otherwise it returns zero.

HeroSkillIdGlobalint HeroSkillId(str)

Consumes a skill-name string and returns the index found by a case-sensitive descriptor-name scan.

Hero::GetSkillHeroint Hero::GetSkill(int)

CKS scripting bridge returning current skill level for a given skill index.

Hero::AvailableSkillPointsHeroint Hero::AvailableSkillPoints()

CKS scripting bridge resolving hero pointer and returning unspent available skill points.

_ZoomMapLastShownTimeGlobalint _ZoomMapLastShownTime()

CKS primitive bound to "_ZoomMapLastShownTime", querying the game tick when the tactical map was last opened.

Wagon::amountWagonint Wagon::amount()

Wagon::amount returns the resolved object's 32-bit field at [field], or zero for an invalid handle.

Wagon::restypeWagonint Wagon::restype()

Wagon restype returns the carried resource selector at [field], with zero on invalid resolution.

Wagon::loyaltyWagonint Wagon::loyalty()

Wagon loyalty returns signed dword [field] divided by ten with truncation toward zero.

Settlement::populationSettlementint Settlement::population()

Reads the settlement's current population count.

Settlement::max_populationSettlementint Settlement::max_population()

Reads the settlement's maximum population capacity.

Settlement::AddUnitsSettlementint Settlement::AddUnits(ObjList)

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

Settlement::UnitsCountSettlementint Settlement::UnitsCount()

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

Settlement::max_unitsSettlementint Settlement::max_units()

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

Settlement::healthSettlementint Settlement::health()

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

Settlement::max_healthSettlementint Settlement::max_health()

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

Settlement::staminaSettlementint Settlement::stamina()

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

Settlement::max_staminaSettlementint Settlement::max_stamina()

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

Settlement::loyaltySettlementint Settlement::loyalty()

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

Settlement::goldSettlementint Settlement::gold()

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

Settlement::max_goldSettlementint Settlement::max_gold()

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

Settlement::foodSettlementint Settlement::food()

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

Settlement::max_foodSettlementint Settlement::max_food()

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

Settlement::playerSettlementint Settlement::player()

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

Settlement::loanSettlementint Settlement::loan()

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

Settlement::FoodProductionSettlementint Settlement::FoodProduction()

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

Settlement::GoldProductionSettlementint Settlement::GoldProduction()

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

Settlement::PopulationDiedSettlementint Settlement::PopulationDied()

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

Settlement::GetSentrySettlementint Settlement::GetSentry()

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

Settlement::GetNumSentriesSettlementint Settlement::GetNumSentries()

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

Settlement::GetMaxSentriesSettlementint Settlement::GetMaxSentries()

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

Settlement::EvalSentriesSettlementint Settlement::EvalSentries()Description pending

Description pending.

ItemHolder::countItemHolderint ItemHolder::count()

Returns receiver virtual slot [field] or zero for an invalid holder.

ObjList::countObjListint ObjList::count()

ObjList::count returns the 32-bit member count at resolved ObjList object offset [field].

ObjList::InHolderObjListint 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.

EnvReadIntGlobalint EnvReadInt(str)

Pops a managed key string and pushes the 32-bit result of the environment integer helper.

EnvReadIntGlobalint EnvReadInt(Settlement, str)

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

EnvReadIntGlobalint EnvReadInt(Building, str)

Formats a building-scoped environment path and returns the integer produced by its reader helper.

EnvReadIntGlobalint EnvReadInt(int, str)

Formats a player-scoped environment path and returns the integer reader result.

GetSpeedGlobalint GetSpeed()

GetSpeed reads game field1244 with a null fallback.

IRunGlobalint IRun(str)

Adapts the verified global IRun overload with 0 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int)

Adapts the verified global IRun overload with 1 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int)

Adapts the verified global IRun overload with 2 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int, int)

Adapts the verified global IRun overload with 3 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int, int, int)

Adapts the verified global IRun overload with 4 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int, int, int, int)

Adapts the verified global IRun overload with 5 integer arguments to named script compilation and dispatch.

GetConstGlobalint GetConst(str)

Looks up and returns an integer gameplay configuration constant from the global constants table by name string.

randGlobalint rand(int)

rand passes a zero-based bound to the game RNG virtual method.

GetTimeGlobalint GetTime()

GetTime takes no arguments and pushes the 32-bit game clock counter at [shared state][field], the same field that CKS Clock divides by 1000 to obtain seconds.

SelAvgLevelGlobalint SelAvgLevel()

SelAvgLevel averages eligible primary-selection values.

SelAvgFoodGlobalint SelAvgFood()

Computes a rounded average of the food-related field across eligible selected units and nested members.

SelAvgStaminaGlobalint SelAvgStamina()

SelAvgStamina averages eligible direct and nested values.

SelAvgArmorGlobalint SelAvgArmor()

Computes a rounded average of armor across eligible selected units and nested members.

SelAvgDamageGlobalint SelAvgDamage()

SelAvgDamage computes an unsigned rounded selection average.

SelHealthGlobalint SelHealth()

Adds together current health values for the selection, including nested objects.

SelMaxHealthGlobalint SelMaxHealth()

Adds together maximum health values for the selection, including nested objects.

GetDifficultyGlobalint GetDifficulty()

GetDifficulty copies the dword at pointer field [field].

GetTeamMilitaryScoreGlobalint GetTeamMilitaryScore(int)Description pending

Description pending.

GetTeamPowerScoreGlobalint GetTeamPowerScore(int)Description pending

Description pending.

GetTeamAchievementsScoreGlobalint GetTeamAchievementsScore(int)Description pending

Description pending.

GetTeamOverallScoreGlobalint GetTeamOverallScore(int)

Calculates and returns the average composite score across all players on a specified team.

SelectionGoldGlobalint SelectionGold()

SelectionGold sums selected wagon subtype-zero amounts.

SelectionFoodGlobalint SelectionFood()

SelectionFood sums selected wagon subtype-one amounts.

AreaDistToGlobalint AreaDistTo(point, str)

Computes a nonnegative area distance value after name resolution.

Sacrifice::ConsumeSacrificeint 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].

Ship::UnitsCountShipint Ship::UnitsCount()

Ship[field] is a Holder handle, and this function returns that Holder's current occupancy at [field].

Ship::UnitsMaxShipint Ship::UnitsMax()

Ship[field] is a Holder handle, and this function returns that Holder's capacity at [field].

Ship::NumUnitsToBoardShipint Ship::NumUnitsToBoard()

Ship::NumUnitsToBoard returns the dword at resolved Ship[field], the count component of its [field] pending container, or zero when the handle cannot resolve.

GetUseCountGlobalint GetUseCount()

Returns a field from the active item's script context or zero when context resolution fails.

Item::use_countItemint Item::use_count()

Item::use_count resolves an Item, resolves the registry slot stored at Item [field], and returns the secondary object's dword at [field].

Item::custom_dataItemint Item::custom_data()

Item::custom_data re-resolves the Item wrapper's registered base object through [field] and returns its dword at [field].

Flying::zFlyingint Flying::z()

Resolves a Flying handle and returns the associated height calculation.

GetTerrainHeightGlobalint GetTerrainHeight(point)

Clamps a world point to map bounds and samples terrain height there.

GetAngleByDirGlobalint GetAngleByDir(point)

GetAngleByDir forms a wrapped unsigned squared length and applies a finite-path asin/quadrant pipeline before low-dword integer conversion.

MapSizeGlobalint MapSize()

Implements this function, returning the global map maximum X bound.

Unit::GetAnimDurationUnitint Unit::GetAnimDuration(int)Description pending

Description pending.

NumSquadsGlobalint NumSquads(int)

NumSquads returns a per-player squad pointer-span length divided by four for input IDs 1 through 16 and zero otherwise.

Squad::PlayerSquadint Squad::Player()

Handler for this function, int Squad::Player(Squad): decodes the player from the Squad value.

Squad::NoSquadint Squad::No()

Squad No returns the twelve-bit packed squad index.

Squad::EvalSquadint Squad::Eval()

CKS scripting bridge returning the cached combat evaluation sum of a squad from offset [field].

Squad::StateSquadint Squad::State()

Returns the squad's numeric state code as an integer obtained from an unsigned 16-bit value.

Squad::StateTimeSquadint Squad::StateTime()

Squad StateTime returns game [field] minus resolved squad record [field].

Squad::SizeSquadint Squad::Size()

CKS scripting bridge and internal accessor returning the active unit count of a squad from offset [field].

Squad::GetFlagsSquadint Squad::GetFlags()Description pending

Description pending.

Squad::LastFightTimeSquadint Squad::LastFightTime()Description pending

Description pending.

Squad::healthSquadint Squad::health()

Computes current health by summing the [field] dword of each non-null registry object in the resolved squad member traversal.

Squad::maxhealthSquadint Squad::maxhealth()

Computes maximum health by summing the [field] dword of each non-null registry object in the resolved squad member traversal.

Squad::foodSquadint Squad::food()

Sums food dwords of resolved squad members.

Squad::FoodComingSquadint Squad::FoodComing()

Sums food amounts of player wagons whose command target belongs to the requested squad.

Squad::EvalAttachSquadint Squad::EvalAttach(Unit, int)

Scores a candidate unit using squad size, affiliation equality and its virtual level result.

Squad::CountSquadint Squad::Count(str)

Counts squad members whose class template matches a named ancestry chain.

GAIKACountGlobalint GAIKACount()

Returns the number of GAIKA records in the shared AI record range.

GAIKA::IDGAIKAint GAIKA::ID()

Leaves the four-byte GAIKA receiver slot unchanged so that its value becomes the integer result.

GAIKA::TypeGAIKAint GAIKA::Type()

GAIKA::Type returns integer 0 or 1 according to whether global GAIKA record dword [field] is nonzero.

GAIKA::EvalGAIKAint GAIKA::Eval(int)

The two-argument Eval adds squad [field] values selected by category mask, with a separately gated attached-settlement contribution.

GAIKA::EvalGAIKAint GAIKA::Eval(int, int)

The three-argument Eval gates category-matching cached evaluation sums on relation mask 1 for the selected player.

GAIKA::EvalGAIKAint GAIKA::Eval(int, int, int)

Evaluates cached squad and conditional guard contributions under presence, player and relation controls.

GAIKA::GetPriorityGAIKAint GAIKA::GetPriority(int)Description pending

Description pending.

GAIKA::GetLAIKAGAIKAint GAIKA::GetLAIKA(int)

GetLAIKA returns the zero-extended mapping word indexed by low16 GAIKA in the selected player's AI table, with zero for locally rejected cases.

GAIKA::CalcPriorityGAIKAint GAIKA::CalcPriority(int)

Calls a selected priority script with a temporary referenced integer and returns its nonnegative contribution under the native dispatch gate.

GAIKA::LastSeenGAIKAint GAIKA::LastSeen(int)

GAIKA::LastSeen returns dword [field] of the mapped player record, or integer zero on explicit resolution failure.

GAIKA::GetDistToArmiesGAIKAint GAIKA::GetDistToArmies(int)

Reduces helper distances over qualifying squads from sixteen player slots, with a 32000 initial cap.

GAIKA::CountGAIKAint GAIKA::Count(int, int, str)

The string Count returns the number of selected squad members whose class template inherits from the requested class descriptor, with a gated Sentry contribution.

GAIKA::MinNeedGAIKAint GAIKA::MinNeed(int, int, int, int)

Scales a scripted army-need value by an AI table divisor.

GAIKA::MaxNeedGAIKAint GAIKA::MaxNeed(int, int, int, int)

Scales a helper result by the selected per-player GAIKA divisor with unsigned division and a minimum nonzero quotient.

GAIKA::RecruitGAIKAint GAIKA::Recruit(int, int, int, int)Description pending

Description pending.

GAIKA::GetStratGAIKAint GAIKA::GetStrat(int)

Delegates a GAIKA value and player index to a strategy-script helper and returns its low-word result.

GAIKA::StratRunningGAIKAint GAIKA::StratRunning(int)Description pending

Description pending.

GAIKA::NeighborsGAIKAint GAIKA::Neighbors()

GAIKA::Neighbors returns global GAIKA record word [field] as a four-byte integer, or zero on explicit resolution failure.

Settlement::UnitsInHolderEvalSettlementint Settlement::UnitsInHolderEval()

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

SquadList::SizeSquadListint SquadList::Size()

Returns the backing collection count for a resolved active SquadList cursor, otherwise zero.

SquadList::EvalSquadListint SquadList::Eval()

Returns the native evaluation helper result for a resolved active list, otherwise zero.

SquadList::TrainSquadListint SquadList::Train(int, int, int, int, Obj)

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

Settlement::NumTowersSettlementint Settlement::NumTowers()

Counts settlement members whose class inherits from Tower.

Settlement::NumTowersBrokenSettlementint Settlement::NumTowersBroken()

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

Settlement::NumGatesSettlementint Settlement::NumGates()

Counts live settlement members that can be converted to Gate.

Settlement::NumGatesBrokenSettlementint Settlement::NumGatesBroken()

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

Settlement::EvalDefencesSettlementint Settlement::EvalDefences()

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

Settlement::GetRelSettlementint Settlement::GetRel(int)

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

Settlement::MaxPopulationSettlementint Settlement::MaxPopulation()

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

Settlement::SupplyCountSettlementint Settlement::SupplyCount(str)

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

SettlementCountGlobalint SettlementCount(point, int, str)

SettlementCount counts class-matching settlements below a strict unsigned metric threshold.

AIRunGlobalint AIRun(str)

Starts a named AI script task in the current player context and returns its task identifier or -1.

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

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

SetToIdxGlobalint SetToIdx(Settlement)

SetToIdx reads the resolved Settlement slot-index field.

MaxSetIdxGlobalint MaxSetIdx()

Handler for this function, int MaxSetIdx(): returns the number of settlement slots.

AIGetPlayerGlobalint AIGetPlayer()

Returns the current script AI player index plus one.

GetCmdStaminaCostGlobalint GetCmdStaminaCost(str)

Resolves the order descriptor for a command name string and returns its required stamina cost from offset [field].

Settlement::MaxAffordCountSettlementint Settlement::MaxAffordCount(str)

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

Settlement::ReserveSettlementint Settlement::Reserve()

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

Settlement::GoldSpentOnArmySettlementint Settlement::GoldSpentOnArmy()

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

Settlement::GoldSpentOnTechSettlementint Settlement::GoldSpentOnTech()

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

Settlement::WaterLsaSettlementint Settlement::WaterLsa()

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

Settlement::LandLsaSettlementint Settlement::LandLsa()

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

MilUnitsGlobalint MilUnits(int)

Counts eligible military units for a one-based player through the squad collection helper.

HeroArmiesFullPercGlobalint HeroArmiesFullPerc(int)

Computes a signed ratio from the second and third outputs of the player collection helper.

MilEvalGlobalint MilEval(int)

Returns a masked collection sum of squad dwords at [field].

AllyMilUnitsGlobalint AllyMilUnits(int)

Sums the unit helper across player slots whose relation result is not four.

AllyMilEvalGlobalint AllyMilEval(int)

Sums squad evaluation dwords across player slots whose relation result is not four.

EnemyMilUnitsGlobalint EnemyMilUnits(int)

Sums the unit helper across player slots whose relation result equals four.

EnemyMilEvalGlobalint EnemyMilEval(int)

Sums squad evaluation dwords across player slots whose relation result equals four.

EnemyPlayersEvalGlobalint EnemyPlayersEval(int, int, int, int)

EnemyPlayersEval initializes and conditionally writes three outputs.

StrongholdsGlobalint Strongholds(int)

Strongholds counts same-owner settlements with BaseTownhall central buildings.

AllyStrongholdsGlobalint AllyStrongholds(int)

AllyStrongholds counts BaseTownhall settlements with numeric relation different from four.

EnemyStrongholdsGlobalint EnemyStrongholds(int)

Counts hostile town halls for a requested player while excluding owner id fourteen.

VillagesGlobalint Villages(int)

Villages counts same-owner settlements with BaseVillage central buildings.

AllyVillagesGlobalint AllyVillages(int)

AllyVillages counts BaseVillage settlements with numeric relation different from four.

EnemyVillagesGlobalint EnemyVillages(int)

EnemyVillages counts BaseVillage settlements with relation four and owner different from fourteen.

OutpostsGlobalint Outposts(int)

Counts live Outpost-class map objects, optionally filtered by player.

AllyOutpostsGlobalint AllyOutposts(int)

AllyOutposts counts Outpost settlements with numeric relation different from four.

EnemyOutpostsGlobalint EnemyOutposts(int)

EnemyOutposts counts Outpost settlements with relation four and owner different from fourteen.

CountGlobalint Count(int, str)

Count looks up a class count in a player's indexed collection.

AllyCountGlobalint AllyCount(int, str)

AllyCount sums class counts for relation codes other than four.

EnemyCountGlobalint EnemyCount(int, str)

EnemyCount sums class counts for relation code four.

GAIKA::LSAGAIKAint GAIKA::LSA()

Maps a GAIKA identifier to a 16-bit LSA value through an AI record helper.

LSAGlobalint LSA(int, int)Description pending

Description pending.

LSAGlobalint LSA(point)Description pending

Description pending.

Obj::LSAObjint Obj::LSA()

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

CheckLsaPathGlobalint CheckLsaPath(int, int, int)Description pending

Description pending.

ShipsGlobalint Ships(int, int)

Reads a 32-bit value from the AI table using the LSA and player indices. The value meaning is not documented.

EnemyShipsGlobalint EnemyShips(int, int)

Returns the relation-four sum of the selected AI row's sixteen dword cells.

AllyShipsGlobalint AllyShips(int, int)

Returns the relation-two sum of the selected AI row's sixteen dword cells.

ShipNeedsGlobalint ShipNeeds(int, int)

Reads a 32-bit value from the AI table using the LSA and player indices. The value meaning is not documented.

Settlement::GetEconomyScriptSettlementint Settlement::GetEconomyScript(int)Description pending

Description pending.

Settlement::EconomyScriptSettlementint Settlement::EconomyScript()Description pending

Description pending.

Settlement::GetTacticScriptSettlementint Settlement::GetTacticScript(int)

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

Settlement::TacticScriptSettlementint Settlement::TacticScript()

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

RUTypeGlobalint RUType(str, int)

Maps a class-name string to its zero-based entry in a race-specific six-name recruitable-unit table.

EvalGroupGlobalint EvalGroup(str)

EvalGroup sums low-word evaluation contributions from group handles.

GetClassHealtGlobalint GetClassHealt(str)Description pending

Description pending.

GetTrainGoldGlobalint GetTrainGold(str)

Resolves a unit class name through the command order registry and returns the training gold cost at [field].

AIVarGlobalint AIVar(int, int)

AIVar returns the selected player AI variable when its player, index, record and table checks pass, otherwise zero.

AIIRunGlobalint AIIRun(int, str)

Native adapter for this function resolving a player script and dispatching 0 integer arguments.

AIIRunGlobalint AIIRun(int, str, int)

Native adapter for this function resolving a player script and dispatching 1 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int)

Native adapter for this function resolving a player script and dispatching 2 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int, int)

Native adapter for this function resolving a player script and dispatching 3 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int, int, int)

Native adapter for this function resolving a player script and dispatching 4 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int, int, int, int)

Native adapter for this function resolving a player script and dispatching 5 integer arguments.

CurPlayerGlobalint CurPlayer()Description pending

Description pending.

cvar1Globalint cvar1()

Passes /cvar1 to a property lookup operation and returns its 32-bit result.

cvar2Globalint cvar2()

Passes /cvar2 to a property lookup operation and returns its 32-bit result.

Unit::GetAnimStateUnitint Unit::GetAnimState()

Maps the resolved Unit's [field] state integer according to a global animation mode predicate.

UITabShownGlobalint UITabShown()

Pushes the tab-holder global dword read by a native getter.

GetInnStateGlobalint GetInnState(str, str)Description pending

Description pending.

GetInnStateGlobalint GetInnState(Obj)Description pending

Description pending.

GetPlayerScriptsCountGlobalint GetPlayerScriptsCount(int)

Registered handler that overwrites its integer argument slot with the constant eight.

ShowNotificationGlobalint ShowNotification(str, str, int, str, Obj)

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

ShowHintGlobalint ShowHint(str, str, Obj)

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

ShowTutorialGlobalint ShowTutorial(str, str, Obj)

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

Building::GetDefendersMaxBuildingint Building::GetDefendersMax(int)

Building::GetDefendersMax returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2.

Building::GetDefendersOutBuildingint Building::GetDefendersOut(int)

Returns one of two defender-out counters for buildings whose associated object derives from Outpost.

Building::GetStartLevelBuildingint Building::GetStartLevel(int)

Building::GetStartLevel returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2.

Building::GetEndLevelBuildingint Building::GetEndLevel(int)

Building::GetEndLevel returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2.

Building::GetOutpostFoodBuildingint Building::GetOutpostFood()

Building::GetOutpostFood returns Building field [field] for Outpost descendants and zero otherwise.

GetTerritoryStateGlobalint GetTerritoryState(str)

Resolves a named territory and returns its stored state value, with a default of two.

GAIKA::ControlledNeighborsGAIKAint GAIKA::ControlledNeighbors(int)

Counts neighboring global GAIKA records matching the wrapped player index through an attached-object field chain.

GAIKA::ApproachingSquadsGAIKAint GAIKA::ApproachingSquads(int, int)

ApproachingSquads adds cached squad evaluation for squads targeting the requested GAIKA whose leader-distance metric is below its threshold.

Accept this type

501
MemberSignature and description
SleepGlobalvoid Sleep(int)

Pauses the current script. The duration unit is not documented here.

+=Globalint +=(int&, int)Description pending

Description pending.

-=Globalint -=(int&, int)Description pending

Description pending.

&Globalint &(int, int)Description pending

Description pending.

|Globalint |(int, int)Description pending

Description pending.

+Globalint +(int, int)Description pending

Description pending.

-Globalint -(int, int)Description pending

Description pending.

-Globalint -(int)Description pending

Description pending.

=Globalvoid =(int&, int)Description pending

Description pending.

*Globalint *(int, int)Description pending

Description pending.

/Globalint /(int, int)Description pending

Description pending.

%Globalint %(int, int)Description pending

Description pending.

==Globalbool ==(int, int)Description pending

Description pending.

!=Globalbool !=(int, int)Description pending

Description pending.

<Globalbool <(int, int)Description pending

Description pending.

>Globalbool >(int, int)Description pending

Description pending.

<=Globalbool <=(int, int)Description pending

Description pending.

>=Globalbool >=(int, int)Description pending

Description pending.

absGlobalint abs(int)

Returns the absolute value of an integer.

WriteGlobalvoid Write(int)

Consumes four bytes and delegates the integer to format %ld in the shared formatting buffer.

MINGlobalint MIN(int, int)

Returns the smaller of the two values.

MAXGlobalint MAX(int, int)

Returns the larger of the two values.

CLAMPGlobalint CLAMP(int, int, int)

Limits a value to the supplied lower and upper bounds.

FindChrPosGlobalint FindChrPos(str, int)

Returns the position of the first matching character, or -1 if it is not found. The position's indexing convention is not specified here.

GetChrGlobalint GetChr(str, int)

The final int is popped before the eight-byte str.

StrMidGlobalstr StrMid(str, int, int)

Clamps the requested count with signed comparisons and copies from payload plus the unchanged start index.

IsFlagSetGlobalbool IsFlagSet(int, int)

Checks whether the two integer values share any set bits.

SetFlagGlobalint SetFlag(int&, int, bool)

Sets or clears the requested bits in an integer passed by reference.

PointGlobalpoint Point(int, int)

Creates a point from its horizontal coordinate x and vertical coordinate y, in that order.

point::Setpointpoint point::Set(int, int)

Sets the horizontal and vertical coordinates and returns the updated point.

point::SetLenpointvoid point::SetLen(int)

Rescales the point's integer coordinates toward the requested vector length, modifying the point in place. Integer arithmetic and truncation can make the resulting length differ from the requested value.

point::Rotpointvoid point::Rot(int)

Rotates a referenced integer point through an integer angle using sine and cosine.

*Globalpoint *(point, int)Description pending

Description pending.

/Globalpoint /(point, int)Description pending

Description pending.

rect::Setrectvoid rect::Set(int, int, int, int)

rect::Set pops four integer coordinates and a rect reference pair, writing them into memory in standard left, top, right, bottom offset order.

[Globalint& [(IntArray&, int)Description pending

Description pending.

IntArray::resizeIntArrayvoid IntArray::resize(int)Description pending

Description pending.

IntArray::findIntArrayint IntArray::find(int)Description pending

Description pending.

[Globalstr& [(StrArray&, int)Description pending

Description pending.

StrArray::resizeStrArrayvoid StrArray::resize(int)Description pending

Description pending.

DumpCodeGlobalvoid DumpCode(int)

Walks a local instruction pointer while formatting diagnostics into a shared buffer.

GetRaceStrGlobalstr GetRaceStr(int)

Converts a race ID to its canonical name and returns it as a CKS string.

GetRaceStrPrefGlobalstr GetRaceStrPref(int)

Maps race indices zero through seven to one-character strings and returns an empty string otherwise.

GetRaceStrPrefLowGlobalstr GetRaceStrPrefLow(int)

Maps race indices zero through seven to lowercase single-character strings and returns an empty string otherwise.

Obj::SetHealthObjvoid Obj::SetHealth(int)

Resolves an Obj and forwards an integer to virtual slot [field].

Obj::SetMaxHealthObjvoid Obj::SetMaxHealth(int)

SetMaxHealth and SetMaxStamina directly write their integer arguments at object [field] and [field].

Obj::SetStaminaObjvoid Obj::SetStamina(int)

Resolves an Obj handle and delegates an integer stamina value through virtual slot [field].

Obj::SetMaxStaminaObjvoid Obj::SetMaxStamina(int)

SetMaxHealth and SetMaxStamina directly write their integer arguments at object [field] and [field].

Obj::SetSightObjvoid Obj::SetSight(int)Description pending

Description pending.

Obj::SetPlayerObjvoid Obj::SetPlayer(int)

Changes the object's owner. Player numbers start at one.

Obj::DamageObjbool Obj::Damage(int)

Applies a nonnegative damage amount through an object's virtual damage operation after an optional related-object call.

Obj::HealObjvoid Obj::Heal(int)

Increases health up to the object's maximum health.

Obj::HealStaminaObjvoid Obj::HealStamina(int)

HealStamina forwards a wrap32 stamina sum bounded by a signed maximum comparison to receiver virtual [field].

Obj::ProgressObjvoid Obj::Progress(int)

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.

Obj::SelectObjvoid Obj::Select(int)

Adds an eligible Obj to active-player selection when the supplied player matches the current player.

Obj::DeselectObjvoid Obj::Deselect(int)

Calls the selection helper with mode one only when the supplied player slot matches game [field].

ClearSelectionGlobalvoid ClearSelection(int)

Clears the selection when the supplied player is the current player.

Obj::PlayAnimObjvoid Obj::PlayAnim(int, point)

Requests a script-object animation and returns the VM suspension code.

Obj::GetAnimTimeObjint Obj::GetAnimTime(int)

GetAnimTime decrements its integer index and reads selected descriptor entry [field], returning zero for missing descriptors.

Obj::StartAnimObjvoid Obj::StartAnim(int, point)

Prepares and requests an animation with an optional target point.

Obj::StartDelayedAnimObjvoid Obj::StartDelayedAnim(int, point, int)

Normalizes an equal-current point and forwards a decremented animation identifier with a final integer.

Obj::SetStateObjvoid Obj::SetState(int)

Forwards a decremented state identifier and preserves an anomalous invalid-receiver VM zero push.

Obj::RemoveItemObjvoid Obj::RemoveItem(int)

RemoveItem int dispatches removal after signed one-based bounds.

Obj::GetItemObjItem Obj::GetItem(int)

GetItem builds a handle from the virtual lookup result.

Obj::prObjvoid Obj::pr(int)

Formats the supplied integer through chat dispatch when the receiver field matches the global gate.

Obj::commandObjstr Obj::command(int)

Returns a queued command's name by index, starting at zero. Returns an empty string for an invalid object or index.

GetPlayerRaceGlobalint GetPlayerRace(int)Description pending

Description pending.

PlaceGlobalObj Place(str, point, int)

Creates an object of the named class at a map position for the specified player, when placement is possible.

PlaceInHolderGlobalObj PlaceInHolder(str, str, int)

Validates the player and routes a compatible created unit to forced entry in the named holder.

_PlaceExGlobalObj _PlaceEx(str, int, int, int)

Clamps a supplied point to map margins and routes placement with an optional script handle.

_PlaceBlockExGlobalvoid _PlaceBlockEx(str, int, int, int, int, int, int, int)

Routes class creation and placement across a signed grid, aborting on factory or template failure.

_PlaceBlockExGlobalvoid _PlaceBlockEx(str, int, int, int, int, int, int, int, str)

Prepares a named group and routes compatible grid objects to its insertion virtual.

_SummonGlobalvoid _Summon(str, int, int, int)

Allocates and populates a command-shaped object before game submission.

ModLevelGlobalvoid ModLevel(str, int, int, int)

Resolves a named group and dispatches one of three level deltas according to the game difficulty value.

ClassPlayerAreaObjsGlobalQuery ClassPlayerAreaObjs(str, int, str)Description pending

Description pending.

ClassPlayerObjsGlobalQuery ClassPlayerObjs(str, int)

Validates a player and class name, then returns a cached or newly built player-class Query.

EnemyObjsGlobalQuery EnemyObjs(int, str)

Validates a player and class string, requests a mode-two cached query and returns its managed Query value.

FriendlyObjsGlobalQuery FriendlyObjs(int, str)

Constructs a class-filtered Query for a specified player.

ControllableObjsGlobalQuery ControllableObjs(int, str)Description pending

Description pending.

ObjsInCircleGlobalQuery ObjsInCircle(point, int, str)

Returns a class-filtered spatial query centered on a point with a supplied radius.

ObjsInRangeGlobalQuery ObjsInRange(Obj, str, int)

Validates an Obj and class name, then returns a cached or newly built object-range Query.

Query::SetPlayerQueryvoid Query::SetPlayer(int)

Passes the script player value minus one to each live Query member's virtual slot [field].

Query::DamageQueryint Query::Damage(int)

Calls virtual damage slot [field] on eligible Query members and counts nonzero call results.

Query::HealQueryvoid Query::Heal(int)

Adds a signed amount to eligible query members' health and clamps each result to maximum health.

Query::HealStaminaQueryvoid Query::HealStamina(int)

Adds an integer amount to eligible Query members' stamina and caps it at each member's maximum.

DistributeExperienceGlobalvoid DistributeExperience(Query, int)

Divides an unsigned experience amount across query members and adds the remainder to the first registry-live recipient.

Query::SetFoodQueryvoid Query::SetFood(int)

Assigns a nonnegative food value to every unit-compatible live member of a query.

EnemyInRangeGlobalbool EnemyInRange(point, int, Obj)

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

Building::GetPointBuildingpoint Building::GetPoint(int, int)Description pending

Description pending.

Building::GlobalSpellStartBuildingvoid Building::GlobalSpellStart(int, int)

Starts a global-spell operation for a town hall when the first integer is in the range zero through five.

Building::GlobalSpellStartBuildingvoid Building::GlobalSpellStart(int, int, int)

Starts a global-spell operation for a town hall with three script integers when the first is in the range zero through five.

Building::SetGlobalSpellDataBuildingvoid Building::SetGlobalSpellData(int)

Passes a town hall and an integer to a global-spell vector updater.

Building::WindOfWisdomBuildingvoid Building::WindOfWisdom(int)

Stonehenge-gated Building primitive with two-path candidate collection and capped signed level-to-XP dispatch, retaining concrete storage and override prerequisites.

Building::SoothingRainBuildingvoid Building::SoothingRain(int)

Scans matching buildings and adds 300 divided by the script argument to linked settlement gold.

PlaceCatapultGlobalCatapult PlaceCatapult(int, int, int, int)

Routes four script integers through class selection and catapult creation.

Catapult::SetBuildFrameCatapultvoid Catapult::SetBuildFrame(int)Description pending

Description pending.

Unit::SetSpeedFactorUnitvoid Unit::SetSpeedFactor(int)

Stores a speed factor dword on a resolved Unit.

Unit::SetUserUnitvoid Unit::SetUser(int)

Stores a user dword on a resolved Unit.

Unit::SetFoodUnitvoid Unit::SetFood(int)

Stores the supplied food value on a resolved Unit and dispatches a value-dependent virtual state update.

Unit::GotoUnitbool 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::GotoEnterUnitbool 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::GotoUnitbool 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::GotoAttackUnitbool Unit::GotoAttack(Obj, int, bool, int)

Prepares target tracking and delegates cooperative attack routing.

Unit::StopUnitbool 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::BestTargetInRangeUnitObj Unit::BestTargetInRange(point, int)

Forwards explicit point coordinates and integer radius to the common target-search helper.

Unit::IdleUnitvoid Unit::Idle(int)

With nonzero continuation, waits on the special virtual [field] coordinate pair; otherwise dispatches action 4 through [field], clears target tracking and returns native status 3. Zero continuation returns 0.

Unit::TauntUnitvoid Unit::Taunt(int)

With nonzero continuation, waits on the special virtual [field] coordinate pair; otherwise dispatches action 5 through [field], clears target tracking and returns native status 3. Zero continuation returns 0.

Unit::SetExperienceUnitvoid Unit::SetExperience(int)

Scripting VM bridge writing a raw experience value directly through the shared virtual experience setter.

Unit::SetLevelUnitvoid Unit::SetLevel(int)

Scripting VM bridge clamping input level, looking up experience threshold, and calling virtual experience setter.

Unit::IncKillsUnitvoid Unit::IncKills(int)

Adds an integer to the resolved Unit's kill counter field.

Unit::FormKeepMovingUnitvoid Unit::FormKeepMoving(int)

For nonzero continuation, clears target tracking, sets movement state 3 and a unit flag, stores wait ticks and reports status 1. For zero continuation, may clear a satisfied controller, clears the flag and reports status 0.

Unit::PathToUnitint Unit::PathTo(point, int, int)

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

Unit::PathToUnitint Unit::PathTo(Obj, int, int)

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

Unit::GetUnexploredPointUnitpoint Unit::GetUnexploredPoint(int)

Samples bounded map cells around a unit and returns a random eligible unexplored point.

Unit::GetFlagsUnitbool Unit::GetFlags(int)

Returns the registered Unit GetFlags boolean for this function.

SetExperienceModifierGlobalvoid SetExperienceModifier(int, int)

Stores the supplied 32-bit value in a field of the selected player record.

GetExperienceModifierGlobalint GetExperienceModifier(int)

GetExperienceModifier returns the selected player record dword at [field].

Unit::SetWalkAnimUnitvoid Unit::SetWalkAnim(int)

Unit[field] is the current zero-based animation index; the no-argument SetWalkAnim selects index zero and the int overload stores argument minus one.

Unit::HasSpecialUnitbool Unit::HasSpecial(int)

Tests an indexed bit in the Unit special mask.

Unit::SetSpecialUnitvoid 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::SpecialNameUnitstr Unit::SpecialName(int)

Builds a script string from a Unit special-name table entry or fallback.

GetPlayerUnitsGlobalObjList GetPlayerUnits(int)

Builds an ObjList of units for a one-based player number.

GetPlayerUnitsGlobalObjList GetPlayerUnits(int, str)

Builds an ObjList of a player's units using a resolved script class filter.

ExpFromLevelGlobalint ExpFromLevel(int)

ExpFromLevel replaces the input dword with the global dword at [field].

LevelFromExpGlobalint LevelFromExp(int)

Converts an experience dword using an inline signed threshold scan and returns the resulting level dword.

Hero::FormKeepMovingHerovoid Hero::FormKeepMoving(int)

For nonzero continuation, refreshes formation movement, sets hero state 3 and a flag, stores the integer as VM wait ticks and reports status 1. Zero continuation clears the flag and reports status 0.

Hero::FormSetupAndMoveToHerovoid 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::FormSetupAndMoveToHerovoid 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.

GetRandomHeroClassGlobalstr GetRandomHeroClass(str, int)

Passes a class string and decremented player index to a hero selector and returns a new script string.

Hero::SetSkillHerovoid Hero::SetSkill(int, int)

Resolves the hero reference and delegates the skill-level update.

Hero::GetSkillHeroint Hero::GetSkill(int)

CKS scripting bridge returning current skill level for a given skill index.

Hero::UseSkillHerobool Hero::UseSkill(int)

Resolves a Hero handle and returns whether the native Hero skill dispatcher accepted the supplied skill ID.

HeroSkillNameGlobalstr HeroSkillName(int)

Returns an owned script string from the 25-entry display-name table or an empty-string fallback.

Hero::SkillInEffectHerobool Hero::SkillInEffect(int)

Resolves a Hero and tests whether an indexed skill-effect slot differs from the -1 sentinel.

Druid::FindUnitBelowILevelDruidUnit Druid::FindUnitBelowILevel(int)

CKS Druid adapter that searches within receiver [field] and validates one spatially selected candidate against a strict experience-derived level threshold.

Druid::FindUnitBelowILevelDruidUnit Druid::FindUnitBelowILevel(int, int)Description pending

Description pending.

Wagon::SetFoodWagonvoid Wagon::SetFood(int)

Selects the carried resource type and forwards the supplied amount to the wagon amount-update helper.

Wagon::SetGoldWagonvoid Wagon::SetGold(int)

Selects the carried resource type and forwards the supplied amount to the wagon amount-update helper.

Wagon::LoadFoodWagonvoid Wagon::LoadFood(int)

Adapts Wagon resource loading through a selected pointer, signed capacity arithmetic and resource-store removal.

Wagon::LoadGoldWagonvoid Wagon::LoadGold(int)

Adapts Wagon resource loading through a selected pointer, signed capacity arithmetic and resource-store removal.

Wagon::SetLoyaltyWagonvoid Wagon::SetLoyalty(int)

CKS-exposed setter that validates a 0..100 loyalty value and writes it, scaled by ten, to the wagon's loyalty field.

Wagon::DecreaseLoyaltyWagonvoid Wagon::DecreaseLoyalty(int)Description pending

Description pending.

Settlement::SetLoyaltySettlementvoid Settlement::SetLoyalty(int)

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

Settlement::DecreaseLoyaltySettlementvoid Settlement::DecreaseLoyalty(int)

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

Settlement::SetGoldSettlementvoid Settlement::SetGold(int)

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

Settlement::SetFoodSettlementvoid Settlement::SetFood(int)

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

Settlement::SetPopulationSettlementvoid Settlement::SetPopulation(int)

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

Settlement::AddToPopulationSettlementvoid Settlement::AddToPopulation(int)

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

Settlement::AddToMaxPopulationSettlementvoid Settlement::AddToMaxPopulation(int)

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

Settlement::SetPlayerSettlementvoid Settlement::SetPlayer(int)Description pending

Description pending.

Settlement::SetLoanSettlementvoid Settlement::SetLoan(int)

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

Settlement::SetFoodProductionSettlementvoid Settlement::SetFoodProduction(int)

Writes the settlement's food production rate unconditionally.

Settlement::SetGoldProductionSettlementvoid Settlement::SetGoldProduction(int)

Writes the settlement's gold production rate unconditionally.

Settlement::GoldConvertedSettlementvoid Settlement::GoldConverted(int)

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

Settlement::GoldSpentSettlementvoid Settlement::GoldSpent(int)

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

Settlement::AddSentriesSettlementvoid Settlement::AddSentries(int)

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

Settlement::AddMaxSentriesSettlementvoid Settlement::AddMaxSentries(int)

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

Settlement::CreateMuleFoodSettlementWagon Settlement::CreateMuleFood(int)

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

Settlement::CreateMuleGoldSettlementWagon Settlement::CreateMuleGold(int)

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

Settlement::CreateBoatFoodSettlementWagon Settlement::CreateBoatFood(int)

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

Settlement::CreateBoatGoldSettlementWagon Settlement::CreateBoatGold(int)

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

[GlobalObj [(ObjList, int)Description pending

Description pending.

ObjList::FilterClosestObjListObjList ObjList::FilterClosest(point, int)

Creates an ObjList through a bounded distance-selection helper using a point and count.

ObjList::SetFoodObjListvoid ObjList::SetFood(int)

The handler rejects a negative input.

ObjList::SetPlayerObjListvoid ObjList::SetPlayer(int)

The handler accepts input player numbers 1 through 16.

ObjList::ObjPlayerObjListObjList ObjList::ObjPlayer(int)

Builds a new ObjList containing source members owned by the requested script player.

ObjList::ObjEnemyObjListObjList ObjList::ObjEnemy(int)

Filters an ObjList using the zero state of a player relation bit.

ObjList::ObjAllyObjListObjList ObjList::ObjAlly(int)

Filters an ObjList using the set state of a player relation bit.

ObjList::ObjSpecialObjListvoid ObjList::ObjSpecial(int)

Selects ObjList member slots by a numbered special-bit test and constructs an ObjList value.

ObjList::FindAllyObjListObj ObjList::FindAlly(int, str)

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

ObjList::FindEnemyObjListObj ObjList::FindEnemy(int, str)

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

EnvWriteIntGlobalvoid EnvWriteInt(str, int)Description pending

Description pending.

EnvWriteIntGlobalvoid EnvWriteInt(Settlement, str, int)

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

EnvWriteIntGlobalvoid EnvWriteInt(Building, str, int)

Formats a building-scoped environment path and delegates an integer value as decimal text to the environment writer.

EnvWriteStringGlobalvoid EnvWriteString(int, str, str)

Writes a string under a key in the specified player's environment. Arguments are, in order, the player number, the key, and the string to write.

EnvWriteIntGlobalvoid EnvWriteInt(int, str, int)

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

EnvReadStringGlobalstr EnvReadString(int, str)

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

EnvReadIntGlobalint EnvReadInt(int, str)

Formats a player-scoped environment path and returns the integer reader result.

EnvWriteObjGlobalvoid EnvWriteObj(int, str, Obj)

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

EnvReadObjGlobalObj EnvReadObj(int, str)Description pending

Description pending.

RegisterPlayerUpgradeGlobalvoid RegisterPlayerUpgrade(int, str)

Gates on research command type and dispatches player property writes from command triples.

PlaySoundGlobalvoid PlaySound(int, str)

PlaySound player overload gates its request on the local player index.

SetSpeedGlobalvoid SetSpeed(int)

SetSpeed prepares and submits a command when game field230 is zero.

RunGlobalvoid Run(str, int)

Adapts the verified global Run overload with 1 integer arguments to named script compilation and dispatch.

RunGlobalvoid Run(str, int, int)

Adapts the verified global Run overload with 2 integer arguments to named script compilation and dispatch.

RunGlobalvoid Run(str, int, int, int)

Adapts the verified global Run overload with 3 integer arguments to named script compilation and dispatch.

RunGlobalvoid Run(str, int, int, int, int)

Adapts the verified global Run overload with 4 integer arguments to named script compilation and dispatch.

RunGlobalvoid Run(str, int, int, int, int, int)

Adapts the verified global Run overload with 5 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int)

Adapts the verified global IRun overload with 1 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int)

Adapts the verified global IRun overload with 2 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int, int)

Adapts the verified global IRun overload with 3 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int, int, int)

Adapts the verified global IRun overload with 4 integer arguments to named script compilation and dispatch.

IRunGlobalint IRun(str, int, int, int, int, int)

Adapts the verified global IRun overload with 5 integer arguments to named script compilation and dispatch.

randGlobalint rand(int)

rand passes a zero-based bound to the game RNG virtual method.

ExploreCircleGlobalvoid ExploreCircle(int, point, int)

Validates a player index and delegates a center and radius to a map exploration helper.

ExploreAreaGlobalvoid ExploreArea(int, str)

Gates a named-area reveal call by a signed player index.

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

SetDifficultyGlobalvoid SetDifficulty(int)

SetDifficulty admits exactly zero one and two.

GetTeamMilitaryScoreGlobalint GetTeamMilitaryScore(int)Description pending

Description pending.

GetTeamPowerScoreGlobalint GetTeamPowerScore(int)Description pending

Description pending.

GetTeamAchievementsScoreGlobalint GetTeamAchievementsScore(int)Description pending

Description pending.

GetTeamOverallScoreGlobalint GetTeamOverallScore(int)

Calculates and returns the average composite score across all players on a specified team.

GetVecGlobalpoint GetVec(point, point, int)

Scales a wrapped integer point difference using signed division by an integer helper return.

IsExploredGlobalbool IsExplored(point, int)

Forwards a point and decremented player value to the exploration receiver.

RandomOffsetGlobalpoint RandomOffset(int)

RandomOffset calls virtual slot [field] twice on Game[field] with the pair (-r,r), then writes (second,first).

RandomPointInCircleGlobalpoint RandomPointInCircle(point, int)

Constructs a point from radial and angular samples and clamps it to map bounds.

WasSelectionAssignedGlobalbool WasSelectionAssigned(int, int)

WasSelectionAssigned group overload tests the stored assignment mask.

WasSelectionAssignedGlobalbool WasSelectionAssigned(int)

WasSelectionAssigned player overload tests any stored assignment bit.

IsSelectionAssignedGlobalbool IsSelectionAssigned(int, int)

Validates player and selection indices and reports whether the selected selection contains any units.

IsSelectionAssignedGlobalbool IsSelectionAssigned(int)

IsSelectionAssigned player overload scans ten live counts.

RevealHiddenEnemyUnitsGlobalvoid RevealHiddenEnemyUnits(point, int, int)Description pending

Description pending.

_AdvPlaceAreaCircGlobalvoid _AdvPlaceAreaCirc(str, point, int, str, str)

Spawns and configures a circular adventure area from script arguments.

Sacrifice::AddDruidSacrificebool 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::ConsumeSacrificeint 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].

Sacrifice::MistActionSacrificevoid Sacrifice::MistAction(int)

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.

CreateFeedbackGlobalvoid CreateFeedback(str, Unit, int)

Resolves a unit and named class and dispatches feedback construction with the supplied duration integer.

CreateFeedbackGlobalvoid CreateFeedback(str, point, int)

Constructs named feedback at a supplied point and initializes its scheduling field with the integer offset.

DiplCeaseFireGlobalvoid DiplCeaseFire(int, int, bool)Description pending

Description pending.

DiplShareViewGlobalvoid DiplShareView(int, int, bool)Description pending

Description pending.

DiplShareControlGlobalvoid DiplShareControl(int, int, bool)Description pending

Description pending.

DiplShareSupportGlobalvoid DiplShareSupport(int, int, bool)Description pending

Description pending.

DiplGetCeaseFireGlobalbool DiplGetCeaseFire(int, int)

Evaluates whether player 1 has a ceasefire with player 2 by querying bit 0 of the player's diplomacy record.

DiplGetShareViewGlobalbool DiplGetShareView(int, int)Description pending

Description pending.

DiplGetShareControlGlobalbool DiplGetShareControl(int, int)

Evaluates whether player 1 has granted shared control to player 2 by querying bit 5 of the player's diplomacy record.

DiplGetShareSupportGlobalbool DiplGetShareSupport(int, int)

inspects diplomacy mask bit 2 to determine if two players share support.

Gate::LookAroundGatevoid Gate::LookAround(int)

Resets gate proximity cache and runs a bounded native circle scan.

Teleport::TraverseTeleportvoid Teleport::Traverse(int)

Teleport::Traverse ORs the dword at an indexed player record [field] into the resolved Teleport dword [field].

Unit::AddBonusUnitvoid Unit::AddBonus(int, int, int, int, int)

Builds a bonus descriptor, adds it to a Unit-linked collection, and recalculates bonuses.

Unit::RemoveBonusUnitvoid Unit::RemoveBonus(int, int, int, int, int)

Subtracts a bonus descriptor from a Unit-linked collection and recalculates bonuses.

ItemUsedGlobalvoid ItemUsed(int)

Deducts a script-supplied amount from a registry object's dword and invokes its virtual slot zero when nonpositive.

Item::SetCustomDataItemvoid Item::SetCustomData(int)Description pending

Description pending.

Flying::PlayAnimFlyingvoid Flying::PlayAnim(int, point, int)

Validates and starts a Flying animation, then suspends the VM.

Flying::PickFlyingPointFlyingpoint Flying::PickFlyingPoint(int)Description pending

Description pending.

Flying::PickLandingPointFlyingpoint Flying::PickLandingPoint(int)Description pending

Description pending.

GetVecByDirGlobalpoint GetVecByDir(point, int)

Scales an input point vector to a requested integer magnitude.

GetDirByAngleGlobalpoint GetDirByAngle(int)

Handler for this function, point GetDirByAngle(int): returns cosine and sine of a degree angle scaled by 100.

Unit::GetAnimDurationUnitint Unit::GetAnimDuration(int)Description pending

Description pending.

NumSquadsGlobalint NumSquads(int)

NumSquads returns a per-player squad pointer-span length divided by four for input IDs 1 through 16 and zero otherwise.

GetSquadGlobalSquad GetSquad(int, int)

Handler for this function, Squad GetSquad(int, int): packs player and index into a 4-byte Squad value.

Squad::SetStateSquadvoid Squad::SetState(int)

updates a squad's internal state code and records the transition timestamp.

Squad::SetStateSquadvoid Squad::SetState(int, int, int)

Updates state, masked flags and a game-clock snapshot for a resolved Squad.

Squad::ClrCmdSquadvoid Squad::ClrCmd(int, int, int)

Updates a squad command state and notifies member units.

Squad::SetCmdSquadvoid Squad::SetCmd(int, int, int, str)

Updates squad state and flags and submits named zero-argument commands to member units.

Squad::SetCmdSquadvoid Squad::SetCmd(int, int, int, str, point)

Resolves the squad reference and delegates a command operation with target point coordinates.

Squad::SetCmdSquadvoid Squad::SetCmd(int, int, int, str, Obj)

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

ObjList::SiegeObjListvoid ObjList::Siege(Obj, int, int)

The handler pops two integers and two object handles.

Squad::SiegeSquadvoid Squad::Siege(Obj, int, int, int)

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

Squad::SendToSquadvoid Squad::SendTo(GAIKA, int)

Validates a packed Squad handle and delegates a destination command for an active squad.

Squad::TestFlagsSquadbool Squad::TestFlags(int)

Tests whether a squad satisfies all bits in a specified bitmask against its internal flags at offset [field].

Squad::SetFlagsSquadvoid Squad::SetFlags(int, int)Description pending

Description pending.

Squad::SendFoodWagonSquadbool 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::EvalAttachSquadint Squad::EvalAttach(Unit, int)

Scores a candidate unit using squad size, affiliation equality and its virtual level result.

GetGAIKAGlobalGAIKA GetGAIKA(int)

Leaves the four-byte argument slot unchanged so that its value becomes the GAIKA result.

GetGAIKAGlobalGAIKA GetGAIKA(int, int)

Resolves two integer coordinates through the global AI map and returns a zero-extended 16-bit GAIKA value.

LAIKAGlobalGAIKA LAIKA(int, int)

Returns the first 16-bit value of the selected AI entry after checked player and index lookup, or zero on failure.

GAIKA::GetSquadsGAIKAvoid GAIKA::GetSquads(SquadList&, int)

The three-argument GetSquads replaces the referenced list and appends squad IDs whose nonzero [field] and computed category intersect its mask.

GAIKA::GetSquadsGAIKAvoid GAIKA::GetSquads(SquadList&, int, int)

The four-argument GetSquads requires relation mask 1 before applying the category mask and rebuilding the output list.

GAIKA::GetSquadsGAIKAvoid GAIKA::GetSquads(SquadList&, int, int, int)

Builds a SquadList from GAIKA squads filtered by relation and destination masks.

GAIKA::EvalGAIKAint GAIKA::Eval(int)

The two-argument Eval adds squad [field] values selected by category mask, with a separately gated attached-settlement contribution.

GAIKA::EvalGAIKAint GAIKA::Eval(int, int)

The three-argument Eval gates category-matching cached evaluation sums on relation mask 1 for the selected player.

GAIKA::EvalGAIKAint GAIKA::Eval(int, int, int)

Evaluates cached squad and conditional guard contributions under presence, player and relation controls.

GAIKA::EvalGAIKAvoid GAIKA::Eval(int, int, int&, int&, int&, int&)

Accumulates three relation buckets and a conditional fourth squad subset into four referenced integers.

GAIKA::EvalNeighborsGAIKAvoid GAIKA::EvalNeighbors(int, int, int&, int&, int&, bool)

Traverses neighboring GAIKA records, filters them, and accumulates three referenced evaluation outputs.

GAIKA::CountGAIKAvoid GAIKA::Count(int, int, int&, int&, int&, int&)

The seven-argument Count fills four referenced accumulators selected by category mask and relation codes, leaving its fourth output unchanged on missing GAIKA.

GAIKA::GetPriorityGAIKAint GAIKA::GetPriority(int)Description pending

Description pending.

GAIKA::GetLAIKAGAIKAint GAIKA::GetLAIKA(int)

GetLAIKA returns the zero-extended mapping word indexed by low16 GAIKA in the selected player's AI table, with zero for locally rejected cases.

GAIKA::CalcPriorityGAIKAint GAIKA::CalcPriority(int)

Calls a selected priority script with a temporary referenced integer and returns its nonnegative contribution under the native dispatch gate.

GAIKA::SetPriorityGAIKAvoid GAIKA::SetPriority(int, int)

SetPriority resolves low16 GAIKA through a player AI word mapping and calls the mapped-priority helper with the supplied priority.

GAIKA::PrioritizedGAIKAbool GAIKA::Prioritized(int)

Looks up the selected AI table entry and returns bit zero of its stored 16-bit value.

GAIKA::ExploredGAIKAbool GAIKA::Explored(int)

Resolves a player's GAIKA-related AI record and returns a mode-dependent explored predicate.

GAIKA::ExploreGAIKAvoid GAIKA::Explore(int, bool)

Sets or clears bit 1 in a validated per-player GAIKA record.

GAIKA::CanExploreGAIKAbool GAIKA::CanExplore(int)

Selects adjacent or object-derived per-player descriptors passing a native exploration predicate.

GAIKA::RevealedGAIKAbool GAIKA::Revealed(int)

Resolves a player GAIKA record and delegates a mode-dependent Boolean predicate.

GAIKA::LastSeenGAIKAint GAIKA::LastSeen(int)

GAIKA::LastSeen returns dword [field] of the mapped player record, or integer zero on explicit resolution failure.

GAIKA::NoAttackGAIKAbool GAIKA::NoAttack(int)

Reads the no-attack mask in a byte of the resolved GAIKA record.

GAIKA::SetNoAttackGAIKAvoid GAIKA::SetNoAttack(int, bool)

Updates the no-attack mask in a byte of the resolved GAIKA record.

GAIKA::NoRecruitGAIKAbool GAIKA::NoRecruit(int)

Reads the no-recruit mask in a byte of the mapped player record.

GAIKA::SetNoRecruitGAIKAvoid GAIKA::SetNoRecruit(int, bool)

Updates the no-recruit mask in a byte of the mapped player record.

GAIKA::GetDistToPlayersGAIKAvoid GAIKA::GetDistToPlayers(int, int&, int&, int&)

Scans town halls and reports minimum weighted distances for three diplomatic relation categories.

GAIKA::GetDistToArmiesGAIKAint GAIKA::GetDistToArmies(int)

Reduces helper distances over qualifying squads from sixteen player slots, with a 32000 initial cap.

GAIKA::CountGAIKAint GAIKA::Count(int, int, str)

The string Count returns the number of selected squad members whose class template inherits from the requested class descriptor, with a gated Sentry contribution.

GAIKA::MinNeedGAIKAint GAIKA::MinNeed(int, int, int, int)

Scales a scripted army-need value by an AI table divisor.

GAIKA::MaxNeedGAIKAint GAIKA::MaxNeed(int, int, int, int)

Scales a helper result by the selected per-player GAIKA divisor with unsigned division and a minimum nonzero quotient.

GAIKA::RecruitGAIKAint GAIKA::Recruit(int, int, int, int)Description pending

Description pending.

GAIKA::GetStratGAIKAint GAIKA::GetStrat(int)

Delegates a GAIKA value and player index to a strategy-script helper and returns its low-word result.

GAIKA::StratRunningGAIKAint GAIKA::StratRunning(int)Description pending

Description pending.

GAIKA::RunStratGAIKAvoid GAIKA::RunStrat(int, int)

Resolves a per-player AI strategy context and delegates a GAIKA strategy assignment.

GAIKA::AllEnemiesInHolderGAIKAbool 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::MilitaryPresenceGAIKAbool GAIKA::MilitaryPresence(int)

Returns true for a selected squad with clear flag bit4 or for qualifying positive holder guard count.

GAIKA::NeighborGAIKAGAIKA GAIKA::Neighbor(int)

GAIKA::Neighbor reads a neighbor word for signed index from zero through the stored count inclusive.

SetNoAttackGlobalvoid SetNoAttack(str, int, bool)Description pending

Description pending.

SetNoRecruitGlobalvoid SetNoRecruit(str, int, bool)Description pending

Description pending.

AreaAINoRecruitGlobalvoid AreaAINoRecruit(str, int, bool)Description pending

Description pending.

AreaAINoAttackGlobalvoid AreaAINoAttack(str, int, bool)Description pending

Description pending.

AreaAIMaxPriorityGlobalvoid AreaAIMaxPriority(str, int, bool)

Applies priority 100 or -1 to player AI records whose points lie inside a named area.

AreaAISetAttackOptimismGlobalvoid AreaAISetAttackOptimism(str, int, int)Description pending

Description pending.

DumpMAIKAGlobalvoid DumpMAIKA(int, int, int)

DumpMAIKA filters and visits six-byte route records.

SquadList::SelectSquadListvoid SquadList::Select(int)

Reconciles the current player selection and adds resolved members of the supplied squad list.

SquadList::TrainSquadListint SquadList::Train(int, int, int, int, Obj)

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

Settlement::IsAllySettlementbool Settlement::IsAlly(int)

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

Settlement::IsEnemySettlementbool Settlement::IsEnemy(int)

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

Settlement::IsOwnSettlementbool Settlement::IsOwn(int)

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

Settlement::GetRelSettlementint Settlement::GetRel(int)

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

SettlementCountGlobalint SettlementCount(point, int, str)

SettlementCount counts class-matching settlements below a strict unsigned metric threshold.

FindRuinsGlobalObj FindRuins(point, int, int)

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

AttackSetForTrainingGlobalbool AttackSetForTraining(Obj, point, int)

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

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

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

AIBreakScriptGlobalvoid AIBreakScript(int)

Checks the current script player's AI context and delegates the input script ID to an AI break helper.

AIBreakScriptGlobalvoid AIBreakScript(int, int)

Routes an interruption request for the identified script to the specified player's AI system. Arguments are the player number followed by the script ID.

ScrollToGlobalvoid ScrollTo(point, int)

Uses a persistent blocking frame to interpolate a projected viewport center and schedule retries.

Settlement::BestBarrackSettlementBarrack Settlement::BestBarrack(int)

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.

GetGaikaCenterGlobalpoint GetGaikaCenter(int)

Returns the point fields of a record selected by the low 16 bits of the input.

GetSquadCenterGlobalpoint GetSquadCenter(int, int)

Averages resolved squad-member coordinates using unsigned division by the stored total count.

IdxToSetGlobalSettlement IdxToSet(int)

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

AIO_SendSquadGlobalvoid AIO_SendSquad(int, int, int)Description pending

Description pending.

AIO_TrainGlobalvoid AIO_Train(int, str, int, int)Description pending

Description pending.

SquadizeGlobalvoid Squadize(ObjList, SquadList, int)

CKS scripting primitive wrapper exposing Squadize(ObjList ol, SquadList *sl, int nState) to scenario and AI scripts.

IsResearchedGlobalbool IsResearched(int, str)

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

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

GetCmdCostGlobalbool GetCmdCost(str, int, int)

Looks up a named command and writes its gold and food cost fields to output references.

Settlement::CanAffordSettlementbool Settlement::CanAfford(int, int)

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

Settlement::CanAffordSettlementbool Settlement::CanAfford(str, int)

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

Settlement::ReserveForSettlementbool Settlement::ReserveFor(str, int)

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

Settlement::SpentGoldOnArmySettlementvoid Settlement::SpentGoldOnArmy(int)

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

Settlement::SpentGoldOnTechSettlementvoid Settlement::SpentGoldOnTech(int)

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

Settlement::CheckTechBudgetSettlementbool Settlement::CheckTechBudget(str, int)

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

MilUnitsGlobalint MilUnits(int)

Counts eligible military units for a one-based player through the squad collection helper.

HeroArmiesFullPercGlobalint HeroArmiesFullPerc(int)

Computes a signed ratio from the second and third outputs of the player collection helper.

MilEvalGlobalint MilEval(int)

Returns a masked collection sum of squad dwords at [field].

AllyMilUnitsGlobalint AllyMilUnits(int)

Sums the unit helper across player slots whose relation result is not four.

AllyMilEvalGlobalint AllyMilEval(int)

Sums squad evaluation dwords across player slots whose relation result is not four.

EnemyMilUnitsGlobalint EnemyMilUnits(int)

Sums the unit helper across player slots whose relation result equals four.

EnemyMilEvalGlobalint EnemyMilEval(int)

Sums squad evaluation dwords across player slots whose relation result equals four.

EnemyPlayersEvalGlobalint EnemyPlayersEval(int, int, int, int)

EnemyPlayersEval initializes and conditionally writes three outputs.

StrongholdsGlobalint Strongholds(int)

Strongholds counts same-owner settlements with BaseTownhall central buildings.

AllyStrongholdsGlobalint AllyStrongholds(int)

AllyStrongholds counts BaseTownhall settlements with numeric relation different from four.

EnemyStrongholdsGlobalint EnemyStrongholds(int)

Counts hostile town halls for a requested player while excluding owner id fourteen.

VillagesGlobalint Villages(int)

Villages counts same-owner settlements with BaseVillage central buildings.

AllyVillagesGlobalint AllyVillages(int)

AllyVillages counts BaseVillage settlements with numeric relation different from four.

EnemyVillagesGlobalint EnemyVillages(int)

EnemyVillages counts BaseVillage settlements with relation four and owner different from fourteen.

OutpostsGlobalint Outposts(int)

Counts live Outpost-class map objects, optionally filtered by player.

AllyOutpostsGlobalint AllyOutposts(int)

AllyOutposts counts Outpost settlements with numeric relation different from four.

EnemyOutpostsGlobalint EnemyOutposts(int)

EnemyOutposts counts Outpost settlements with relation four and owner different from fourteen.

CountGlobalint Count(int, str)

Count looks up a class count in a player's indexed collection.

AllyCountGlobalint AllyCount(int, str)

AllyCount sums class counts for relation codes other than four.

EnemyCountGlobalint EnemyCount(int, str)

EnemyCount sums class counts for relation code four.

LSAGlobalint LSA(int, int)Description pending

Description pending.

CheckLsaPathGlobalint CheckLsaPath(int, int, int)Description pending

Description pending.

ShipsGlobalint Ships(int, int)

Reads a 32-bit value from the AI table using the LSA and player indices. The value meaning is not documented.

EnemyShipsGlobalint EnemyShips(int, int)

Returns the relation-four sum of the selected AI row's sixteen dword cells.

AllyShipsGlobalint AllyShips(int, int)

Returns the relation-two sum of the selected AI row's sixteen dword cells.

ShipNeedsGlobalint ShipNeeds(int, int)

Reads a 32-bit value from the AI table using the LSA and player indices. The value meaning is not documented.

ClrShipNeedsGlobalvoid ClrShipNeeds(int, int)

ClrShipNeeds writes zero to the global-AI ship-needs cell selected by lsa and player indices.

IncShipNeedsGlobalvoid IncShipNeeds(int, int)

IncShipNeeds increments the global-AI ship-needs cell selected by lsa and player indices.

IsWaterLsaGlobalbool IsWaterLsa(int)

Handler for this function, bool IsWaterLsa(int lsa): tests whether an lsa region is water-majority.

AIStartGlobalvoid AIStart(int)Description pending

Description pending.

AIStartGlobalvoid AIStart(int, str)Description pending

Description pending.

AIStartGlobalvoid AIStart(int, str, int)

Validates a player, AI profile, and difficulty before replacing that player's AI controller.

AIStopGlobalvoid AIStop(int)Description pending

Description pending.

NearestStrongholdGlobalSettlement NearestStronghold(point, int, int)Description pending

Description pending.

NearestStrongholdGlobalSettlement NearestStronghold(point, int)Description pending

Description pending.

NearestSetGlobalSettlement NearestSet(point, str, int, int)

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

NearestSetGlobalSettlement NearestSet(point, str, int)

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

GetSettlementsGlobalObjList GetSettlements(str, int)

Builds an ObjList of map settlements selected by owner and central-building class.

Settlement::GetEconomyScriptSettlementint Settlement::GetEconomyScript(int)Description pending

Description pending.

Settlement::RunEconomyScriptSettlementvoid Settlement::RunEconomyScript(int)Description pending

Description pending.

Settlement::GetTacticScriptSettlementint Settlement::GetTacticScript(int)

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

Settlement::RunTacticScriptSettlementvoid Settlement::RunTacticScript(int)

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

Settlement::UpgradeBestBarrackSettlementbool Settlement::UpgradeBestBarrack(int)Description pending

Description pending.

PrepareAiTransportShipGlobalShip PrepareAiTransportShip(int, int, int, str, point)

PrepareAiTransportShip conditionally builds an eight-byte handle result.

RUTypeGlobalint RUType(str, int)

Maps a class-name string to its zero-based entry in a race-specific six-name recruitable-unit table.

UTypeGlobalstr UType(int, int)

Looks up a managed unit-type string by type and race indices.

UTechGlobalstr UTech(int, int)

Selects a string from a race-indexed technology table and returns it as a managed CKS string.

UTrainCmdGlobalstr UTrainCmd(int, int)Description pending

Description pending.

UEnabledGlobalbool UEnabled(int, int)

Handler for this function, bool UEnabled(int mask, int bit): tests one bit of a mask.

CheckUEnabledGlobalbool CheckUEnabled(int, int, int, int, int)

CheckUEnabled updates an output bit mask from a unit-class count and threshold.

Squad::TakeNearbyItemsSquadbool Squad::TakeNearbyItems(int)

Selects an item holder near the squad leader and issues a getitems command.

FindTeleportGlobalObj FindTeleport(int, point, point)

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

Squad::UseTeleportSquadbool Squad::UseTeleport(Obj, int, str, point)

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

Squad::InvadeThroughGateSquadvoid Squad::InvadeThroughGate(Obj, int)Description pending

Description pending.

EvalGlobalvoid Eval(int, point, int, int, int, int)

Resolves three referenced output integers, delegates a spatial query, and writes its three results.

Unit::BestMDPosUnitpoint 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.

Unit::BestProtPosUnitObj Unit::BestProtPos(int, int, int, int)

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

IsProtectedGlobalbool IsProtected(int, point, str)

IsProtected clamps coordinates and normalizes a local query flag.

NeedTrainingGlobalbool NeedTraining(int)

Compares a player's sampled unit-level average with a threshold derived from allied players' sampled armies.

IsAIPlayerGlobalbool IsAIPlayer(int)

IsAIPlayer returns true for player ids 1 through 16 whose selected player record has a non-null AI pointer, otherwise false.

Hero::AIGetSkillToDevelopHerovoid Hero::AIGetSkillToDevelop(int&, int&)

Initializes two output references, evaluates 25 Hero skill slots through mutable target and weight references, and scans a virtual draw against admitted weights.

GAIKA::GetAIControlledUnitsGAIKAObjList 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::TSRecruitArmySettlementObjList Settlement::TSRecruitArmy(str, int)

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

ArenaTrainCmdGlobalstr ArenaTrainCmd(int)

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

Settlement::TSArenaRecruitSettlementObjList Settlement::TSArenaRecruit(int)

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

ArenaUTechGlobalstr ArenaUTech(int)

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

ArenaUTypeGlobalstr ArenaUType(int)

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

Settlement::TSTempleRecruitSettlementObjList Settlement::TSTempleRecruit(int)

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

TempleUTypeGlobalstr TempleUType(int)

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

TempleUTrainGlobalstr TempleUTrain(int)

Selects a native string pointer by a signed index and builds an eight-byte managed script-string result.

SelSquadGlobalvoid SelSquad(int, int)

SelSquad player-index overload submits resolved squad members.

PrGAIKAStratGlobalvoid PrGAIKAStrat(GAIKA, int)

PrGAIKAStrat formats the named strategy query result.

vgGlobalvoid vg(int)

vg requests camera centering and diagnostics for a narrowed GAIKA.

SS_STRGlobalstr SS_STR(int)

SS_STR allocates a string for a signed state selector.

GS_STRGlobalstr GS_STR(int)

GS_STR allocates a string for a signed strategy selector.

AIVGlobalvoid AIV(int)

AIV integer overload passes a decremented player and empty prefix.

AIVGlobalvoid AIV(int, str)

AIV string overload unlinks and releases its prefix operand.

DbgAIGlobalvoid DbgAI(int)

DbgAI formats an AI profile under an upper-only player gate.

DbgArmyGlobalvoid DbgArmy(int)

DbgArmy queries fifty class names and prints nonzero results.

dpGlobalvoid dp(int)

Emits priority notifications for a bounded prefix of the local player's AI records.

LsaStrGlobalstr LsaStr(int)Description pending

Description pending.

AIVarGlobalint AIVar(int, int)

AIVar returns the selected player AI variable when its player, index, record and table checks pass, otherwise zero.

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

SetAIVarGlobalvoid SetAIVar(int, int, int)

SetAIVar updates the selected player AI variable when its player, index, record and table checks pass, discarding the write otherwise.

SetAIVarGlobalvoid SetAIVar(int, int, int, bool)

SetAIVar sets or clears bit (bit argument modulo 32) in an indexed dword reached through the selected player record.

AIRunGlobalvoid AIRun(int, str)

Native adapter for this function resolving a player script and dispatching 0 integer arguments.

AIRunGlobalvoid AIRun(int, str, int)

Native adapter for this function resolving a player script and dispatching 1 integer arguments.

AIRunGlobalvoid AIRun(int, str, int, int)

Native adapter for this function resolving a player script and dispatching 2 integer arguments.

AIRunGlobalvoid AIRun(int, str, int, int, int)

Native adapter for this function resolving a player script and dispatching 3 integer arguments.

AIRunGlobalvoid AIRun(int, str, int, int, int, int)

Native adapter for this function resolving a player script and dispatching 4 integer arguments.

AIRunGlobalvoid AIRun(int, str, int, int, int, int, int)

Native adapter for this function resolving a player script and dispatching 5 integer arguments.

AIIRunGlobalint AIIRun(int, str)

Native adapter for this function resolving a player script and dispatching 0 integer arguments.

AIIRunGlobalint AIIRun(int, str, int)

Native adapter for this function resolving a player script and dispatching 1 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int)

Native adapter for this function resolving a player script and dispatching 2 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int, int)

Native adapter for this function resolving a player script and dispatching 3 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int, int, int)

Native adapter for this function resolving a player script and dispatching 4 integer arguments.

AIIRunGlobalint AIIRun(int, str, int, int, int, int, int)

Native adapter for this function resolving a player script and dispatching 5 integer arguments.

GAIKA::AIRunGAIKAvoid GAIKA::AIRun(str, int)

Resolves a player script name and dispatches it as a registered command when found.

prGlobalvoid pr(int)

Displays an integer as a decimal number in the game's chat.

_PlaceGlobalvoid _Place(str, int, int)

Routes class creation, template validation and player-zero placement from console arguments.

SetPlayerGlobalvoid SetPlayer(int)Description pending

Description pending.

ActivateScreenShotsGlobalvoid ActivateScreenShots(int)

ActivateScreenShots preserves a nine-byte retry packet until stop.

ToggleScreenShotsGlobalvoid ToggleScreenShots(int)

ToggleScreenShots requests stop or compiles an activation call.

SpawnGlobalvoid Spawn(int, int)

Attempts independent argument-sized square grids for players zero and one, then centers a terrain-adjusted point.

InsDecorGlobalvoid InsDecor(int, int, int)

Writes an unmasked shifted decor value into the selected packed-grid word and dispatches a callback.

DelDecorGlobalvoid DelDecor(int, int)

Clears the selected 16-bit halfword of a packed-grid dword and dispatches a callback.

DeepWaterGlobalvoid DeepWater(int, int, int)

Forwards three VM integers and the full terrain rectangle to one worker.

RayOfLightGlobalvoid RayOfLight(int, int, int, int)

Gates on signed X and forwards all four VM integers to a six-argument worker.

ESGGlobalvoid ESG(int, int)

ESG filters packed squad entries and prints a local accumulator.

GSGlobalvoid GS(int)

GS prints a viewport cell identifier and a registered symbol.

cvar1Globalvoid cvar1(int)

Pops an integer and forwards it with /cvar1 to the property setter helper.

cvar2Globalvoid cvar2(int)

Pops an integer and forwards it with /cvar2 to the property setter helper.

TogglePtDrawGlobalvoid TogglePtDraw(int)

Toggles a native mask bit and sends the viewport rectangle to the dirty-rect marker.

_PlayersAllyGlobalvoid _PlayersAlly(int, int)Description pending

Description pending.

_PlayersShareControlGlobalvoid _PlayersShareControl(int, int)Description pending

Description pending.

_PlayersShareViewGlobalvoid _PlayersShareView(int, int)Description pending

Description pending.

_PlayersShareSupportGlobalvoid _PlayersShareSupport(int, int)Description pending

Description pending.

_PlayersMakeEnemiesGlobalvoid _PlayersMakeEnemies(int, int)Description pending

Description pending.

SetPlayerSettRaceGlobalvoid SetPlayerSettRace(int, int)Description pending

Description pending.

SetSettRaceGlobalvoid SetSettRace(str, int)Description pending

Description pending.

SetShortcutSelGlobalvoid SetShortcutSel(int, int, ObjList)

Native CKS binding writing eligible units from an ObjList into a numbered control group, validating the full 0..9 range.

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

UIShowTabGlobalvoid UIShowTab(int)

Consumes the requested tab integer but uses it only as a guard for a selection refresh helper.

BlurTerrainGlobalvoid BlurTerrain(int)

Narrows its integer to signed sixteen bits before terrain processing and refresh dispatch.

WaitIdleGlobalbool WaitIdle(Query, int)

Implements the registered WaitIdle blocking predicate and timeout paths.

WaitObjInQueryGlobalbool WaitObjInQuery(Obj, Query, int)

Implements the registered WaitObjInQuery blocking predicate and timeout paths.

WaitQueryCountBetweenGlobalbool WaitQueryCountBetween(Query, int, int, int)

Implements the registered WaitQueryCountBetween blocking predicate and timeout paths.

WaitCommonObjectsGlobalbool WaitCommonObjects(Query, Query, int)

Implements a blocking wait condition over two queries and schedules a retry interval when required.

WaitHealthBetweenGlobalbool WaitHealthBetween(Query, int, int, int)

Implements the registered WaitHealthBetween blocking predicate and timeout paths.

WaitSettlementCaptureGlobalbool WaitSettlementCapture(str, int, int)

Implements the registered WaitSettlementCapture blocking predicate and timeout paths.

WaitSettlementAlliedGlobalbool WaitSettlementAllied(str, int, int)

Waits until a named settlement is not allied with a requested player or a finite timeout expires.

WaitEnvStringEqualGlobalbool WaitEnvStringEqual(str, str, int)

Implements the registered WaitEnvStringEqual blocking predicate and timeout paths.

WaitEnvIntBetweenGlobalbool WaitEnvIntBetween(str, int, int, int)

Implements the registered WaitEnvIntBetween blocking predicate and timeout paths.

WaitAddNoteGlobalbool WaitAddNote(str, int)

Suspends a VM thread until a named note exists or the requested timeout expires.

WaitRemoveNoteGlobalbool WaitRemoveNote(str, int)

Suspends a VM thread while a named note remains active, subject to the requested timeout.

WaitConvRequestGlobalbool WaitConvRequest(Query, Query, int, Obj&, Obj&)Description pending

Description pending.

WaitUnitsInAreaGlobalbool WaitUnitsInArea(Query, str, int)

WaitUnitsInArea tests a nonempty query collection using the area acceptance helper.

WaitIdleUnitsInAreaGlobalbool WaitIdleUnitsInArea(Query, str, int)

WaitIdleUnitsInArea tests idle names in a nonempty area-filtered collection.

WaitEmptyQueryGlobalbool WaitEmptyQuery(Query, int)

WaitEmptyQuery completes true when query virtual slot [field] returns nonzero.

WaitNonEmptyQueryGlobalbool WaitNonEmptyQuery(Query, int)

WaitNonEmptyQuery completes true when query virtual slot [field] returns zero.

WaitConvRequestGlobalbool WaitConvRequest(Obj, Obj, int)Description pending

Description pending.

WaitPlayerChatGlobalvoid WaitPlayerChat(int&, str&, int)

WaitPlayerChat copies and removes a matching-stamp chat entry into output references.

UserNotificationGlobalvoid UserNotification(str, str, point, int)

Triggers a notification from two script strings and a point when the requested player matches the active player.

HasStarvingArmyGlobalbool HasStarvingArmy(int)Description pending

Description pending.

StarvingArmyPosGlobalObj StarvingArmyPos(int)Description pending

Description pending.

SetInnStateGlobalvoid SetInnState(str, str, int)Description pending

Description pending.

SetInnStateGlobalvoid SetInnState(Obj, int)Description pending

Description pending.

GotoGlobalvoid Goto(int, int)Description pending

Description pending.

StartPlayerScriptGlobalvoid StartPlayerScript(int, str)Description pending

Description pending.

StopPlayerScriptGlobalvoid StopPlayerScript(int, str)Description pending

Description pending.

GetPlayerScriptsCountGlobalint GetPlayerScriptsCount(int)

Registered handler that overwrites its integer argument slot with the constant eight.

GetPlayerScriptGlobalstr GetPlayerScript(int, int)

Returns one of eight stored script strings for a validated one-based player number.

ShowAnnouncementGlobalvoid ShowAnnouncement(int, str, str)

Consumes two strings and an integer selector. Calls the announcement operation for selectors from 1 to 16 using the corresponding receiver.

HideAnnouncementGlobalvoid HideAnnouncement(int, str)

Consumes a key and selector, and invokes the matched-node flag helper for a nonnull key and selectors1..16.

SetPlayerStatusGlobalvoid SetPlayerStatus(int, int, str, bool)

Forwards a player, key, string and importance flag to a global status store.

SetPlayerStatusGlobalvoid SetPlayerStatus(int, int, bool)

Forwards a player, key, and importance bool to the global player-status store when present.

ShowNotificationGlobalint ShowNotification(str, str, int, str, Obj)

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

HideNotificationGlobalvoid HideNotification(int)

Consumes an integer and conditionally forwards it to the notification helper.

Obj::MistActionObjvoid Obj::MistAction(int)

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.

Building::GetDefenderClsBuildingstr Building::GetDefenderCls(int)

Building::GetDefenderCls returns one of two Building strings for Outpost descendants according to selector 1 or 2.

Building::GetDefendersMaxBuildingint Building::GetDefendersMax(int)

Building::GetDefendersMax returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2.

Building::GetDefendersOutBuildingint Building::GetDefendersOut(int)

Returns one of two defender-out counters for buildings whose associated object derives from Outpost.

Building::GetStartLevelBuildingint Building::GetStartLevel(int)

Building::GetStartLevel returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2.

Building::GetEndLevelBuildingint Building::GetEndLevel(int)

Building::GetEndLevel returns Building field [field] or [field] for Outpost descendants and selectors 1 or 2.

PrintMsgGlobalvoid PrintMsg(int, str)

Consumes a managed string and player selector, conditionally printing its characters without releasing the payload.

SetTerritoryStateGlobalvoid SetTerritoryState(str, int)Description pending

Description pending.

GAIKA::SetControlFlagGAIKAvoid GAIKA::SetControlFlag(int, bool)

GAIKA::SetControlFlag sets or clears byte +2 mask 32 in the mapped player record.

GAIKA::GetControlFlagGAIKAbool GAIKA::GetControlFlag(int)

GAIKA::GetControlFlag returns whether mask 32 is set in byte [field] after bounded GAIKA record resolution.

GAIKA::ControlledNeighborsGAIKAint GAIKA::ControlledNeighbors(int)

Counts neighboring global GAIKA records matching the wrapped player index through an attached-object field chain.

EndGameGlobalvoid EndGame(int, bool, str)

The three-argument EndGame stores its message only when the decremented player matches the computed local index.

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

GAIKA::ApproachingSquadsGAIKAint GAIKA::ApproachingSquads(int, int)

ApproachingSquads adds cached squad evaluation for squads targeting the requested GAIKA whose leader-distance metric is below its threshold.

SetUseCountGlobalvoid SetUseCount(int)Description pending

Description pending.

Item::SetUseCountItemvoid Item::SetUseCount(int)

Stores the supplied 32-bit value in a base item field.

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.