CKS TYPECKS reference

Wagon

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

11 members5 return it1 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
`amount` Wagon::amount returns the resolved object's 32-bit field at [field], or zero for an invalid handle. Open full entry → Wagon	`int Wagon::amount()` Wagon::amount returns the resolved object's 32-bit field at [field], or zero for an invalid handle.
`restype` Wagon restype returns the carried resource selector at [field], with zero on invalid resolution. Open full entry → Wagon	`int Wagon::restype()` Wagon restype returns the carried resource selector at [field], with zero on invalid resolution.
`SetFood` Selects the carried resource type and forwards the supplied amount to the wagon amount-update helper. Open full entry → Wagon	`void Wagon::SetFood(int)` Selects the carried resource type and forwards the supplied amount to the wagon amount-update helper.
`SetGold` Selects the carried resource type and forwards the supplied amount to the wagon amount-update helper. Open full entry → Wagon	`void Wagon::SetGold(int)` Selects the carried resource type and forwards the supplied amount to the wagon amount-update helper.
`LoadFood` Adapts Wagon resource loading through a selected pointer, signed capacity arithmetic and resource-store removal. Open full entry → Wagon	`void Wagon::LoadFood(int)` Adapts Wagon resource loading through a selected pointer, signed capacity arithmetic and resource-store removal.
`LoadGold` Adapts Wagon resource loading through a selected pointer, signed capacity arithmetic and resource-store removal. Open full entry → Wagon	`void Wagon::LoadGold(int)` Adapts Wagon resource loading through a selected pointer, signed capacity arithmetic and resource-store removal.
`loyalty` Wagon loyalty returns signed dword [field] divided by ten with truncation toward zero. Open full entry → Wagon	`int Wagon::loyalty()` Wagon loyalty returns signed dword [field] divided by ten with truncation toward zero.
`SetLoyalty` CKS-exposed setter that validates a 0..100 loyalty value and writes it, scaled by ten, to the wagon's loyalty field. Open full entry → Wagon	`void 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.
`DecreaseLoyalty` Behavior awaiting documentation. Open full entry → Wagon	`void Wagon::DecreaseLoyalty(int)`Description pending Description pending.
`StartCapture` Behavior awaiting documentation. Open full entry → Wagon	`void Wagon::StartCapture()`Description pending Description pending.
`StopCapture` Behavior awaiting documentation. Open full entry → Wagon	`void Wagon::StopCapture()`Description pending Description pending.

Return this type

Member	Signature and description
`Obj::AsWagon`Obj	`Wagon Obj::AsWagon()` Casts an Obj reference to the Wagon interface and returns a Wagon reference.
`Settlement::CreateMuleFood`Settlement	`Wagon Settlement::CreateMuleFood(int)` Delegates wagon creation with food mode one and returns a Wagon handle or sentinel.
`Settlement::CreateMuleGold`Settlement	`Wagon Settlement::CreateMuleGold(int)` Resolves a Settlement and delegates the amount to helper [field], returning a Wagon handle or sentinel.
`Settlement::CreateBoatFood`Settlement	`Wagon 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::CreateBoatGold`Settlement	`Wagon 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.

Accept this type

Member	Signature and description
`Settlement::UnloadWagon`Settlement	`void Settlement::UnloadWagon(Wagon)` UnloadWagon adds the wagon quantity to the linked settlement resource dword and clamps the wrapping sum by a signed comparison to its capacity.

Coverage and limits

8 / 11 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.