CKS TYPECKS reference

str

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

0 members70 return it344 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

70
MemberSignature and description
ParseStrGlobalstr ParseStr(str, str&)

Splits text at its first comma, returning a trimmed token and updating the output string.

GetFromStrGlobalstr GetFromStr(str, str)

Parses comma-delimited entries and compares each source key token against the supplied key for the source token length.

GetFromStrToEOLGlobalstr GetFromStrToEOL(str, str)

Finds a named space-delimited entry and returns its comma-terminated remainder as a managed string.

+Globalstr +(str, str)Description pending

Description pending.

StrMidGlobalstr StrMid(str, int, int)

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

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

Description pending.

[Globalstr& [(StrMap&, str)Description pending

Description pending.

Obj::raceStrObjstr Obj::raceStr()

Returns the canonical race key for the resolved object template race, or an empty string for invalid resolution.

Obj::raceStrPrefObjstr Obj::raceStrPref()

Returns the one-character prefix associated with the object's civilization.

Obj::raceStrPrefLowObjstr Obj::raceStrPrefLow()

Returns the civilization prefix in lowercase, or an empty string for an invalid value.

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::nameObjstr Obj::name()Description pending

Description pending.

Obj::classObjstr Obj::class()

Returns a managed copy of a resolved object's class-template name.

Obj::commandObjstr Obj::command()

Obj::command copies the resolved object's small-string field at [field] into a managed CKS string, or returns an empty string for an invalid handle.

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.

cmdparamGlobalstr cmdparam()

cmdparam returns a global command parameter or a fallback active-order string.

cmdwaitingGlobalstr cmdwaiting()

Returns the current selection's command-waiting string or an empty fallback.

rolloverGlobalstr rollover()

Concatenates two selected strings and pushes an owned managed string result.

rolloverGlobalstr rollover(Obj, bool)

Builds command rollover text from an order description, resource costs, and current affordability.

rolloverGlobalstr rollover(Obj, str, bool)

Builds object rollover text from order costs, class statistics, and optional affordability detail.

rolloverGlobalstr rollover(Obj, str)

Composes rollover text from an order description, a localized supplied key, and a secondary description.

rollover_descGlobalstr rollover_desc(Obj, str, bool)

Composes localized rollover text and conditionally appends the secondary order description.

Building::itemtypesBuildingstr Building::itemtypes()

Returns the Building template string registered as Building::itemtypes.

Building::GetSentryClassNameBuildingstr Building::GetSentryClassName()

Building::GetSentryClassName returns the Building template string stored at [field].

Unit::SpecialNameUnitstr Unit::SpecialName(int)

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

Hero::formationHerostr Hero::formation()

For a valid Hero, the formation getter copies the text of the shape object reached through Hero [field] and formation [field] into a VM string result; an invalid Hero returns an empty string.

GetRandomHeroClassGlobalstr GetRandomHeroClass(str, int)

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

HeroSkillNameGlobalstr HeroSkillName(int)

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

_ChooseGlobalstr _Choose(str, str)

Retains a native dialog pointer until its result text becomes available.

_ListClassesGlobalstr _ListClasses()

Dispatches enumeration on the known class-template registry and returns a managed copy.

_ListFolderGlobalstr _ListFolder(str)

Enumerates a VFS path and returns matching entry names joined by newlines.

_ListFolderExGlobalstr _ListFolderEx(str, str)

Filters VFS enumeration names by an ASCII case-insensitive suffix and joins matches with newlines.

_ListTerrainsGlobalstr _ListTerrains()

Appends the string member of each terrain record followed by a newline.

Settlement::nameSettlementstr Settlement::name()

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

Settlement::FirstBldClassSettlementstr Settlement::FirstBldClass()

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

ConvResultGlobalstr ConvResult(str)

Adapts a CKS string through the engine conversion helpers and returns a managed result string.

RunConvGlobalstr RunConv(str)

CKS native primitive that starts and presents a conversation directly by name.

_ListConvsGlobalstr _ListConvs()

Concatenates string keys from two native tree containers into a managed result.

EnvReadStringGlobalstr EnvReadString(str)

Consumes a managed key string, calls the environment string reader and pushes a managed string result.

EnvReadStringGlobalstr EnvReadString(Settlement, str)

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

EnvReadStringGlobalstr EnvReadString(Building, str)

Formats a building-scoped environment path and returns a managed string from its reader helper.

EnvReadStringGlobalstr EnvReadString(int, str)

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

GetConstStrGlobalstr GetConstStr(str)

Looks up a key under GamePlay and returns the resulting string or an empty fallback.

MapNameGlobalstr MapName()

MapName selects inline or pointed storage at game[field] and pushes an eight-byte managed string.

TranslateGlobalstr Translate(str)

Translate resolves a string through primary and fallback translation tables.

TranslatefGlobalstr Translatef(str, str)

Selects a translation table and formats one string value against a key.

TranslatefGlobalstr Translatef(str, str, str)

Translatef chooses a translation table and formats a key with two strings.

TranslatefGlobalstr Translatef(str, str, str, str)

Resolves a translation key and formats it with three string arguments.

Item::idItemstr Item::id()

Builds a VM string from the registered item base descriptor first string.

Item::nameItemstr Item::name()

Builds a VM string from the same descriptor string selected by Item id.

Item::display_nameItemstr Item::display_name()

Builds a VM string from the descriptor second string at [field].

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.

ArenaTrainCmdGlobalstr ArenaTrainCmd(int)

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

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.

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.

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.

LsaStrGlobalstr LsaStr(int)Description pending

Description pending.

GetFormDscGlobalstr GetFormDsc(str)Description pending

Description pending.

clockGlobalstr clock()

Formats the game counter at [field] as an hours-minutes-seconds string and returns a CKS string value.

GetPlayerScriptGlobalstr GetPlayerScript(int, int)

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

Building::GetDefenderClsBuildingstr Building::GetDefenderCls(int)

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

ConquestBonusGlobalstr ConquestBonus()Description pending

Description pending.

FormDescriptionGlobalstr FormDescription(str)Description pending

Description pending.

Accept this type

344
MemberSignature and description
WriteGlobalvoid Write(str)

Consumes the eight-byte managed string cell, delegates its pointer plus four to format %s, then decrements and conditionally releases the reference.

=Globalvoid =(str&, str)Description pending

Description pending.

StrCmpGlobalint StrCmp(str, str)

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

StrCatGlobalvoid StrCat(str&, str)

Appends the second string to the first, modifying the first string.

ParseStrGlobalstr ParseStr(str, str&)

Splits text at its first comma, returning a trimmed token and updating the output string.

StrStrGlobalbool StrStr(str, str)

Checks whether a string contains another string.

GetFromStrGlobalstr GetFromStr(str, str)

Parses comma-delimited entries and compares each source key token against the supplied key for the source token length.

GetFromStrToEOLGlobalstr GetFromStrToEOL(str, str)

Finds a named space-delimited entry and returns its comma-terminated remainder as a managed string.

+Globalstr +(str, str)Description pending

Description pending.

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.

IsNullGlobalbool IsNull(str)

Checks whether the string pointer is null. A nonnull string also undergoes reference-count cleanup.

StrLenGlobalint StrLen(str)

Returns the length of a CKS string in bytes.

StrMidGlobalstr StrMid(str, int, int)

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

Str2IntGlobalint Str2Int(str)

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

==Globalbool ==(str, str)Description pending

Description pending.

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

Description pending.

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

Description pending.

[Globalstr& [(StrMap&, str)Description pending

Description pending.

StrMap::eraseStrMapvoid StrMap::erase(str)Description pending

Description pending.

StrMap::existsStrMapbool StrMap::exists(str)Description pending

Description pending.

_RandomTerrain2Globalvoid _RandomTerrain2(str)

Routes a managed filename to a map worker and conditionally reports a nonzero return.

GetClassRaceGlobalint GetClassRace(str)

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

Obj::IsHeirOfObjbool Obj::IsHeirOf(str)

Obj::IsHeirOf delegates class ancestry testing for a resolved Obj.

Obj::CmdCountObjint Obj::CmdCount(str)

Counts queued commands with the specified name.

Obj::AddCommandObjvoid Obj::AddCommand(bool, str)

creates and enqueues a named command on a target object.

Obj::AddCommandObjvoid Obj::AddCommand(bool, str, point)

Adds a named command with a point as its target.

Obj::AddCommandObjvoid Obj::AddCommand(bool, str, Obj)

Adds a named command with an object as its target.

Obj::SneakCommandObjvoid Obj::SneakCommand(str)

Creates a named command under local guards, submits two candidates and updates command state.

Obj::SetCommandObjvoid Obj::SetCommand(str)

Creates and submits a named command for the object, without an additional target.

Obj::SetCommandObjvoid Obj::SetCommand(str, point)

Creates and submits a named command for the object with a point as its target.

Obj::SetCommandObjvoid Obj::SetCommand(str, Obj)

Creates and submits a named command for the object with another object as its target.

Obj::ExecCmdObjvoid Obj::ExecCmd(str, point, Obj, bool)

Validates an object and named command, then dispatches it with script arguments.

Obj::CmdDisableObjvoid Obj::CmdDisable(str)

Resolves the supplied command name through registry virtual [field] and dispatches nonnegative results through object virtual [field].

Obj::CmdEnableObjvoid Obj::CmdEnable(str)

Resolves the supplied command name through registry virtual [field] and dispatches nonnegative results through object virtual [field].

Obj::IsInGroupObjbool Obj::IsInGroup(str)

Looks up the string key and returns the normalized result of found-group virtual [field] for the resolved Obj.

Obj::AddToGroupObjvoid Obj::AddToGroup(str)

Adds the object to a named group, creating the group if necessary.

Obj::RemoveFromGroupObjvoid Obj::RemoveFromGroup(str)

Looks up the supplied string key and calls [field] with the found object and resolved Obj when lookup status is zero.

Obj::SetNameObjvoid Obj::SetName(str)

Passes the string payload pointer and the resolved Obj to an implementation operation.

Obj::AddItemObjbool Obj::AddItem(str)

Attempts to add an item with the specified name and returns whether it succeeded.

Obj::FindItemObjItem Obj::FindItem(str)Description pending

Description pending.

Obj::RemoveItemObjvoid Obj::RemoveItem(str)

RemoveItem str dispatches removal after nonnegative name lookup.

Obj::ExchangeItemObjbool Obj::ExchangeItem(Item, str)

ExchangeItem returns true after a gated replacement dispatch.

Obj::RemoveItemsOfTypeObjint Obj::RemoveItemsOfType(str)

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

Obj::prObjvoid Obj::pr(str)

Formats the supplied HX string under a receiver-field gate and releases it on every normal path.

rolloverGlobalstr rollover(Obj, str, bool)

Builds object rollover text from order costs, class statistics, and optional affordability detail.

rolloverGlobalstr rollover(Obj, str)

Composes rollover text from an order description, a localized supplied key, and a secondary description.

rollover_descGlobalstr rollover_desc(Obj, str, bool)

Composes localized rollover text and conditionally appends the secondary order description.

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.

Obj::PlaySoundObjvoid Obj::PlaySound(str)

Adapts script string and object arguments to the spatial sound playback method [field] and releases the string reference.

Obj::ShowFloatTextObjvoid Obj::ShowFloatText(str)

Submits string payload with a virtual point whose second coordinate is decreased by 120.

GroupGlobalQuery Group(str)

Looks up a named group query and conditionally constructs and registers a replacement before returning its managed Query value.

GetGroupSizeGlobalint GetGroupSize(str)

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

SpawnGroupGlobalObjList SpawnGroup(str)

Looks up a named group, processes its live unit members through the world-spawn helper, and returns its resulting ObjList.

SpawnGroupInHolderGlobalObjList SpawnGroupInHolder(str, str)

Resolves a named group and named holder, forces eligible group units into that holder, and returns the processed-unit ObjList.

SpawnGroupInHolderGlobalObjList SpawnGroupInHolder(str, Obj)

Resolves a named group and an Obj receiver's virtual holder, forces eligible group units into it, and returns the processed-unit ObjList.

SpawnNamedGlobalObj SpawnNamed(str)

Looks up a named query and routes its current member through spawn and handle allocation.

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.

BuildingsInSettlementGlobalQuery BuildingsInSettlement(str, str)Description pending

Description pending.

UnitsInSettlementGlobalQuery UnitsInSettlement(str, str)Description pending

Description pending.

UnitsAroundSettlementGlobalQuery UnitsAroundSettlement(str, str)Description pending

Description pending.

UnitsGuardingSettlementGlobalQuery UnitsGuardingSettlement(str, str)Description pending

Description pending.

UnitsInSettlementGlobalQuery UnitsInSettlement(Settlement, str)Description pending

Description pending.

UnitsAroundSettlementGlobalQuery UnitsAroundSettlement(Settlement, str)Description pending

Description pending.

UnitsGuardingSettlementGlobalQuery UnitsGuardingSettlement(Settlement, str)Description pending

Description pending.

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.

AreaObjsGlobalQuery AreaObjs(str, str)Description pending

Description pending.

ObjsInRectGlobalQuery ObjsInRect(rect, str)

Builds a query from an inclusive rectangle and a resolved script-class filter.

ObjsInCircleGlobalQuery ObjsInCircle(point, int, str)

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

ObjsInSightGlobalQuery ObjsInSight(Obj, str)

Builds a class-filtered query of objects visible to a resolved object.

VisibleObjsInSightGlobalQuery VisibleObjsInSight(Obj, str)

Builds a visibility-mode class-filtered Query around a resolved Obj.

ObjsInRangeGlobalQuery ObjsInRange(Obj, str, int)

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

AttachedUnitsGlobalQuery AttachedUnits(Hero, str)

Builds a class-filtered query of units attached to a resolved hero.

Query::AddCommandQueryvoid Query::AddCommand(bool, str)

Dispatches factory mode zero for each live Query member and installs nonnull results with the normalized bool.

Query::AddCommandQueryvoid Query::AddCommand(bool, str, point)

Dispatches factory mode one with the unchanged point pair for each live Query member and installs nonnull results.

Query::AddCommandQueryvoid Query::AddCommand(bool, str, Obj)

Dispatches factory mode two with the raw Obj pair after validating its low-word registry slot, installing nonnull results on live Query members.

Query::AddCommandOffsetQueryvoid Query::AddCommandOffset(bool, str, point)

Transforms each live member position by requested point minus live-member average, then dispatches mode one without local clamping.

Query::SetCommandQueryvoid Query::SetCommand(str)

Calls virtual [field](0) before mode-zero factory dispatch and calls [field](0) after each live member attempt.

Query::SetCommandQueryvoid Query::SetCommand(str, point)

Creates and installs the requested point command on each valid object selected by a Query.

Query::SetCommandQueryvoid Query::SetCommand(str, Obj)

Constructs and installs an object-targeted command for each live member of a resolved Query.

Query::SetCommandOffsetQueryvoid Query::SetCommandOffset(str, point)

Translates member positions relative to the live-member average and clamps them before factory mode-one dispatch, after virtual [field](0).

AttackAreaGlobalvoid AttackArea(Query, str)

Routes Query and area name to the shared dispatcher with the advance literal.

MoveToAreaGlobalvoid MoveToArea(Query, str)

Routes Query and area name to the shared dispatcher with the move literal.

Query::AddToGroupQueryvoid Query::AddToGroup(str)

Dispatches live query members to the named group collection.

Query::RemoveFromGroupQueryvoid Query::RemoveFromGroup(str)

Removes each live object in the query from the named group.

Query::InHolderQueryint Query::InHolder(str)

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

Query::AddToHolderQueryvoid Query::AddToHolder(str)

Attempts forced holder entry for unit-compatible members of the query.

GetNamedObjGlobalNamedObj GetNamedObj(str)

Returns a NamedObj reference for a named query, creating that query if it does not exist yet.

Building::ResearchBuildingvoid Building::Research(str)

Resolves a named command descriptor and invokes research with temporary command-cost context.

Unit::BestTargetInSquadSightUnitObj Unit::BestTargetInSquadSight(str)

Finds the best tactical target within squad sight matching the supplied class filter string.

Unit::BestTargetInSquadSightExclusiveUnitObj Unit::BestTargetInSquadSightExclusive(str)

Calls squad-sight target search with string data and the exclusive option set.

GetPlayerUnitsGlobalObjList GetPlayerUnits(int, str)

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

Unit::MutateUnitvoid Unit::Mutate(str)

Resolves a named class template and dispatches Unit mutation or a deferred mutation state.

Hero::SetFormationHerovoid Hero::SetFormation(str)

SetFormation resolves the supplied string in the formation map and, when found and Hero [field] exists, passes the string text to the formation object shape-setting helper; unknown names and invalid Heroes call the error helper.

GetRandomHeroClassGlobalstr GetRandomHeroClass(str, int)

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

HeroSkillIdGlobalint HeroSkillId(str)

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

_ScriptEditorGlobalvoid _ScriptEditor(str)

Consumes a managed directory string and dispatches the editor constructor.

_DialogEditorGlobalvoid _DialogEditor(str)

Consumes a CKS string and passes its character data to the dialog constructor.

_ChooseGlobalstr _Choose(str, str)

Retains a native dialog pointer until its result text becomes available.

_ListFolderGlobalstr _ListFolder(str)

Enumerates a VFS path and returns matching entry names joined by newlines.

_ListFolderExGlobalstr _ListFolderEx(str, str)

Filters VFS enumeration names by an ASCII case-insensitive suffix and joins matches with newlines.

BuildMiniMapGlobalvoid BuildMiniMap(str)

Consumes a managed script string and forwards a temporary native string to the minimap builder.

GetSettlementGlobalSettlement GetSettlement(str)

Returns the first settlement whose name matches the supplied text.

Settlement::FindSettlementBuilding Settlement::Find(str)

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

Settlement::ObjectsAroundSettlementObjList Settlement::ObjectsAround(str)

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

ItemHolder::AddItemItemHolderbool ItemHolder::AddItem(str)

Submits a non-null named candidate to virtual slot [field] and returns candidate existence.

ItemHolder::HasItemItemHolderbool ItemHolder::HasItem(str)

Scans indexed holder entries for exact equality with the supplied string.

ItemHolder::RemoveItemItemHoldervoid ItemHolder::RemoveItem(str)

Dispatches virtual removal for the first indexed entry whose derived string equals the supplied name.

Settlement::CreateShipSettlementShip Settlement::CreateShip(str)

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

ObjList::AddToGroupObjListvoid ObjList::AddToGroup(str)

The handler looks up the named group, creates a group object on the nonzero lookup branch, then traverses the receiver list.

ObjList::RemoveFromGroupObjListvoid ObjList::RemoveFromGroup(str)

The handler looks up the supplied group name.

ObjList::AddCommandObjListvoid ObjList::AddCommand(bool, str)

Creates and enqueues a named command for every eligible object-list member.

ObjList::AddCommandObjListvoid ObjList::AddCommand(bool, str, point)

For each resolved eligible member, creates a named point command with selector 1 and submits it through virtual [field] using the supplied Boolean.

ObjList::AddCommandObjListvoid ObjList::AddCommand(bool, str, Obj)

After validating the supplied Obj handle, creates a named object-target command with selector 2 for each eligible member and submits it through virtual [field] using the Boolean.

ObjList::AddCommandOffsetObjListvoid ObjList::AddCommandOffset(bool, str, point)

Creates point-targeted commands for object-list members while preserving their offsets from the list center.

ObjList::ExecCmdObjListvoid ObjList::ExecCmd(str, point, Obj, bool)

Looks up the supplied command string through the command-order registry virtual [field]; on success passes the resolved command and remaining arguments to [field], while the failure path reports an invalid command.

ObjList::SetCommandObjListvoid ObjList::SetCommand(str)

For each resolved eligible member, calls virtual [field] with zero, creates the named command with selector 0, submits it through virtual [field] with false, and updates command state.

ObjList::SetCommandObjListvoid ObjList::SetCommand(str, point)

For each resolved eligible member, calls virtual [field] with zero, creates a named point command with selector 1, submits it through virtual [field] with false, and updates command state.

ObjList::SetCommandObjListvoid ObjList::SetCommand(str, Obj)

After validating the receiver and target Obj, calls virtual [field] with zero on each eligible member, creates an object-target command with selector 2, submits it through virtual [field] with false, and updates command state.

ObjList::SetCommandOffsetObjListvoid ObjList::SetCommandOffset(str, point)

Computes the list center, offsets each eligible member position from that center, clamps the translated target to map bounds, then creates and submits a selector-1 point command after virtual [field].

ObjList::GetCanExecCmdObjListObjList ObjList::GetCanExecCmd(str)

Allocates a new ObjList, resolves the command through the command-order registry virtual [field], and copies slots of valid source members whose virtual [field] predicate accepts that command.

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

ObjList::AddToHolderObjListvoid ObjList::AddToHolder(str)

Moves compatible units from the list into the named settlement.

ObjList::ObjClassObjListObjList ObjList::ObjClass(str)

Filters an ObjList by class-template ancestry.

ObjList::FindObjListObj ObjList::Find(str)

Returns the first live ObjList member matching a resolved class-template ancestry test.

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.

Conversation::InitConversationvoid Conversation::Init(str)

CKS Conversation Init adapter that replaces a referenced window and delegates named initialization.

Conversation::SetActorConversationvoid Conversation::SetActor(str, Unit)Description pending

Description pending.

Conversation::SetDefActorConversationvoid Conversation::SetDefActor(str, str)Description pending

Description pending.

ActorPresentGlobalbool ActorPresent(str)Description pending

Description pending.

ConvResultGlobalstr ConvResult(str)

Adapts a CKS string through the engine conversion helpers and returns a managed result string.

ConvSetResultGlobalvoid ConvSetResult(str, str)Description pending

Description pending.

RunConvGlobalstr RunConv(str)

CKS native primitive that starts and presents a conversation directly by name.

EnvWriteStringGlobalvoid EnvWriteString(str, str)

Pops value and key managed strings and delegates their payloads to the environment writer.

EnvWriteIntGlobalvoid EnvWriteInt(str, int)Description pending

Description pending.

EnvReadStringGlobalstr EnvReadString(str)

Consumes a managed key string, calls the environment string reader and pushes a managed string result.

EnvReadIntGlobalint EnvReadInt(str)

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

EnvWriteObjGlobalvoid EnvWriteObj(str, Obj)

Encodes a resolved object identifier as decimal marker text and delegates it with the key.

EnvReadObjGlobalObj EnvReadObj(str)

Delegates key lookup and writes an eight-byte result with initialized low16 identifier and zero offset.

EnvWriteStringGlobalvoid EnvWriteString(Settlement, str, str)

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

EnvWriteIntGlobalvoid EnvWriteInt(Settlement, str, int)

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

EnvReadStringGlobalstr EnvReadString(Settlement, str)

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

EnvReadIntGlobalint EnvReadInt(Settlement, str)

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

EnvWriteObjGlobalvoid EnvWriteObj(Settlement, str, Obj)Description pending

Description pending.

EnvReadObjGlobalObj EnvReadObj(Settlement, str)Description pending

Description pending.

EnvWriteStringGlobalvoid EnvWriteString(Building, str, str)

Formats a building-scoped environment path and delegates the value string to the environment writer.

EnvWriteIntGlobalvoid EnvWriteInt(Building, str, int)

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

EnvReadStringGlobalstr EnvReadString(Building, str)

Formats a building-scoped environment path and returns a managed string from its reader helper.

EnvReadIntGlobalint EnvReadInt(Building, str)

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

EnvWriteObjGlobalvoid EnvWriteObj(Building, str, Obj)

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

EnvReadObjGlobalObj EnvReadObj(Building, str)

Formats a building-scoped key and writes an Obj result with initialized low16 identifier and zero offset.

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.

EnvListGlobalvoid EnvList(str)Description pending

Description pending.

EnvListGlobalvoid EnvList(Settlement, str)Description pending

Description pending.

EnvFindGlobalvoid EnvFind(str)Description pending

Description pending.

EnvExportGlobalvoid EnvExport(str)

Consumes a filename and dispatches the serializer-produced buffer to a VFS stream.

RegisterSettlementUpgradeGlobalvoid RegisterSettlementUpgrade(Settlement, str)

Parses command-definition triples and dispatches settlement property writes.

RegisterPlayerUpgradeGlobalvoid RegisterPlayerUpgrade(int, str)

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

RunSequenceGlobalvoid RunSequence(str)

Validates a named sequence and starts the matching sequence when validation succeeds.

IsRunningGlobalbool IsRunning(str)

IsRunning tests exact provider text Running.

IsWaitingGlobalbool IsWaiting(str)

IsWaiting tests exact provider text Waiting.

IsFinishedGlobalbool IsFinished(str)

IsFinished tests exact provider text Finished.

PlayMusicGlobalvoid PlayMusic(str)

PlayMusic dispatches a guarded named sound request.

PlaySoundGlobalvoid PlaySound(str)

plays a global 2D non-spatial sound effect via the sound manager.

PlaySoundGlobalvoid PlaySound(int, str)

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

_RunGlobalbool _Run(str)

_Run returns true only after both compile and map scheduling helpers return zero.

RunGlobalvoid Run(str)

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

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.

Settlement::RunSettlementvoid Settlement::Run(str)

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

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.

GetConstStrGlobalstr GetConstStr(str)

Looks up a key under GamePlay and returns the resulting string or an empty fallback.

ExploreAreaGlobalvoid ExploreArea(int, str)

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

ChangeMapGlobalvoid ChangeMap(str, str)

ChangeMap looks up its first string in the game map table before forwarding mapped text and its second string.

SetNextSeasonGlobalvoid SetNextSeason(str)

SetNextSeason stores codes3,2,1 only for complete winter,autumn,spring matches.

PlayMovieGlobalbool PlayMovie(str)

PlayMovie returns the saved movie helper result as a bool.

TranslateGlobalstr Translate(str)

Translate resolves a string through primary and fallback translation tables.

TranslatefGlobalstr Translatef(str, str)

Selects a translation table and formats one string value against a key.

TranslatefGlobalstr Translatef(str, str, str)

Translatef chooses a translation table and formats a key with two strings.

TranslatefGlobalstr Translatef(str, str, str, str)

Resolves a translation key and formats it with three string arguments.

SaveAdventureGlobalvoid SaveAdventure(str)

SaveAdventure builds profile[field] slash payload dot-adv and forwards it on the initial phase.

AreaCenterGlobalpoint AreaCenter(str)

Returns area coordinates selected by its geometry mode field.

DisableAreaGlobalvoid DisableArea(str)

Clears a resolved area state field before a conditional thread request.

EnableAreaGlobalvoid EnableArea(str)

Dispatches a successfully resolved area to an enable helper.

GetRandomPointInAreaGlobalpoint GetRandomPointInArea(str)

Returns a helper point or a fixed pair when area lookup fails.

AreaDistToGlobalint AreaDistTo(point, str)

Computes a nonnegative area distance value after name resolution.

_AdvPlaceAreaRectGlobalvoid _AdvPlaceAreaRect(str, rect, str, str)

Spawns an AdvArea and forwards rectangle, name and string setup.

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

Spawns and configures a circular adventure area from script arguments.

GiveNoteGlobalvoid GiveNote(str)

Converts the script name to a native string and dispatches to the note-manager helper with a zero second argument.

RemoveNoteGlobalvoid RemoveNote(str)

Converts the script name to a native string and dispatches to the note-manager removal helper.

IsNoteActiveGlobalbool IsNoteActive(str)

Returns whether the input name has an exact case-sensitive key in the note-manager tree.

CreateFeedbackGlobalvoid CreateFeedback(str, Unit)

Resolves a Unit and a feedback class name, looks up its class template, and spawns the feedback visual/audio effect.

CreateFeedbackGlobalvoid CreateFeedback(str, Unit, int)

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

CreateFeedbackGlobalvoid CreateFeedback(str, point)

Constructs named feedback at a supplied point and initializes its scheduling field from the current game field.

CreateFeedbackGlobalvoid CreateFeedback(str, point, int)

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

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.

Squad::CountSquadint Squad::Count(str)

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

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.

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.

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.

AIExecCmdGlobalvoid AIExecCmd(Obj, str)Description pending

Description pending.

Settlement::FindBuildingSettlementBuilding Settlement::FindBuilding(str)

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

Settlement::FindResearchLabSettlementBuilding Settlement::FindResearchLab(str)

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

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

Description pending.

IsResearchedGlobalbool IsResearched(Settlement, str)

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

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(Settlement, str)

CKS scripting primitive reporting whether a technology or upgrade is currently in the "researching" state, with a settlement-anchored overload and a player-direct overload.

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.

GetCmdStaminaCostGlobalint GetCmdStaminaCost(str)

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

Settlement::CanAffordSettlementbool Settlement::CanAfford(str)

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

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

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

Settlement::MaxAffordCountSettlementint Settlement::MaxAffordCount(str)

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

Settlement::CanResearchSettlementbool Settlement::CanResearch(str)

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

Settlement::ResearchSettlementvoid Settlement::Research(str)

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

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

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

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

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

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.

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.

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.

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.

Obj::HasItemObjbool Obj::HasItem(str)

Calls a resolved object's virtual item-name lookup and returns whether its integer result is nonnegative.

Obj::UseItemObjbool Obj::UseItem(str)

Finds a named item on an Obj and runs its OnUse script when present.

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

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

EvalGroupGlobalint EvalGroup(str)

EvalGroup sums low-word evaluation contributions from group handles.

IsProtectedGlobalbool IsProtected(int, point, str)

IsProtected clamps coordinates and normalizes a local query flag.

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

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.

Settlement::TSResearchSettlementbool Settlement::TSResearch(str)

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

AIVGlobalvoid AIV(int, str)

AIV string overload unlinks and releases its prefix operand.

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.

Settlement::AIRunSettlementvoid Settlement::AIRun(str)

Resolves a script path for a settlement's player and submits a command for that path.

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

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

Squad::AIRunSquadvoid Squad::AIRun(str)

Forwards a packed squad value to a resolved registered script command.

AppendFileGlobalvoid AppendFile(str, str)

Retries opening a filename and dispatches content through stream virtual methods.

prGlobalvoid pr(str)

Displays the supplied text in the in-game message log and chat window.

_PlaceGlobalvoid _Place(str, int, int)

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

_SetCursorGlobalvoid _SetCursor(str)Description pending

Description pending.

ExportObjsGlobalvoid ExportObjs(str)

Selects a filename and routes a temporary map context to the object export worker.

ExportTerrainGlobalvoid ExportTerrain(str)

Selects a filename and routes a temporary map context to the terrain save wrapper.

SaveGlobalvoid Save(str)

Named Save and Load prefix Scenarios/ under a nonzero global or append.svg when no dot is present.

LoadGlobalvoid Load(str)

Named Save and Load prefix Scenarios/ under a nonzero global or append.svg when no dot is present.

ChMapGlobalvoid ChMap(str)

ChMap consumes its script string and forwards its unchanged payload to [field].

DlgGlobalvoid Dlg(str)

Constructs a menu object and routes a managed name plus fixed layout arguments to virtual calls.

SplashGlobalvoid Splash(str, str)

executes a modal introductory splash video/image sequence from INI configuration.

ChangeFormationGlobalvoid ChangeFormation(str)

Routes a managed shape name to a selected registry object form pointer.

TTestGlobalvoid TTest(str)

Resolves a translation key and prints the input and translated value to chat.

GetItemGlobalvoid GetItem(str)Description pending

Description pending.

_chsGlobalvoid _chs(str)Description pending

Description pending.

_SetNextSeasonGlobalvoid _SetNextSeason(str)

_SetNextSeason stores the parser result even when it is zero.

GetFormDscGlobalstr GetFormDsc(str)Description pending

Description pending.

SetSettRaceGlobalvoid SetSettRace(str, int)Description pending

Description pending.

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.

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.

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.

RunAIHelperGlobalvoid RunAIHelper(str, str)

Consumes 2 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str)

Consumes 3 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str, str)

Consumes 4 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str, str, str)

Consumes 5 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str, str, str, str)

