Home › Lua API › CityPlots

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

CityPlots

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

Community reference for this object: CityPlots (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
GetPurchasedByCity CityPlots:GetPurchasedByCity(x: integer/Plot, y?: integer) → City (or nothing) ui-cache yes ↗ 0x6a2ef0 0x6a3470
GetPurchasedByCityID CityPlots:GetPurchasedByCityID(x: integer/Plot, y?: integer) → number, number (or nothing) ui-cache yes ↗ 0x6a2f80 0x6a3500
GetPurchasedPlots CityPlots:GetPurchasedPlots(arg1: City) → number[] (or nothing)
args: arg1 — A City object (the scripts pass a variable named pCity).
touches (inferred from the code): reads Cache::Map::Instance::m_kConstants+0x10
ui-cache yes ↗ 0x6a3040 0x6a35c0
GetVisiblePurchasedPlots CityPlots:GetVisiblePurchasedPlots(arg1: City) → number[] (or nothing)
touches (inferred from the code): reads Cache::Map::Instance::m_kConstants+0x10
ui-cache yes ↗ 0x6a31b0 0x6a3730
GetWorkingCity CityPlots:GetWorkingCity(x: integer/Plot, y?: integer) → City (or nothing) ui-cache yes ↗ 0x6a3360 0x6a38e0
GetWorkingCityID CityPlots:GetWorkingCityID(x: integer/Plot, y?: integer) → number, number (or nothing) ui-cache yes ↗ 0x6a33f0 0x6a3970