Home › Engine executable › Game summary and statistics data model

Game summary and statistics data model

The game summary (the Hall of Fame screens, the end-of-game graphs and reports, the per-leader and per-victory progress) is driven by data. Two parts: configuration tables in the game's Configuration database, created by Configuration/Data/Schema/HallofFame.sql and filled by HallofFame.xml (what statistics, graphs, reports and aggregates exist), and recorded tables in HallofFame.sqlite, where the exe stores every finished or running game (Application::GameSummary writes them, the Lua table HallofFame and the summary library read them; see the HallofFame page and the database statements). Verified: table and column names, shipped row counts, SQL statements (read from the files and the exe). Inferred: what a table is for beyond its name.

What the shipped data defines (28 statistics in 8 categories, 38 graphs, 5 reports with 21 columns, 83 aggregate rules: Sum 46, Max 8, First 4, MaxSum 9, Count 2, Last 14 over the scopes MajorPlayers 23, Games 23, Rulesets 23, MajorCityObjects 11, ReligionObjects 3). A modder adds a statistic by adding rows: a DataPointAggregateUpdates rule that sums, maximises or counts a recorded data point, a Statistics row (name key, category, icon) and, for a report, a ReportColumns row. The recorded data point values are rows of ObjectDataPointValues / GameDataPointValues; the game transfer of the exe (Application::GameSummary::BeginGameTransfer) creates the game, its players and objects, datasets and data point values (CreateGame, CreateObject, CreateGameDataset, CreateObjectDataset, UpdateAggregateDataPoints).

Configuration tables (17)

Recorded and queried tables (15)

Tables the exe writes or reads that are not part of the configuration schema. Columns are the ones named in statements that mention the table, so a statement that joins several tables can list a column under more than one of them. "summary database" tables live in HallofFame.sqlite; "game" tables belong to the game databases (queried for names and icons).

Statistic categories

Data points (48)

Names of the recorded values and the statistics built from them: Statistic = has a Statistics row (with a category); aggregates are the DataPointAggregateUpdates rules that produce the value (operation of a data point over a scope).

Graphs (38)

Reports (5)

Game fields handed to the scripts (PushGameData)

PushGameData (0x4c4220) builds the table of one recorded game that the Lua functions GetGames / GetGameData return. Field names: CivilizationName, CivilizationType, DefeatType, DifficultyType, GameId, GameMode, GameSpeedType, IsHuman, IsLocal, IsMajor, LastPlayed, LeaderName, LeaderType, MapSizeType, PlayerId, PlayerObjectId, Players, Ruleset, Score, StartEraType, StartTurn, TeamId, TurnCount, VictorTeamId, VictoryType.