Home › Lua API › PlayerGovernors

Available out of the box. Usable from Lua in the unmodified game.

PlayerGovernors

22 methods. Symbol/current columns are function addresses (RVA) of the native wrapper.

Community reference for this object: PlayerGovernors (Sukrit Tan, external).

Signatures are recovered from the game code. ⚠ = partly understood (arguments may be missing or approximate). ? after a name = optional argument. Types: integer/number are Lua numbers, enum-typed arguments show the C++ type in brackets. Two signatures mean the method is registered separately for the UI and the gameplay state and each wrapper was decoded on its own. "same code as" in the Symbol column means the compiler merged identical functions: those methods share one wrapper and cannot be told apart by address.

Method Signature Where Reference Symbol Current
CanAppoint PlayerGovernors:CanAppoint() → boolean
✓ called in the game: 1 value(s) as documented
ui-cache yes ↗ 0x70f780 0x70fff0
CanAppointGovernor PlayerGovernors:CanAppointGovernor(eGovernor: string/number[GovernorTypes]) → boolean (const bool)
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70f7c0 0x710030
CanAssignGovernor PlayerGovernors:CanAssignGovernor(eGovernor: string/number[GovernorTypes], arg2: City, arg3?: boolean) → boolean, boolean
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index).; arg2 — Id of a city (named cityID in the scripts). (inferred); arg3 — A boolean flag (true/false).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70f820 0x710090
CanEarnPromotion PlayerGovernors:CanEarnPromotion(eGovernor: string/number[GovernorTypes], ePromotion: string/number[GovernorPromotionTypes]) → boolean (const bool)
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index).; ePromotion — Index of a row of the GovernorPromotions table (the value of GameInfo.GovernorPromotions[...].Index).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70f9b0 0x710220
CanEverAppointGovernor PlayerGovernors:CanEverAppointGovernor(eGovernor: string/number[GovernorTypes]) → boolean (const bool)
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fa60 0x7102d0
CanPromote PlayerGovernors:CanPromote() → boolean
✓ called in the game: 1 value(s) as documented
ui-cache yes ↗ 0x70fac0 0x710330
CanPromoteGovernor PlayerGovernors:CanPromoteGovernor(eGovernor: string/number[GovernorTypes]) → boolean (const bool)
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fb00 0x710370
ChangeGovernorPoints PlayerGovernors:ChangeGovernorPoints(iDelta: integer) (or nothing) gameplay yes ↗ 0x7133d0 0x713c40
GetAssignedCity PlayerGovernors:GetAssignedCity(pkGovernor: Governor) → City
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fb60 0x7103d0
GetAssignedGovernor PlayerGovernors:GetAssignedGovernor(arg1: City) → Governor
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fbd0 0x710440
GetBaseTurnsUntilEstablished PlayerGovernors:GetBaseTurnsUntilEstablished() → number
✓ called in the game: 1 value(s) as documented
ui-cache yes ↗ 0x70fc40 0x7104b0
GetGovernor PlayerGovernors:GetGovernor(eGovernor: string/number[GovernorTypes]) → Governor
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index). The scripts pass its hash.
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fc90 0x710500
GetGovernorList PlayerGovernors:GetGovernorList() → boolean, Governor[]
✓ called in the game: 2 value(s) as documented
ui-cache yes ↗ 0x70fce0 0x710550
GetGovernorPoints PlayerGovernors:GetGovernorPoints() → number
✓ called in the game: 1 value(s) as documented
ui-cache, gameplay yes ↗ 0x70fdd0 0x710640
GetGovernorPointsSpent UI state: PlayerGovernors:GetGovernorPointsSpent() → number
gameplay state: PlayerGovernors:GetGovernorPointsSpent() → number (const int)
✓ called in the game: 1 value(s) as documented
ui-cache, gameplay yes ↗ 0x70fe20 0x710690
GetSecretSociety PlayerGovernors:GetSecretSociety() → number
✓ called in the game: 1 value(s) as documented
returns: Key of a row of the SecretSocieties table: the scripts look it up with GameInfo.SecretSocieties[result].
ui-cache yes ↗ 0x70fe70 0x7106e0
GetTurnsToEstablish PlayerGovernors:GetTurnsToEstablish(eGovernorHash: string/number[HashID]) → number (const int)
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fec0 0x710730
HasGovernor PlayerGovernors:HasGovernor(eGovernor: string/number[GovernorTypes]) → boolean (const bool)
args: eGovernor — Index of a row of the Governors table (the value of GameInfo.Governors[...].Index).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70ff40 0x7107b0
HasTitleBeenConsidered PlayerGovernors:HasTitleBeenConsidered() → boolean
✓ called in the game: 1 value(s) as documented
ui-cache yes ↗ 0x70ffa0 0x710810
IsAwareOfSecretSociety PlayerGovernors:IsAwareOfSecretSociety(eSecretSociety: integer[SecretSocietyTypes]) → boolean
args: eSecretSociety — Value of the SecretSocietyTypes enum (a type index).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x70fff0 0x710860
IsGovernorEstablished PlayerGovernors:IsGovernorEstablished(pkGovernor: Governor) → boolean
✓ exists at runtime (not called)
ui-cache yes ↗ 0x710050 0x7108c0
SetTitleConsidered PlayerGovernors:SetTitleConsidered(bConsidered: boolean) (or nothing)
args: bConsidered — A boolean flag (true/false).
✓ exists at runtime (not called)
ui-cache yes ↗ 0x7100c0 0x710930