Home › Lua API › GameSummary

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

GameSummary

9 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
CoalesceDataSet GameSummary.CoalesceDataSet(initialTurn: integer, finalTurn: integer, arg3: integer)
args: finalTurn — A turn number (named turn in the scripts). (inferred); arg3 — A turn number (named turn in the scripts). (inferred)
touches (inferred from the code): reads Shared::GameSummaryRepository::m_DataSets		 gameplay — 0x6e1cb0 0x6e23e0
GetDataSetCount GameSummary.GetDataSetCount() → number
returns: A count or amount (the scripts name the result count / num / amount). (inferred)		 gameplay — 0x6e2010 0x6e2740
GetDataSetDisplayDescription GameSummary.GetDataSetDisplayDescription(index: integer) → nil gameplay — 0x6e20a0 0x6e27d0
GetDataSetDisplayName GameSummary.GetDataSetDisplayName(index: integer) → nil gameplay — 0x6e21f0 0x6e2920
GetDataSetName GameSummary.GetDataSetName(index: integer) → nil gameplay — 0x6e2340 0x6e2a70
GetDataSetValue GameSummary.GetDataSetValue(index: integer, player: integer, turn: integer) → number (or nothing)
touches (inferred from the code): reads Shared::GameSummaryRepository::m_DataSets		 gameplay — 0x6e2490 0x6e2bc0
GetDataSetValues GameSummary.GetDataSetValues(index: integer) gameplay — 0x6e2590 0x6e2cc0
GetDataSetVisible GameSummary.GetDataSetVisible(index: integer) → boolean
touches (inferred from the code): reads Shared::GameSummaryRepository::m_DataSets		 gameplay — 0x6e28c0 0x6e2ff0
HasDataSetValues GameSummary.HasDataSetValues(index: integer) → boolean
touches (inferred from the code): reads Shared::GameSummaryRepository::m_DataSets		 gameplay — 0x6e2960 0x6e3090