Home › Lua API › CityCitizens
Available out of the box. Usable from Lua in the unmodified game.
CityCitizens
7 methods. Symbol/current columns are function addresses (RVA) of the native wrapper.
Community reference for this object: CityCitizens (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 |
| IsDisfavoredYield |
CityCitizens:IsDisfavoredYield(arg1: integer[YieldTypes]) → boolean
args: arg1 — Index of a row of the Yields table (the value of GameInfo.Yields[...].Index). |
ui-cache |
yes ↗ |
0x68d890 |
0x68de70 |
| IsFavoredYield |
CityCitizens:IsFavoredYield(arg1: integer[YieldTypes]) → boolean
args: arg1 — Index of a row of the Yields table (the value of GameInfo.Yields[...].Index). |
ui-cache |
yes ↗ |
0x68d8f0 |
0x68ded0 |
| IsPlotWorked |
CityCitizens:IsPlotWorked(arg1?: number, arg2?: number) → boolean (or nothing)
args: arg1 — A plot coordinate (named x / y / plotX / plotY in the scripts). (inferred); arg2 — A plot coordinate (named x / y / plotX / plotY in the scripts). (inferred) |
ui-cache |
yes ↗ |
0x68d950 |
0x68df30 |
| IsYieldDisfavored |
CityCitizens:IsYieldDisfavored(yield: integer[YieldTypes]) → boolean
args: yield — Index of a row of the Yields table (the value of GameInfo.Yields[...].Index). |
gameplay |
yes ↗ |
0x6caad0 |
0x6cb190 |
| IsYieldFavored |
CityCitizens:IsYieldFavored(yield: integer[YieldTypes]) → boolean
args: yield — Index of a row of the Yields table (the value of GameInfo.Yields[...].Index). |
gameplay |
yes ↗ |
0x6cab30 |
0x6cb1f0 |
| SetDisfavoredYield |
CityCitizens:SetDisfavoredYield(yield: integer[YieldTypes], disfavored: boolean) (or nothing)
args: yield — Index of a row of the Yields table (the value of GameInfo.Yields[...].Index). |
gameplay |
yes ↗ |
0x6cab90 |
0x6cb250 |
| SetFavoredYield |
CityCitizens:SetFavoredYield(yield: integer[YieldTypes], favored: boolean) (or nothing)
args: yield — Index of a row of the Yields table (the value of GameInfo.Yields[...].Index).; favored — A boolean flag (true/false). (inferred) |
gameplay |
yes ↗ |
0x6cabf0 |
0x6cb2b0 |