Imperivm Modding WikiCKS · FORMATS · GUIDESEspañol
CKS TYPECKS reference

GAIKA

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

51 members16 return it3 accept it

Members

51

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

MemberSignature and description
ID

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

Open full entry →
GAIKA
int GAIKA::ID()

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

Empty

GAIKA::Empty returns whether the selected global GAIKA record dword [field] is zero, with true on explicit resolution failure.

Open full entry →
GAIKA
bool GAIKA::Empty()

GAIKA::Empty returns whether the selected global GAIKA record dword [field] is zero, with true on explicit resolution failure.

Type

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

Open full entry →
GAIKA
int GAIKA::Type()

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

Center

GAIKA::Center copies dwords +8 and +12 from a resolved GAIKA record, returning a zero point if no record resolves.

Open full entry →
GAIKA
point GAIKA::Center()

GAIKA::Center copies dwords +8 and +12 from a resolved GAIKA record, returning a zero point if no record resolves.

GetDestPoint

Returns a stored destination or derives an approach point for selected building configurations.

Open full entry →
GAIKA
point GAIKA::GetDestPoint(Unit)

Returns a stored destination or derives an approach point for selected building configurations.

settlement

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

Open full entry →
GAIKA
Settlement GAIKA::settlement()

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

GetSquads

The two-argument GetSquads replaces its referenced list with a fresh list of every packed squad ID in record [field].

Open full entry →
GAIKA
void GAIKA::GetSquads(SquadList&)

The two-argument GetSquads replaces its referenced list with a fresh list of every packed squad ID in record [field].

GetSquads

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

Open full entry →
GAIKA
void 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.

GetSquads

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

Open full entry →
GAIKA
void GAIKA::GetSquads(SquadList&, int, int)

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

GetSquads

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

Open full entry →
GAIKA
void GAIKA::GetSquads(SquadList&, int, int, int)

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

Eval

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

Open full entry →
GAIKA
int GAIKA::Eval(int)

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

Eval

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

Open full entry →
GAIKA
int GAIKA::Eval(int, int)

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

Eval

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

Open full entry →
GAIKA
int GAIKA::Eval(int, int, int)

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

Eval

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

Open full entry →
GAIKA
void GAIKA::Eval(int, int, int&, int&, int&, int&)

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

EvalNeighbors

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

Open full entry →
GAIKA
void GAIKA::EvalNeighbors(int, int, int&, int&, int&, bool)

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

Count

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

Open full entry →
GAIKA
void 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.

GetPriority

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Open full entry →
GAIKA
int GAIKA::GetPriority(int)Description pending

Description pending.

GetLAIKA

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

Open full entry →
GAIKA
int 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.

CalcPriority

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

Open full entry →
GAIKA
int GAIKA::CalcPriority(int)

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

SetPriority

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

Open full entry →
GAIKA
void GAIKA::SetPriority(int, int)

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

Prioritized

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

Open full entry →
GAIKA
bool GAIKA::Prioritized(int)

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

Explored

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

Open full entry →
GAIKA
bool GAIKA::Explored(int)

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

Explore

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

Open full entry →
GAIKA
void GAIKA::Explore(int, bool)

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

CanExplore

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

Open full entry →
GAIKA
bool GAIKA::CanExplore(int)

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

Revealed

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

Open full entry →
GAIKA
bool GAIKA::Revealed(int)

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

LastSeen

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

Open full entry →
GAIKA
int GAIKA::LastSeen(int)

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

NoAttack

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

Open full entry →
GAIKA
bool GAIKA::NoAttack(int)

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

SetNoAttack

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

Open full entry →
GAIKA
void GAIKA::SetNoAttack(int, bool)

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

NoRecruit

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

Open full entry →
GAIKA
bool GAIKA::NoRecruit(int)

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

SetNoRecruit

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

Open full entry →
GAIKA
void GAIKA::SetNoRecruit(int, bool)

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

GetDistToPlayers

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

Open full entry →
GAIKA
void GAIKA::GetDistToPlayers(int, int&, int&, int&)

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

GetDistToArmies

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

Open full entry →
GAIKA
int GAIKA::GetDistToArmies(int)

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

Count

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

Open full entry →
GAIKA
int 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.

MinNeed

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

Open full entry →
GAIKA
int GAIKA::MinNeed(int, int, int, int)

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

MaxNeed

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

Open full entry →
GAIKA
int 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.

Recruit

Behavior awaiting documentation.

Open full entry →
GAIKA
int GAIKA::Recruit(int, int, int, int)Description pending

Description pending.

GetStrat

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

Open full entry →
GAIKA
int GAIKA::GetStrat(int)

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

StratRunning

Behavior awaiting documentation.

The extension records this primitive, but does not yet provide a description of its behavior.

