Home › Dev CE (experimental) › PlayerUnits

PlayerUnits

26 methods (Dev CE test build). this is found with the game's own IPlayerUnits instance resolver (plain).

Details

AddEmbarkUnitPass

Arguments: eUnit — Unit type to grant the embark pass for

Writes - Embark unit pass vector at Units+0x2a0 (append)

Input checks: Ignores -1 (NO_UNIT); does not check for duplicates or that the type is valid.

Multiplayer: may-desync, edits synchronised player list. Risk: medium (Allows duplicates and writes player state.). Confidence of the reading: high.

AddRandomBasePromotion

Arguments: eUnit — Unit type to receive a random base promotion

Writes - Base promotion list (+0x3f8..0x400) via ChangeBasePromotionCount - Existing units' promotions via AssignBasePromotionsToUnits

Side effects - Consumes a game random roll labelled 'Random Base Promotion'

Input checks: Returns false for -1 or unit type without a definition; if no candidate remains passes -1 promotion (which fails).

Multiplayer: may-desync, uses game RNG and edits player units. Risk: high (Consumes RNG and promotes units.). Confidence of the reading: medium.

AddUnlimitedPromotionChoiceUnitType

Arguments: eUnit — Unit type to add

Writes - Unlimited-promotion-choice unit type vector at Units+0xe8

Input checks: Checks for duplicates only; no validity or -1 check.

Multiplayer: may-desync, edits synchronised player list. Risk: medium (Writes player state without range check.). Confidence of the reading: high.

AssignBasePromotionsToUnits

Writes - Each owned unit's experience/promotion data (+0x960 via SetPromotion)

Input checks: Skips when the player has no units; no other checks.

Multiplayer: may-desync, changes unit promotions. Risk: medium (Changes promotions of many units.). Confidence of the reading: high.

CanEmbark

Arguments: eUnit — Unit type to test

Input checks: Unit type bounds-checked against definitions; no null handling for owner beyond use.

Multiplayer: read-only, pure check of definitions and player state. Risk: low (Pure check.). Confidence of the reading: medium.

ChangeAddOnDistrictFounding

Arguments: districtHash — hash of the district type; unitHash — hash of the unit type; iDelta — amount added to the counter

Writes - nested hash map (district hash to unit hash to count) in the variant map at this+0x2c8; creates entries on demand

Side effects - allocates new map entries when keys are missing

Input checks: No validation of the hashes; any value creates an entry. Counts can go negative or stay at zero without removal.

Preconditions - gameplay Lua state only - must run on the game thread

Multiplayer: may-desync: direct replicated state write; hash maps must stay identical on all clients. Risk: low (hash-keyed counter with auto-create). Confidence of the reading: medium.

Verified from the code - outer map lookup/insert by district hash, inner lookup/insert by unit hash with initial 0, then adds iDelta

Inferred - nonzero count enables the unit to found that district; semantic taken from the name

Open questions - where the counters are read and how zero or negative values are treated

ChangeBasePromotionCount

Arguments: eUnit — Unit type of the base promotion; ePromotion — Promotion type; iDelta — Amount to add to the count (negative to remove)

Writes - Base promotion vector at Units+0x3e8 (entries of 12 bytes: unit, promotion, count)

Input checks: Returns false for -1 unit or promotion; no delta range check; no definition validity check.

Multiplayer: may-desync, edits synchronised player list. Risk: medium (Does not itself apply promotions to units.). Confidence of the reading: high.

ChangeExtraBuildCharges

Arguments: eUnit — unit type; iChange — delta to add

Writes - per-unit extra build charges array at this+0x318

Side effects - none

Input checks: silently ignores out-of-range or negative unit ids; result clamped to 0

Preconditions - gameplay thread

Multiplayer: safe-deterministic. Risk: low (bounds checked and clamped). Confidence of the reading: high.

Verified from the code - bounds check 0 <= unit < count at +0x338 - clamps negative sum to 0

Inferred - applies to newly created units of that type (not confirmed)

Open questions - whether existing units are updated

ChangeFreePass

Arguments: eBuildUnit — Unit type to add to the free pass list

Writes - Free pass unit vector at Units+0x278 (append) - Can-ever-train data via SetCanEverTrain

Input checks: No -1 or range check; appends even if present.

