CKS TYPECKS reference

SquadList

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

13 members0 return it5 accept it

Members

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

Member	Signature and description
`IsValid` Returns whether the signed SquadList index resolves within the native list-entry table. Open full entry → SquadList	`bool SquadList::IsValid()` Returns whether the signed SquadList index resolves within the native list-entry table.
`EOL` Tests whether a squad-list iterator is at its end. Open full entry → SquadList	`bool SquadList::EOL()` Tests whether a squad-list iterator is at its end.
`Rewind` Resolves a SquadList and resets its cursor to the start, returning whether an element is available. Open full entry → SquadList	`bool SquadList::Rewind()` Resolves a SquadList and resets its cursor to the start, returning whether an element is available.
`Next` Resolves a SquadList value and returns whether its cursor advance helper finds another element. Open full entry → SquadList	`bool SquadList::Next()` Resolves a SquadList value and returns whether its cursor advance helper finds another element.
`Cur` Resolves a SquadList cursor and returns the current packed Squad value from its chunked storage. Open full entry → SquadList	`Squad SquadList::Cur()` Resolves a SquadList cursor and returns the current packed Squad value from its chunked storage.
`Size` Returns the backing collection count for a resolved active SquadList cursor, otherwise zero. Open full entry → SquadList	`int SquadList::Size()` Returns the backing collection count for a resolved active SquadList cursor, otherwise zero.
`Eval` Returns the native evaluation helper result for a resolved active list, otherwise zero. Open full entry → SquadList	`int SquadList::Eval()` Returns the native evaluation helper result for a resolved active list, otherwise zero.
`Lock` Sets bit 3 on every squad record referenced by a resolved SquadList. Open full entry → SquadList	`void SquadList::Lock()` Sets bit 3 on every squad record referenced by a resolved SquadList.
`Unlock` Clears bit 3 on every squad record referenced by a resolved SquadList. Open full entry → SquadList	`void SquadList::Unlock()` Clears bit 3 on every squad record referenced by a resolved SquadList.
`Add` Creates a list entry when necessary and passes the supplied Squad low word to its append helper. Open full entry → SquadList	`void SquadList::Add(Squad)` Creates a list entry when necessary and passes the supplied Squad low word to its append helper.
`Select` Reconciles the current player selection and adds resolved members of the supplied squad list. Open full entry → SquadList	`void SquadList::Select(int)` Reconciles the current player selection and adds resolved members of the supplied squad list.
`Train` Partitions squad members and forwards train and enter state arguments to separate regrouping calls. Open full entry → SquadList	`int SquadList::Train(int, int, int, int, Obj)` Partitions squad members and forwards train and enter state arguments to separate regrouping calls.
`Dump` Prints diagnostics for list elements from the active cursor and advances that cursor to its end. Open full entry → SquadList	`void SquadList::Dump()` Prints diagnostics for list elements from the active cursor and advances that cursor to its end.

Return this type

No entries in the published catalog.

Accept this type

Member	Signature and description
`GAIKA::GetSquads`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].
`GAIKA::GetSquads`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.
`GAIKA::GetSquads`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.
`GAIKA::GetSquads`GAIKA	`void GAIKA::GetSquads(SquadList&, int, int, int)` Builds a SquadList from GAIKA squads filtered by relation and destination masks.
`Squadize`Global	`void Squadize(ObjList, SquadList, int)` CKS scripting primitive wrapper exposing Squadize(ObjList ol, SquadList *sl, int nState) to scenario and AI scripts.

Coverage and limits

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