Open full entry →
GAIKA
int GAIKA::StratRunning(int)Description pending

Description pending.

RunStrat

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

Open full entry →
GAIKA
void GAIKA::RunStrat(int, int)

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

AllEnemiesInHolder

Reports the negation of an accumulator set by qualifying squads with a nonempty [field] member and leader word[field] equal to FFFF.

Open full entry →
GAIKA
bool GAIKA::AllEnemiesInHolder(int)

Reports the negation of an accumulator set by qualifying squads with a nonempty [field] member and leader word[field] equal to FFFF.

MilitaryPresence

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

Open full entry →
GAIKA
bool GAIKA::MilitaryPresence(int)

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

Neighbors

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

Open full entry →
GAIKA
int GAIKA::Neighbors()

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

Neighbor

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

Open full entry →
GAIKA
GAIKA GAIKA::Neighbor(int)

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

LSA

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

Open full entry →
GAIKA
int GAIKA::LSA()

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

GetAIControlledUnits

Builds an ObjList of eligible units controlled by a selected GAIKA record under class, relation and limit filters.

Open full entry →
GAIKA
ObjList GAIKA::GetAIControlledUnits(str, int, int, bool)

Builds an ObjList of eligible units controlled by a selected GAIKA record under class, relation and limit filters.

Dump

Dumps spatial coordinates, settlement type, squad counts, and AI player status for a specified GAIKA identifier to in-game chat and logs.

Open full entry →
GAIKA
void GAIKA::Dump()

Dumps spatial coordinates, settlement type, squad counts, and AI player status for a specified GAIKA identifier to in-game chat and logs.

AIRun

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

Open full entry →
GAIKA
void GAIKA::AIRun(str, int)

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

SetControlFlag

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

Open full entry →
GAIKA
void GAIKA::SetControlFlag(int, bool)

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

GetControlFlag

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

Open full entry →
GAIKA
bool GAIKA::GetControlFlag(int)

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

ControlledNeighbors

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

Open full entry →
GAIKA
int GAIKA::ControlledNeighbors(int)

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

ApproachingSquads

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

Open full entry →
GAIKA
int GAIKA::ApproachingSquads(int, int)

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

Return this type

16
MemberSignature and description
Squad::SrcGAIKASquadGAIKA Squad::SrcGAIKA()

The SrcGAIKA and DestGAIKA handlers return the squad record's 16-bit fields at [field] and [field], respectively.

Squad::DestGAIKASquadGAIKA Squad::DestGAIKA()

The SrcGAIKA and DestGAIKA handlers return the squad record's 16-bit fields at [field] and [field], respectively.

Squad::GAIKAInSquadGAIKA Squad::GAIKAIn()

Squad::GAIKAIn resolves the packed Squad value and returns the zero-extended 16-bit field at squad record [field].

Squad::AIDestSquadGAIKA Squad::AIDest()

Returns a squad's AI destination identifier with a stored-field fallback.

Squad::OrderDestSquadGAIKA Squad::OrderDest()

Resolves a Squad record and returns the order destination selected by a record helper.

GetGAIKAGlobalGAIKA GetGAIKA(int)

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

GetGAIKAGlobalGAIKA GetGAIKA(Obj)

Resolves an Obj handle and pushes the zero-extended low word returned by its object-position GAIKA helper.

GetGAIKAGlobalGAIKA GetGAIKA(point)

Obtains the GAIKA value associated with the point's coordinates in the AI map. Returns zero if that AI map is unavailable.

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::NeighborGAIKAGAIKA GAIKA::Neighbor(int)

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

NearestHospitalGlobalGAIKA NearestHospital(Squad)

Scores eligible friendly hospital strongholds for a squad and returns the best GAIKA index.

Settlement::GetGaikaSettlementGAIKA Settlement::GetGaika()

Returns the global AI table word associated with a Settlement.

ViewGAIKAGlobalGAIKA ViewGAIKA()

ViewGAIKA queries the converted viewport midpoint.

selgGlobalGAIKA selg()

Routes a selected candidate through direct GAIKA helpers or coordinate fallback and pushes a narrowed selector.

point::GetGAIKApointGAIKA point::GetGAIKA()

Shared handler for GetGAIKA and point::GetGAIKA that resolves a point through the global AI map.

Accept this type

3
MemberSignature and description
Squad::SendToSquadvoid Squad::SendTo(GAIKA, int)

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

SetMAIKAGlobalvoid SetMAIKA(GAIKA, GAIKA, GAIKA)

Validates three distinct GAIKA identifiers and delegates a relation update to the global AI context.

PrGAIKAStratGlobalvoid PrGAIKAStrat(GAIKA, int)

PrGAIKAStrat formats the named strategy query result.

Coverage and limits

48 / 51 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.