Consumes 6 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str, str, str, str, str)

Consumes 7 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str, str, str, str, str, str)

Consumes 8 script strings and forwards their character data to the global AI helper invocation routine.

RunAIHelperGlobalvoid RunAIHelper(str, str, str, str, str, str, str, str, str)

Consumes 9 script strings and forwards their character data to the global AI helper invocation routine.

StopAIHelperGlobalvoid StopAIHelper(str)

Consumes a helper-name string and forwards a named task cancellation request.

IsAIHelperRunningGlobalbool IsAIHelperRunning(str)

Consumes a helper-name string and returns the helper name-table membership result.

GetInnStateGlobalint GetInnState(str, str)Description pending

Description pending.

SetInnStateGlobalvoid SetInnState(str, str, int)Description pending

Description pending.

GenTransGameGlobalvoid GenTransGame(str)Description pending

Description pending.

StartPlayerScriptGlobalvoid StartPlayerScript(int, str)Description pending

Description pending.

StopPlayerScriptGlobalvoid StopPlayerScript(int, str)Description pending

Description pending.

ShowAnnouncementGlobalvoid ShowAnnouncement(str, str)

Consumes two VM string arguments and calls the announcement table helper using receiver [field].

HideAnnouncementGlobalvoid HideAnnouncement(str)

Consumes a key string, looks it up in the table at [field], and sets a matched node field[field] to1.

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.

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.

PrintMsgGlobalvoid PrintMsg(int, str)

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

GetTerritoryStateGlobalint GetTerritoryState(str)

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

SetTerritoryStateGlobalvoid SetTerritoryState(str, int)Description pending

Description pending.

FormDescriptionGlobalstr FormDescription(str)Description pending

Description pending.

EndGameGlobalvoid EndGame(int, bool, str)

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

Coverage and limits

0 / 0 members with a published description.

These lists come from published signatures. “Accept” counts explicit parameters, excluding the method receiver; reference variants (&) are included. No inheritance hierarchy is asserted. Undocumented names, units and effects remain unresolved.