CKS TYPECKS reference

Ship

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

20 members5 return it0 accept it

Members

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

Return this type

Member	Signature and description
`Obj::AsShip`Obj	`Ship Obj::AsShip()` Casts an Obj reference to the Ship interface and returns a Ship reference.
`Unit::GetShip`Unit	`Ship Unit::GetShip()` Follows the Unit holder object's linked registry handle and returns that object's handle or an invalid Ship handle.
`Unit::GetShipToBoard`Unit	`Ship Unit::GetShipToBoard()`Description pending Description pending.
`Settlement::CreateShip`Settlement	`Ship 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.
`PrepareAiTransportShip`Global	`Ship PrepareAiTransportShip(int, int, int, str, point)` PrepareAiTransportShip conditionally builds an eight-byte handle result.

Accept this type

No entries in the published catalog.

Coverage and limits

14 / 20 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.

Member	Signature and description
`ShowBuildAnimation` Slides an already created ship from the shipyard exit along the given vector over about 800 milliseconds, like a launch. It is not a construction sequence. The game data only calls it from the shipyard script, after CreateShip and with the central building's exit vector. The position is updated during the slide. The visual result was not captured. Open full entry → Ship	`void Ship::ShowBuildAnimation(point)` Slides an already created ship from the shipyard exit along the given vector over about 800 milliseconds, like a launch. It is not a construction sequence.
`NotifyBoardUnit` Resolves Ship and Unit references and conditionally invokes the native boarding notification admission helper. ⚠ Only partly documented so far. Open full entry → Ship	`void Ship::NotifyBoardUnit(Unit)` Resolves Ship and Unit references and conditionally invokes the native boarding notification admission helper.
`AreUnitsToBoard` Cleans invalid or destroyed entries from a ship boarding list and reports whether any remain. Open full entry → Ship	`bool Ship::AreUnitsToBoard()` Cleans invalid or destroyed entries from a ship boarding list and reports whether any remain.
`BestCandidateToBoard` Behavior awaiting documentation. The extension records this primitive, but does not yet provide a description of its behavior. Open full entry → Ship	`Unit Ship::BestCandidateToBoard()`Description pending Description pending.
`BoardUnit` Behavior awaiting documentation. The extension records this primitive, but does not yet provide a description of its behavior. Open full entry → Ship	`bool Ship::BoardUnit(Unit)`Description pending Description pending.
`NotifyBoardUnitCancel` Behavior awaiting documentation. The extension records this primitive, but does not yet provide a description of its behavior. Open full entry → Ship	`void Ship::NotifyBoardUnitCancel(Unit)`Description pending Description pending.
`NotifyShipBoardingCancel` Behavior awaiting documentation. The extension records this primitive, but does not yet provide a description of its behavior. Open full entry → Ship	`void Ship::NotifyShipBoardingCancel()`Description pending Description pending.
`UnboardUnits` Selects candidate positions and dispatches a reserve and movement routine for matching ObjList members. Open full entry → Ship	`void Ship::UnboardUnits(ObjList)` Selects candidate positions and dispatches a reserve and movement routine for matching ObjList members.
`UnboardAllUnits` Resolves the Ship, builds a filtered position vector and repeatedly dispatches its first matching member while candidates and the saved-container count remain. Open full entry → Ship	`void Ship::UnboardAllUnits()` Resolves the Ship, builds a filtered position vector and repeatedly dispatches its first matching member while candidates and the saved-container count remain.
`FindPointToStay` FindPointToStay tries up to 100 points offset by two separate [-500,500] draws, requiring matching LSA, a clear occupancy bit and a nonzero clearance-helper result. Open full entry → Ship	`point Ship::FindPointToStay()` FindPointToStay tries up to 100 points offset by two separate [-500,500] draws, requiring matching LSA, a clear occupancy bit and a nonzero clearance-helper result.
`UnitsCount` Ship[field] is a Holder handle, and this function returns that Holder's current occupancy at [field]. Open full entry → Ship	`int Ship::UnitsCount()` Ship[field] is a Holder handle, and this function returns that Holder's current occupancy at [field].
`UnitsMax` Ship[field] is a Holder handle, and this function returns that Holder's capacity at [field]. Open full entry → Ship	`int Ship::UnitsMax()` Ship[field] is a Holder handle, and this function returns that Holder's capacity at [field].
`Idle` Initializes ship idle state when necessary and returns the VM blocking status. Open full entry → Ship	`void Ship::Idle()` Initializes ship idle state when necessary and returns the VM blocking status.
`HasAiTransport` HasAiTransport returns whether the resolved ship's string at [field] has nonzero length at [field]. Open full entry → Ship	`bool Ship::HasAiTransport()` HasAiTransport returns whether the resolved ship's string at [field] has nonzero length at [field].
`GetUnitsOnBoard` Copies the container at [field] of the object selected by the Ship's [field] handle. Open full entry → Ship	`ObjList Ship::GetUnitsOnBoard()` Copies the container at [field] of the object selected by the Ship's [field] handle.
`ApplyAiTransport` Behavior awaiting documentation. ⚠ Only partly documented so far. Open full entry → Ship	`void Ship::ApplyAiTransport()`Description pending Description pending.
`ClearAiTransport` Behavior awaiting documentation. The extension records this primitive, but does not yet provide a description of its behavior. Open full entry → Ship	`void Ship::ClearAiTransport()`Description pending Description pending.
`GetTransPt` Returns two 32-bit components from the resolved Ship as a point. Open full entry → Ship	`point Ship::GetTransPt()` Returns two 32-bit components from the resolved Ship as a point.
`IsBuilding` Ship::IsBuilding returns the one-byte predicate signed_dword(Ship[field])>0 for a resolved Ship and false for an unresolved handle. Open full entry → Ship	`bool Ship::IsBuilding()` Ship::IsBuilding returns the one-byte predicate signed_dword(Ship[field])>0 for a resolved Ship and false for an unresolved handle.
`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. Open full entry → Ship	`int 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.