Multiplayer: may-desync, edits player list and buildability. Risk: medium (Unchecked append.). Confidence of the reading: medium.

ChangeProductionModifier

Arguments: eUnit — unit type index to modify; iDelta — amount to add (scaled by a small constant, then converted to a fixed-point int)

Writes - per-unit-type int array in a game variable at this+0x200 (production modifier, fixed point)

Side effects - marks the game variable as edited (FAutoVariable edit)

Input checks: Silently does nothing if the unit type is not below the array size; the unsigned compare also rejects negative ids.

Preconditions - gameplay state only - game thread

Multiplayer: may-desync: direct state change, must be applied identically on all clients. Risk: low (bounds-checked simple array add). Confidence of the reading: medium.

Verified from the code - bounds check against this+0x220 - multiplies delta by a float constant then splits into integer and fractional parts packed as integer part shifted by 8 plus 8-bit fraction - adds the packed value into the array slot

Inferred - value is a percentage-like modifier in 8.8 style fixed point - constant is likely 0.01

Open questions - exact constant value and the modifier semantics

DoEndTurn

Writes - Unit damage via Unit manager (fallout damage)

Side effects - Reporting events - Unit manager virtual calls

Input checks: Skips when the player has no units; decompilation is truncated so remaining logic is unknown.

Multiplayer: may-desync, damages units at turn end. Risk: high (Turn-processing function; output truncated.). Confidence of the reading: low.

DoTurnActivate

Writes - Per-resource vector at Units+0x5c8 - Unit Religion-related bool at unit +0x708

Side effects - Reporting event block 0x1153df52

Input checks: No argument; remaining logic is truncated.

Multiplayer: may-desync, turn-start processing of player state. Risk: high (Truncated; changes turn state.). Confidence of the reading: low.

GetCost

Arguments: eUnit — Unit type index

Input checks: Upper bound only (unsigned compare, so -1 returns 0).

Multiplayer: read-only, array lookup. Risk: low (Pure getter.). Confidence of the reading: high.

GetNumUnitsFromCity

Arguments: eUnitType — Unit type to count; cityID — Origin city ID (compared with unit field +0x8a0)

Input checks: None.

Multiplayer: read-only, counts owned units. Risk: low (Pure getter.). Confidence of the reading: high.

GetNumUnitsOfType

Arguments: eUnit — Unit type to count

Input checks: None.

Multiplayer: read-only, counts owned units. Risk: low (Pure getter.). Confidence of the reading: high.

GetResourceCost

Arguments: eUnit — Unit type; eMilitaryFormation — Formation: 1 corps (x2), 2 army (x3), else standard

Input checks: Bounds check on unit type; formation value not validated.

Multiplayer: read-only, array lookup. Risk: low (Pure getter.). Confidence of the reading: high.

IsProposedPromotion

Arguments: iUnitID — Unit ID; ePromotion — Promotion type

Input checks: None.

Multiplayer: read-only, list search. Risk: low (Pure getter.). Confidence of the reading: medium.

RemoveEmbarkUnitPass

Arguments: eUnit — Unit type to remove one pass for

Writes - Embark unit pass vector at Units+0x2a0 (rebuilt)

Input checks: Ignores -1; silently does nothing if the type is absent.

Multiplayer: may-desync, edits synchronised player list. Risk: medium (Removes only the first copy.). Confidence of the reading: high.

RemoveFreePass

Arguments: eUnit — Unit type to remove

Writes - Free pass vector at Units+0x278 (rebuilt) - Can-ever-train data

Input checks: No -1 check; absent type is a no-op rewrite.

Multiplayer: may-desync, edits player list and buildability. Risk: medium (Rewrites list.). Confidence of the reading: high.

RemoveUnlimitedPromotionChoiceUnitType

Arguments: eUnit — Unit type to remove

Writes - Unlimited-promotion-choice vector at Units+0xe8

Input checks: No-op if absent; no -1 check.

Multiplayer: may-desync, edits synchronised player list. Risk: medium (Writes player state.). Confidence of the reading: high.

SetBannedProductionYield

Arguments: eNewYield — yield type that is banned for unit production

Writes - banned yield value in a tracked variable at this+0x568 - city build queues (PopFront) in each city of the player

Side effects - pops the front item of the build queue of cities whose current production is a unit whose formation class is not 2

