Home › Lua API › Area

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

Area

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

Community reference for this object: Area (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
GetBoundaries Area:GetBoundaries() → table{NorthEdge: number, SouthEdge: number, EastEdge: number, WestEdge: number}
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18af0 0x18fd0
GetID Area:GetID() → number
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18c30 0x19110
GetImprovementCount Area:GetImprovementCount(eImprovement?: number) → number
✓ exists at runtime (not called)		 gameplay yes ↗ 0x18c70 0x19150
GetPlotCount Area:GetPlotCount() → number
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18cf0 0x191d0
GetResourceCount Area:GetResourceCount(eResource?: number) → number
✓ exists at runtime (not called)		 gameplay yes ↗ 0x18d40 0x19220
GetRiverEdgeCount Area:GetRiverEdgeCount() → number
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18dc0 0x192a0
GetTotalImprovements Area:GetTotalImprovements() → number
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18e10 0x192f0
GetTotalNaturalWonders Area:GetTotalNaturalWonders() → number
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18e60 0x19340
GetTotalResources Area:GetTotalResources() → number
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18eb0 0x19390
HasNoFlatCoast Area:HasNoFlatCoast() → boolean
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18f00 0x193e0
IsCanyons Area:IsCanyons() → boolean
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18f50 0x19430
IsMountains Area:IsMountains() → boolean
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x18fa0 0x19480
IsNone ★ Area:IsNone() → boolean
⚠ test call in the game raised: Instance does not exist. stack traceback: [C]: in function 'lIsNone' [string "lo		 gameplay yes ↗ 0x18ff0 0x194d0
IsWater Area:IsWater() → boolean
✓ called in the game: 1 value(s) as documented		 gameplay yes ↗ 0x19030 0x19510

Notes (★)

IsNone

Only valid on a 'none' area instance.