Home › Lua API › HallofFame

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

HallofFame

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

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
AdjustDataSetValue HallofFame.AdjustDataSetValue(arg1: integer, x: integer, y_delta: integer) gameplay — 0x6e2dd0 0x6e3500
CreateObject HallofFame.CreateObject(szType: string[const char], eOwnerPlayer?: integer[PlayerTypes], szName?: string[const char], plotIndex?: integer, szExtraData?: string[const char], szIcon?: string[const char]) → number
args: eOwnerPlayer — Id of a player (as in Players[id]).
gameplay — 0x6e2e80 0x6e35b0
FindDataPoint HallofFame.FindDataPoint(objectId: string, arg2: integer, arg3: string[HksObject]) ⚠ gameplay — 0x6e2fc0 0x6e36f0
FindDataSet HallofFame.FindDataSet(objectId: string, arg2: integer, arg3: string[HksObject]) ⚠ gameplay — 0x6e3160 0x6e3890
GetCityObject HallofFame:GetCityObject(id: integer[IDType]) → number (District::Instance) (or nothing)
args: id — A City object (the scripts pass a variable named pCity). (inferred)
returns: The scripts pass the result to HallofFame.GetOrCreateDataSet. (inferred)
gameplay — 0x6e3300 0x6e3a30
GetDataPoints HallofFame.GetDataPoints(arg1: integer, arg2: string) → number[] ⚠ gameplay — 0x6e3400 0x6e3b30
GetDataSetValue HallofFame.GetDataSetValue(arg1: integer, x: integer) → number (or nothing) gameplay — 0x6e3640 0x6e3d70
GetDataSets HallofFame.GetDataSets(arg1: integer, arg2: string) → number[] ⚠ gameplay — 0x6e3700 0x6e3e30
GetLastDataSetValue HallofFame.GetLastDataSetValue(lookupId: integer) → number, number (or nothing) gameplay — 0x6e3940 0x6e4070
GetObjects HallofFame.GetObjects(szOther: string[const char]) → nil gameplay — 0x6e3a90 0x6e41c0
GetOrCreateDataPoint HallofFame.GetOrCreateDataPoint(objectId: string, arg2: integer, arg3: string[HksObject]) ⚠ gameplay — 0x6e4040 0x6e4770
GetOrCreateDataSet HallofFame.GetOrCreateDataSet(objectId: string, arg2: integer, arg3: string[HksObject]) ⚠
args: objectId — A string. (inferred); arg2 — Id of a city (named cityID in the scripts). (inferred)
gameplay — 0x6e41e0 0x6e4910
GetPlayerObject HallofFame.GetPlayerObject(ePlayer: integer/Player[PlayerTypes]) → number (or nothing)
args: ePlayer — Id of a player (as in Players[id]).
gameplay — 0x6e4380 0x6e4ab0
GetRulesetTypes ★ HallofFame.GetRulesetTypes() → nil gameplay — 0x6e43f0 0x6e4b20
LookupDataPoint HallofFame.LookupDataPoint(lookupId: integer) → table{DataPoint: nil, ObjectId: number, Type: nil, ValueNumeric: number, ValueString: nil, ValueObjectId: number} (or nothing) gameplay — 0x6e4730 0x6e4e60
LookupDataSet HallofFame.LookupDataSet(lookupId: integer) → table (or nothing) gameplay — 0x6e4970 0x6e50a0
SetDataPoint HallofFame.SetDataPoint(objectId: string, arg2: integer, arg3: string[HksObject]) ⚠ gameplay — 0x6e4c50 0x6e5380
SetDataSetValue HallofFame.SetDataSetValue(arg1: integer, x: integer, y: integer) (or nothing) gameplay — 0x6e4fb0 0x6e56e0
SetRulesetType HallofFame.SetRulesetType(szType: string[const char], szKind: string[const char], szName: string[const char], szIcon?: string[const char]) (or nothing) gameplay — 0x6e5040 0x6e5770
UpdateDataPoint HallofFame.UpdateDataPoint(lookupId: integer, arg2?: any) ⚠ gameplay — 0x6e50e0 0x6e5810

Notes (★)

GetRulesetTypes

Returns the list of rulesets known to the game summary data; the wrapper itself reads no argument.