Input checks: Unit index is bounds checked against definition list (null definition otherwise, which would then be dereferenced - crash risk). No validation of the yield value.

Preconditions - gameplay state - player with a city list

Multiplayer: may-desync: edits city queues, must run identically everywhere. Risk: medium (mutates build queues; possible null deref on bad definition). Confidence of the reading: medium.

Verified from the code - assigns new yield into this+0x568 via CopyAssignmentDo - only loops when int at this+0x578 equals 1 - loops over cities of player and pops queue front when current unit formation class != 2

Inferred - formation class 2 is probably a civilian or special class - this+0x578 is probably a flag that the ban is active

Open questions - meaning of the 0x578 field and formation class 2 - helper template name suggests different type but writes a YieldTypes

SetCanEverTrain

Writes - per-unit can-ever-train array at this+0x118 (reset to -1, then set to unit index when allowed)

Side effects - resizes and refills the table

Input checks: null definitions handled; per-unit pointers in the definition list assumed non-null

Preconditions - owning player set at this+0x90 - definitions loaded

Multiplayer: safe-deterministic. Risk: medium (bulk rebuild of cached table). Confidence of the reading: medium.

Verified from the code - array at +0x118 set to definition count entries of -1 - units in list at +0x288 are marked allowed immediately - entries with +0x128 value -1 get checked further against level hash cases and properties - unit removed (set to -1) by flag bits at +0x1b8/+0x1b9 or when definition field +0x2d0 not in civ/leader lists - also marks replaced units from list at +0x2b0

Inferred - level hash constants select property hashes for civilization levels (e.g. city-state/free city) - list at +0x2b0 is unit replacement or upgrade targets

Open questions - meaning of the hash constants and flag bits - the function exits through the definition loop end; any additional state set is not seen

SetCorpsArmyUnlockCivic

Arguments: bLand — True for land units, false for naval; bCorps — True for corps slot, false for army slot; eCivic — Civic type that unlocks the formation

Writes - One of four unlock-civic fields in Player::Units

Input checks: No range checks on civic.

Multiplayer: may-desync, writes player field. Risk: low (Single field write.). Confidence of the reading: high.

SetCorpsArmyUnlockTech

Arguments: bLand — True for land units, false for naval; bCorps — True for corps slot, false for army slot; eTech — Tech type that unlocks the formation

Writes - One of four unlock-tech fields in Player::Units

Input checks: No range checks on tech.

Multiplayer: may-desync, writes player field. Risk: low (Single field write.). Confidence of the reading: high.

SetModifiedArmyCorpsStrength

Arguments: bLand — true selects land slots, false naval slots (inferred); bCorps — true selects corps, false army (inferred); iAmount — amount added to the current value

Writes - one of four tracked ints at this+0x4d8, 0x4f0, 0x508, 0x520 (value at +0x10 of each)

Side effects - tracked variable assignment, may notify variable system

Input checks: No validation; any int accepted.

Preconditions - gameplay state

Multiplayer: may-desync: direct state change. Risk: low (simple add to fixed slot). Confidence of the reading: medium.

Verified from the code - four-way selection by two bools - new value is old value plus iAmount (despite the Set name it adds)

Inferred - bool meanings (land vs sea, corps vs army) are deduced from the name

Open questions - which bool order maps to which slot is deduced only from the name

SetPromotionSelected

Arguments: iUnitID — unit id whose pending proposals are dropped; ePromotion — promotion type to mark; bClearProposals — also remove proposals for this unit

Writes - promotion/count pair list at this+0x388 (count of matching entry incremented) - proposal vector at this+0x3b8 (cleared and refilled)

Side effects - allocates a temporary vector copy

Input checks: If promotion not found in the list nothing is incremented (silent). No unit validation.

Preconditions - gameplay state

Multiplayer: may-desync: direct state change. Risk: low (simple list updates). Confidence of the reading: medium.

Verified from the code - linear search of 8-byte pairs for promotion - increments second element of found pair - if bClearProposals copies vector at +0x3c8, clears +0x3b8 and re-adds entries whose id field differs from iUnitID

Inferred - list is promotion with selection count - vector types in the symbol names look mismatched (symbol folding)

Open questions - real meaning of the vectors at 0x3b8 and 0x3c8