Ticket #1090: playercomponent_savegamesummaryreplaycleanup.patch

binaries/data/mods/public/gui/common/functions_utility.js

@@ -206 +206 @@
     }
 }
 
 /**
  * Returns a formatted string describing the player assignments.
- * Including civs, teams, AI settings and player colors
- * which are given in data (array of objects per player).
+ * Needs g_CivData to translate!
  *
+ * @param {object} playerDataArray - As known from gamesetup and simstate.
+ * @param {(string[]|false)} playerStates - One of "won", "defeated", "active" for each player.
  * @returns {string}
  */
-function formatPlayerInfo(data)
+function formatPlayerInfo(playerDataArray, playerStates)
 {
     let playerDescriptions = {};
     let playerIdx = 0;
-    for (let playerData of data)
+
+    for (let playerData of playerDataArray)
     {
+        if (playerData == null || playerData.Civ == "gaia")
+            continue;
+
         ++playerIdx;
         let teamIdx = playerData.Team;
-        let showDefeated = playerData.state && playerData.state == "defeated";
         let isAI = playerData.AI && playerData.AI != "";
+        let playerState = playerStates && playerStates[playerIdx];
+        let isActive = !playerState || playerState == "active";
 
-        let translated;
-        if (!isAI && !showDefeated)
-            translated = translateWithContext("replay", "%(playerName)s (%(civ)s)");
-        else if (!isAI && showDefeated)
-            translated = translateWithContext("replay", "%(playerName)s (%(civ)s, defeated)");
-        else if (isAI && !showDefeated)
-            translated = translateWithContext("replay", "%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s)");
+        let playerDescription;
+        if (isAI)
+        {
+            if (isActive)
+                playerDescription = translateWithContext("replay", "%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s, %(state)s)");
+            else
+                playerDescription = translateWithContext("replay", "%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s)");
+        }
         else
-            translated = translateWithContext("replay", "%(playerName)s (%(civ)s, %(AIdifficulty)s %(AIname)s, defeated)");
+        {
+            if (isActive)
+                playerDescription = translateWithContext("replay", "%(playerName)s (%(civ)s, %(state)s)");
+            else
+                playerDescription = translateWithContext("replay", "%(playerName)s (%(civ)s)");
+        }
 
         // Sort player descriptions by team
         if (!playerDescriptions[teamIdx])
             playerDescriptions[teamIdx] = [];
-        playerDescriptions[teamIdx].push(sprintf(translated, {
-            "playerName": '[color="' + rgbToGuiColor(playerData.Color) + '"]' + escapeText(playerData.Name) + "[/color]",
-            "civ": playerData.Civ,
+
+        playerDescriptions[teamIdx].push(sprintf(playerDescription, {
+            "playerName":
+                '[color="' +
+                rgbToGuiColor(playerData.Color || g_Settings.PlayerDefaults[playerIdx].Color) +
+                '"]' + escapeText(playerData.Name) + "[/color]",
+
+            "civ":
+                !playerData.Civ ?
+                    translate("Unknown Civilization") :
+                        g_CivData && g_CivData[playerData.Civ] && g_CivData[playerData.Civ].Name ?
+                        translate(g_CivData[playerData.Civ].Name) :
+                        playerData.Civ,
+
+            "state":
+                playerState == "defeated" ?
+                    translateWithContext("playerState", "Defeated") :
+                    translateWithContext("playerState", "Won"),
+
             "AIname": isAI ? translateAIName(playerData.AI) : "",
             "AIdifficulty": isAI ? translateAIDifficulty(playerData.AIDiff) : ""
         }));
     }
 
@@ -251 +279 @@
     if (teams.length == 1)
         return playerDescriptions[teams[0]].join("\n") + "\n";
 
     // If there are teams, merge "Team N:" + playerDescriptions
     return teams.map(team => {
-        let teamCaption = (team == -1) ? translate("No Team") : sprintf(translate("Team %(team)s"), { "team": +team + 1 });
-        return '[font="sans-bold-14"]' + teamCaption + "[/font]:\n" + playerDescriptions[team].join("\n");
+
+        let teamCaption = team == -1 ?
+            translate("No Team") :
+            sprintf(translate("Team %(team)s"), { "team": +team + 1 });
+
+        return sprintf(translateWithContext("replay", "%(team)s:\n%(playerDescriptions)s"), {
+            "team": '[font="sans-bold-14"]' + teamCaption + "[/font]",
+            "playerDescriptions": playerDescriptions[team].join("\n")
+        });
     }).join("\n\n");
 }

binaries/data/mods/public/gui/replaymenu/replay_menu.js

@@ -2 +2 @@
  * Used for checking replay compatibility.
  */
 const g_EngineInfo = Engine.GetEngineInfo();
 
 /**
- * To show the titles of the selected civs in the replay details.
+ * Needed for formatPlayerInfo to show the player civs in the details.
  */
 const g_CivData = loadCivData();
 
 /**
  * Used for creating the mapsize filter.
@@ -188 +188 @@
     if (replaySelection.selected != -1)
         g_SelectedReplayDirectory = g_ReplaysFiltered[replaySelection.selected].directory;
 
     filterReplays();
 
-    // Create GUI list data
     var list = g_ReplaysFiltered.map(replay => {
         let works = replay.isCompatible;
         return {
             "directories": replay.directory,
             "months": greyout(getReplayDateTime(replay), works),
@@ -202 +201 @@
             "durations": greyout(getReplayDuration(replay), works),
             "playerNames": greyout(getReplayPlayernames(replay), works)
         };
     });
 
-    // Extract arrays
     if (list.length)
         list = prepareForDropdown(list);
 
     // Push to GUI
     replaySelection.selected = -1;
@@ -219 +217 @@
 
     // Change these last, otherwise crash
     replaySelection.list = list.directories || [];
     replaySelection.list_data = list.directories || [];
 
-    // Restore selection
     replaySelection.selected = replaySelection.list.findIndex(directory => directory == g_SelectedReplayDirectory);
 
     displayReplayDetails();
 }
 
 /**
  * Shows preview image, description and player text in the right panel.
  */
 function displayReplayDetails()
 {
-    var selected = Engine.GetGUIObjectByName("replaySelection").selected;
-    var replaySelected = selected > -1;
+    let selected = Engine.GetGUIObjectByName("replaySelection").selected;
+    let replaySelected = selected > -1;
 
     Engine.GetGUIObjectByName("replayInfo").hidden = !replaySelected;
     Engine.GetGUIObjectByName("replayInfoEmpty").hidden = replaySelected;
     Engine.GetGUIObjectByName("startReplayButton").enabled = replaySelected;
     Engine.GetGUIObjectByName("deleteReplayButton").enabled = replaySelected;
     Engine.GetGUIObjectByName("summaryButton").hidden = true;
 
     if (!replaySelected)
         return;
 
-    var replay = g_ReplaysFiltered[selected];
-    var mapData = getMapDescriptionAndPreview(replay.attribs.settings.mapType, replay.attribs.map);
+    let replay = g_ReplaysFiltered[selected];
 
-    // Update GUI
     Engine.GetGUIObjectByName("sgMapName").caption = translate(replay.attribs.settings.Name);
     Engine.GetGUIObjectByName("sgMapSize").caption = translateMapSize(replay.attribs.settings.Size);
     Engine.GetGUIObjectByName("sgMapType").caption = translateMapType(replay.attribs.settings.mapType);
     Engine.GetGUIObjectByName("sgVictory").caption = translateVictoryCondition(replay.attribs.settings.GameType);
     Engine.GetGUIObjectByName("sgNbPlayers").caption = replay.attribs.settings.PlayerData.length;
-    Engine.GetGUIObjectByName("sgPlayersNames").caption = getReplayTeamText(replay);
+
+    let metadata = Engine.GetReplayMetadata(replay.directory);
+    let mapData = getMapDescriptionAndPreview(replay.attribs.settings.mapType, replay.attribs.map);
+    let playerStates =
+        Engine.GetGUIObjectByName("showSpoiler").checked &&
+        metadata &&
+        metadata.playerStates &&
+        metadata.playerStates.map(pState => pState.state);
+
+    Engine.GetGUIObjectByName("sgPlayersNames").caption = formatPlayerInfo(replay.attribs.settings.PlayerData, playerStates);
     Engine.GetGUIObjectByName("sgMapDescription").caption = mapData.description;
     Engine.GetGUIObjectByName("summaryButton").hidden = !Engine.HasReplayMetadata(replay.directory);
 
     setMapPreviewImage("sgMapPreview", mapData.preview);
 }
@@ -329 +333 @@
  */
 function replayHasSameEngineVersion(replay)
 {
     return replay.attribs.engine_version && replay.attribs.engine_version == g_EngineInfo.engine_version;
 }
-
-/**
- * Returns a description of the player assignments.
- * Including civs, teams, AI settings and player colors.
- *
- * If the spoiler-checkbox is checked, it also shows defeated players.
- *
- * @returns {string}
- */
-function getReplayTeamText(replay)
-{
-    // Load replay metadata
-    const metadata = Engine.GetReplayMetadata(replay.directory);
-    const spoiler = Engine.GetGUIObjectByName("showSpoiler").checked;
-
-    let data = [];
-    let playerIdx = 0;
-    for (let playerData of replay.attribs.settings.PlayerData)
-    {
-        ++playerIdx;
-        data.push({
-            "Team": playerData.Team,
-            "Name": playerData.Name,
-            "Civ": !playerData.Civ ? translate("Unknown Civilization") :
-                (g_CivData[playerData.Civ] && g_CivData[playerData.Civ].Name ? translate(g_CivData[playerData.Civ].Name) : playerData.Civ),
-            "Color": playerData.Color ? playerData.Color : g_Settings.PlayerDefaults[playerIdx].Color,
-            "AI": playerData.AI,
-            "AIDiff": playerData.AIDiff,
-            "Defeated": spoiler && metadata && metadata.playerStates && metadata.playerStates[playerIdx].state == "defeated"
-        });
-    }
-
-    return formatPlayerInfo(data);
-}

binaries/data/mods/public/gui/savedgames/load.js

@@ -1 +1 @@
 var g_SavedGamesMetadata = [];
 
+/**
+ * Needed for formatPlayerInfo to show the player civs in the details.
+ */
+const g_CivData = loadCivData();
+
 function init()
 {
     let gameSelection = Engine.GetGUIObjectByName("gameSelection");
 
     let savedGames = Engine.GetSavedGames().sort(sortDecreasingDate);
@@ -56 +61 @@
     let caption = sprintf(translate("Mods: %(mods)s"), { "mods": metadata.mods.join(translate(", ")) });
     if (!hasSameMods(metadata, Engine.GetEngineInfo()))
         caption = "[color=\"orange\"]" + caption + "[/color]";
     Engine.GetGUIObjectByName("savedMods").caption = caption;
 
-    let data = [];
-    let playerIdx = 0;
-    for (let playerData of metadata.initAttributes.settings.PlayerData)
-    {
-        if (playerData == null || playerData.Civ == "gaia")
-            continue;
-        ++playerIdx;
-        data.push({
-            "Team": playerData.Team,
-            "Name": playerData.Name,
-            "Civ": playerData.Civ,
-            "Color": playerData.Color,
-            "AI": playerData.AI,
-            "AIDiff": playerData.AIDiff,
-            "Defeated": metadata.gui.states && metadata.gui.states[playerIdx] == "defeated"
-        });
-    }
-
-    Engine.GetGUIObjectByName("savedPlayersNames").caption = formatPlayerInfo(data);
+    Engine.GetGUIObjectByName("savedPlayersNames").caption = formatPlayerInfo(
+        metadata.initAttributes.settings.PlayerData,
+        metadata.gui.states
+    );
 }
 
 function loadGame()
 {
     let gameSelection = Engine.GetGUIObjectByName("gameSelection");

binaries/data/mods/public/gui/savedgames/load.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
 <objects>
 
     <script file="gui/common/color.js" />
+    <script file="gui/common/functions_civinfo.js"/>
     <script file="gui/common/functions_global_object.js" />
     <script file="gui/common/functions_utility.js" />
     <script file="gui/common/functions_utility_loadsave.js" />
     <script file="gui/common/settings.js" />
     <script file="gui/savedgames/load.js" />
@@ -28 +29 @@
                 <action on="Press">Engine.PopGuiPage();</action>
             </object>
 
             <object name="deleteGameButton" type="button" size="33%+20 100%-60 66%-15 100%-32" style="StoneButton" hotkey="session.savedgames.delete">
                 <translatableAttribute id="caption">Delete</translatableAttribute>
-                <action on="Press">
-                    if (!this.enabled)
-                        return;
-                    if (Engine.HotkeyIsPressed("session.savedgames.noconfirmation"))
-                        deleteGameWithoutConfirmation();
-                    else
-                        deleteGame();
-                </action>
+                <action on="Press">deleteGame();</action>
             </object>
 
             <object name="loadGameButton" type="button" style="StoneButton" size="66%-5 100%-60 100%-25 100%-32">
                 <translatableAttribute id="caption">Load</translatableAttribute>
                 <action on="Press">loadGame();</action>

binaries/data/mods/public/gui/savedgames/save.js

@@ -15 +15 @@
 function init(data)
 {
     g_SavedGameData = data && data.savedGameData || {};
     let simulationState = Engine.GuiInterfaceCall("GetSimulationState");
     g_SavedGameData.timeElapsed = simulationState.timeElapsed;
-    g_SavedGameData.states = [];
-    for (let player of simulationState.players)
-        g_SavedGameData.states.push(player.state);
+    g_SavedGameData.states = simulationState.players.map(pState => pState.state);
 
     let gameSelection = Engine.GetGUIObjectByName("gameSelection");
     Engine.GetGUIObjectByName("deleteGameButton").enabled = false;
 
     let savedGames = Engine.GetSavedGames().sort(sortDecreasingDate);

binaries/data/mods/public/gui/session/messages.js

@@ -99 +99 @@
             }
         ),
     "clientlist": msg => getUsernameList(),
     "message": msg => formatChatCommand(msg),
     "defeat": msg => formatDefeatMessage(msg),
+    "won": msg => formatWonMessage(msg),
     "diplomacy": msg => formatDiplomacyMessage(msg),
     "tribute": msg => formatTributeMessage(msg),
     "attack": msg => formatAttackMessage(msg)
 };
 
@@ -244 +245 @@
             "type": "defeat",
             "guid": findGuidForPlayerID(player),
             "player": player,
             "resign": !!notification.resign
         });
-
-        updateDiplomacy();
-        updateChatAddressees();
+        playerFinished(player, false);
+    },
+    "won": function(notification, player)
+    {
+        addChatMessage({
+            "type": "won",
+            "guid": findGuidForPlayerID(player),
+            "player": player
+        });
+        playerFinished(player, true);
     },
     "diplomacy": function(notification, player)
     {
         addChatMessage({
             "type": "diplomacy",
@@ -743 +751 @@
             translate("%(player)s has been defeated."),
         { "player": colorizePlayernameByID(msg.player) }
     );
 }
 
+function formatWonMessage(msg)
+{
+    return sprintf(translate("%(player)s has won."), {
+        "player": colorizePlayernameByID(msg.player)
+    });
+}
+
 function formatDiplomacyMessage(msg)
 {
     let messageType;
 
     if (g_IsObserver)

binaries/data/mods/public/gui/session/session.js

@@ -117 +117 @@
 var g_TemplateData = {};
 var g_TemplateDataWithoutLocalization = {};
 var g_TechnologyData = {};
 
 /**
- * Cache concatenated list of player states ("active", "defeated" or "won").
- */
-var g_CachedLastStates = "";
-
-/**
- * Whether the current player has lost/won and reached the end of their game.
- * Used for reporting the gamestate and showing the game-end message only once.
- */
-var g_GameEnded = false;
-
-/**
  * Top coordinate of the research list.
  * Changes depending on the number of displayed counters.
  */
 var g_ResearchListTop = 4;
 
@@ -238 +227 @@
         g_PlayerAssignments = initData.playerAssignments;
         g_MatchID = initData.attribs.matchID;
         g_ReplaySelectionData = initData.replaySelectionData;
         g_HasRejoined = initData.isRejoining;
 
-        g_Players = getPlayerData();
-
         if (initData.savedGUIData)
             restoreSavedGameData(initData.savedGUIData);
 
         Engine.GetGUIObjectByName("gameSpeedButton").hidden = g_IsNetworked;
     }
     else // Needed for autostart loading option
     {
         if (g_IsReplay)
             g_PlayerAssignments.local.player = -1;
-
-        g_Players = getPlayerData();
     }
 
+    g_Players = getPlayerData();
+
     g_CivData = loadCivData();
     g_CivData.gaia = { "Code": "gaia", "Name": translate("Gaia") };
 
     initializeMusic(); // before changing the perspective
     selectViewPlayer(g_ViewedPlayer);
@@ -433 +420 @@
     return playerState && (
         playerState.state != "defeated" || playerState.controlsAll);
 }
 
 /**
+ * Called when a player has won or was defeated.
+ */
+function playerFinished(player, won)
+{
+    reportGame();
+    updateDiplomacy();
+    updateChatAddressees();
+
+    if (player != Engine.GetPlayerID() || Engine.IsAtlasRunning())
+        return;
+
+    global.music.setState(
+        won ?
+            global.music.states.VICTORY :
+            global.music.states.DEFEAT
+    );
+
+    closeOpenDialogs();
+
+    // Select observermode
+    if (!won)
+        Engine.GetGUIObjectByName("viewPlayer").selected = 0;
+
+    messageBox(
+        400, 200,
+        g_IsNetworked && g_IsController ?
+            translate("Do you want to quit? Leaving will disconnect all other players.") :
+            translate("Do you want to quit?"),
+        won ?
+            translate("VICTORIOUS!") :
+            translate("DEFEATED!"),
+        [translate("No"), translate("Yes")],
+        [null, leaveGame]
+    );
+}
+
+/**
  * Sets civ icon for the currently viewed player.
  * Hides most gui objects for observers.
  */
 function updateTopPanel()
 {
@@ -505 +529 @@
  * @param willRejoin If player is going to be rejoining a networked game.
  */
 function leaveGame(willRejoin)
 {
     let extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
-    let mapSettings = Engine.GetMapSettings();
-    let gameResult;
-
-    if (Engine.GetPlayerID() == -1)
-    {
-        gameResult = translate("You have left the game.");
-        global.music.setState(global.music.states.VICTORY);
-    }
-    else
-    {
-        let playerState = extendedSimState.players[Engine.GetPlayerID()];
-        if (g_Disconnected)
-            gameResult = translate("You have been disconnected.");
-        else if (playerState.state == "won")
-            gameResult = translate("You have won the battle!");
-        else if (playerState.state == "defeated")
-            gameResult = translate("You have been defeated...");
-        else // "active"
-        {
-            global.music.setState(global.music.states.DEFEAT);
-            if (willRejoin)
-                gameResult = translate("You have left the game.");
-            else
-            {
-                gameResult = translate("You have abandoned the game.");
-                resignGame(true);
-            }
-        }
-    }
-
-    let summary = {
+    let simData = {
         "timeElapsed" : extendedSimState.timeElapsed,
         "playerStates": extendedSimState.players,
-        "players": g_Players,
-        "mapSettings": Engine.GetMapSettings(),
+        "mapSettings": Engine.GetMapSettings()
     };
 
     if (!g_IsReplay)
-        Engine.SaveReplayMetadata(JSON.stringify(summary));
+        Engine.SaveReplayMetadata(JSON.stringify(simData));
 
-    if (!g_HasRejoined)
-        summary.replayDirectory = Engine.GetCurrentReplayDirectory();
-    summary.replaySelectionData = g_ReplaySelectionData;
+    let guiData = {
+        "assignedPlayer": Engine.GetPlayerID(),
+        "disconnected": g_Disconnected,
+        "isReplay": g_IsReplay,
+        "replayDirectory": !g_HasRejoined && Engine.GetCurrentReplayDirectory(),
+        "replaySelectionData": g_ReplaySelectionData,
+    };
+
+    if (!willRejoin &&
+        simData[Engine.GetPlayerID()] &&
+        simData[Engine.GetPlayerID()].state == "active")
+        resignGame(true);
 
     Engine.EndGame();
 
     if (g_IsController && Engine.HasXmppClient())
         Engine.SendUnregisterGame();
 
-    summary.gameResult = gameResult;
-    summary.isReplay = g_IsReplay;
-    Engine.SwitchGuiPage("page_summary.xml", summary);
+    Engine.SwitchGuiPage("page_summary.xml", {
+        "gui": guiData,
+        "sim": simData
+    });
 }
 
 // Return some data that we'll use when hotloading this file after changes
 function getHotloadData()
 {
@@ -603 +606 @@
 
     let now = new Date();
     let tickLength = new Date() - lastTickTime;
     lastTickTime = now;
 
-    checkPlayerState();
-
     handleNetMessages();
 
     updateCursorAndTooltip();
 
     if (g_Selection.dirty)
@@ -630 +631 @@
     Engine.GetGUIObjectByName("resourcePop").textcolor = g_IsTrainingBlocked && Date.now() % 1000 < 500 ? g_PopulationAlertColor : g_DefaultPopulationColor;
 
     Engine.GuiInterfaceCall("ClearRenamedEntities");
 }
 
-function checkPlayerState()
-{
-    if (g_GameEnded || Engine.GetPlayerID() < 1)
-        return;
-
-    // Send a game report for each player in this game.
-    let m_simState = GetSimState();
-    let playerState = m_simState.players[Engine.GetPlayerID()];
-    let tempStates = "";
-    for (let player of m_simState.players)
-        tempStates += player.state + ",";
-
-    if (g_CachedLastStates != tempStates)
-    {
-        g_CachedLastStates = tempStates;
-        reportGame();
-    }
-
-    if (playerState.state == "active")
-        return;
-
-    // Make sure nothing is open to avoid stacking.
-    closeOpenDialogs();
-
-    // Make sure this doesn't run again.
-    g_GameEnded = true;
-
-    // Select observermode
-    Engine.GetGUIObjectByName("viewPlayer").selected = playerState.state == "won" ? g_ViewedPlayer + 1 : 0;
-
-    let btCaptions;
-    let btCode;
-    let message;
-    let title;
-    if (Engine.IsAtlasRunning())
-    {
-        // If we're in Atlas, we can't leave the game
-        btCaptions = [translate("OK")];
-        btCode = [null];
-        message = translate("Press OK to continue");
-    }
-    else
-    {
-        btCaptions = [translate("No"), translate("Yes")];
-        btCode = [null, leaveGame];
-        message = translate("Do you want to quit?");
-    }
-
-    if (playerState.state == "defeated")
-    {
-        title = translate("DEFEATED!");
-        global.music.setState(global.music.states.DEFEAT);
-    }
-    else if (playerState.state == "won")
-    {
-        title = translate("VICTORIOUS!");
-        global.music.setState(global.music.states.VICTORY);
-        // TODO: Reveal map directly instead of this silly proxy.
-        if (!Engine.GetGUIObjectByName("devCommandsRevealMap").checked)
-            Engine.GetGUIObjectByName("devCommandsRevealMap").checked = true;
-    }
-
-    messageBox(400, 200, message, title, btCaptions, btCode);
-}
-
 function changeGameSpeed(speed)
 {
     if (!g_IsNetworked)
         Engine.SetSimRate(speed);
 }
@@ -735 +671 @@
 
     if (!g_SimState)
         return;
 
     handleNotifications();
-
     updateGUIObjects();
 }
 
 function updateGUIObjects()
 {
@@ -768 +703 @@
         let playerState = GetSimState().players[g_ViewedPlayer];
         g_DevSettings.controlAll = playerState && playerState.controlsAll;
         Engine.GetGUIObjectByName("devControlAll").checked = g_DevSettings.controlAll;
     }
 
-    if (g_ViewedPlayer != -1 && !g_GameEnded)
+    if (!g_IsObserver)
     {
         // Update music state on basis of battle state.
         let battleState = Engine.GuiInterfaceCall("GetBattleState", g_ViewedPlayer);
         if (battleState)
             global.music.setState(global.music.states[battleState]);
@@ -826 +761 @@
         healthSize.rtop = value;
 
     statusBar.size = healthSize;
 }
 
-
 function updateHeroes()
 {
     let playerState = GetSimState().players[g_ViewedPlayer];
     let heroes = playerState ? playerState.heroes : [];
 
@@ -1140 +1074 @@
     Engine.PlayAmbientSound(g_Ambient[Math.floor(Math.random() * g_Ambient.length)], true);
 }
 
 function getBuildString()
 {
-    return sprintf(translate("Build: %(buildDate)s (%(revision)s)"), { "buildDate": Engine.GetBuildTimestamp(0), revision: Engine.GetBuildTimestamp(2) });
+    return sprintf(translate("Build: %(buildDate)s (%(revision)s)"), {
+        "buildDate": Engine.GetBuildTimestamp(0),
+        "revision": Engine.GetBuildTimestamp(2)
+    });
 }
 
 function showTimeWarpMessageBox()
 {
     messageBox(
@@ -1158 +1095 @@
  * Send a report on the gamestatus to the lobby.
  */
 function reportGame()
 {
     // Only 1v1 games are rated (and Gaia is part of g_Players)
-    if (!Engine.HasXmppClient() || !Engine.IsRankedGame() || g_Players.length != 3)
+    if (!Engine.HasXmppClient() || !Engine.IsRankedGame() ||
+        g_Players.length != 3 || Engine.GetPlayerID() == -1)
         return;
 
     let extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
 
     let unitsClasses = [

binaries/data/mods/public/gui/session/utility_functions.js

@@ +1 @@
+/**
+ * Before removing data, consider this data is partially used in the replay menu.
+ */
 function getPlayerData(previousData = undefined)
 {
     let players = [];
 
     let simState = GetSimState();

binaries/data/mods/public/gui/summary/layout.js

@@ -315 +315 @@
     // If there are no players without team, hide "player name" heading
     if (!g_WithoutTeam)
         Engine.GetGUIObjectByName("playerNameHeading").caption = "";
 }
 
-function updateObjectPlayerPosition()
+function initPlayerBoxPositions()
 {
     for (let h = 0; h < g_MaxPlayers; ++h)
     {
         let playerBox = Engine.GetGUIObjectByName("playerBox[" + h + "]");
         let boxSize = playerBox.size;

binaries/data/mods/public/gui/summary/summary.js

@@ -80 +80 @@
     updateGeneralPanelTeams();
 
     let playerBoxesCounts = [ ];
     for (let i = 0; i < g_PlayerCount; ++i)
     {
-        let playerState = g_GameData.playerStates[i+1];
+        let playerState = g_GameData.sim.playerStates[i+1];
 
         if (!playerBoxesCounts[playerState.team+1])
             playerBoxesCounts[playerState.team+1] = 1;
         else
             playerBoxesCounts[playerState.team+1] += 1;
@@ -104 +104 @@
             playerCivicBoxColumn = "civIcont[" + playerState.team + "][" + positionObject + "]";
             playerCounterValue = "valueDataTeam[" + playerState.team + "][" + positionObject + "]";
         }
 
         let colorString = "color: " +
-                Math.floor(playerState.color.r * 255) + " " +
-                Math.floor(playerState.color.g * 255) + " " +
-                Math.floor(playerState.color.b * 255);
+            Math.floor(playerState.color.r * 255) + " " +
+            Math.floor(playerState.color.g * 255) + " " +
+            Math.floor(playerState.color.b * 255);
 
         let rowPlayerObject = Engine.GetGUIObjectByName(rowPlayer);
         rowPlayerObject.hidden = false;
         rowPlayerObject.sprite = colorString + g_PlayerBoxAlpha;
 
@@ -119 +119 @@
         rowPlayerObject.size = boxSize;
 
         let playerColorBox = Engine.GetGUIObjectByName(playerColorBoxColumn);
         playerColorBox.sprite = colorString + g_PlayerColorBoxAlpha;
 
-        Engine.GetGUIObjectByName(playerNameColumn).caption = g_GameData.players[i+1].name;
+        Engine.GetGUIObjectByName(playerNameColumn).caption = g_GameData.sim.playerStates[i+1].name;
 
         let civIcon = Engine.GetGUIObjectByName(playerCivicBoxColumn);
         civIcon.sprite = "stretched:" + g_CivData[playerState.civ].Emblem;
         civIcon.tooltip = g_CivData[playerState.civ].Name;
 
@@ -135 +135 @@
     let teamCounterFn = panelInfo.teamCounterFn;
     if (g_Teams && teamCounterFn)
         teamCounterFn(panelInfo.counters);
 }
 
+function confirmStartReplay()
+{
+    if (Engine.HasXmppClient())
+        messageBox(
+            400, 200,
+            translate("Are you sure you want to quit the lobby?"),
+            translate("Confirmation"),
+            [translate("No"), translate("Yes")],
+            [null, startReplay]
+        );
+    else
+        startReplay();
+}
+
+function continueButton()
+{
+    if (g_GameData.gui.isInGame)
+        Engine.PopGuiPageCB(0);
+    else if (g_GameData.gui.isReplay)
+        Engine.SwitchGuiPage("page_replaymenu.xml", {
+            "replaySelectionData": g_GameData.gui.replaySelectionData
+        });
+    else if (Engine.HasXmppClient())
+        Engine.SwitchGuiPage("page_lobby.xml");
+    else
+        Engine.SwitchGuiPage("page_pregame.xml");
+}
+
 function startReplay()
 {
     if (Engine.HasXmppClient())
         Engine.StopXmppClient();
 
-    Engine.StartVisualReplay(g_GameData.replayDirectory);
+    Engine.StartVisualReplay(g_GameData.gui.replayDirectory);
     Engine.SwitchGuiPage("page_loading.xml", {
-        "attribs": Engine.GetReplayAttributes(g_GameData.replayDirectory),
+        "attribs": Engine.GetReplayAttributes(g_GameData.gui.replayDirectory),
         "isNetworked": false,
         "playerAssignments": {
             "local": {
                 "name": singleplayerName(),
                 "player": -1
             }
         },
         "savedGUIData": "",
         "isReplay": true,
-        "replaySelectionData": g_GameData.replaySelectionData
+        "replaySelectionData": g_GameData.gui.replaySelectionData
     });
 }
 
 function init(data)
 {
-    updateObjectPlayerPosition();
     g_GameData = data;
 
-    let mapSize = data.mapSettings.Size && g_Settings.MapSizes.find(size => size.Tiles == data.mapSettings.Size);
-    let mapType = g_Settings.MapTypes.find(mapType => mapType.Name == data.mapSettings.mapType);
+    let assignedState = g_GameData.sim.playerStates[g_GameData.gui.assignedPlayer || -1];
     
+    Engine.GetGUIObjectByName("summaryText").caption =
+        !assignedState ?
+            translate("You have left the game.") :
+        g_GameData.gui.disconnected ?
+            translate("You have been disconnected.") :
+        assignedState.state == "won" ?
+            translate("You have won the battle!") :
+        assignedState.state == "defeated" ?
+            translate("You have been defeated...") :
+            translate("You have abandoned the game.");
+
+    initPlayerBoxPositions();
+
     Engine.GetGUIObjectByName("timeElapsed").caption = sprintf(
         translate("Game time elapsed: %(time)s"), {
-            "time": timeToString(data.timeElapsed)
+            "time": timeToString(g_GameData.sim.timeElapsed)
     });
 
-    Engine.GetGUIObjectByName("summaryText").caption = data.gameResult;
+    let mapType = g_Settings.MapTypes.find(mapType => mapType.Name == g_GameData.sim.mapSettings.mapType);
+    let mapSize = g_Settings.MapSizes.find(size => size.Tiles == g_GameData.sim.mapSettings.Size || 0);
 
     Engine.GetGUIObjectByName("mapName").caption = sprintf(
         translate("%(mapName)s - %(mapType)s"), {
-            "mapName": translate(data.mapSettings.Name),
+            "mapName": translate(g_GameData.sim.mapSettings.Name),
             "mapType": mapSize ? mapSize.LongName : (mapType ? mapType.Title : "")
         });
 
-    Engine.GetGUIObjectByName("replayButton").hidden = g_GameData.isInGame || !g_GameData.replayDirectory;
+    Engine.GetGUIObjectByName("replayButton").hidden = g_GameData.gui.isInGame || !g_GameData.gui.replayDirectory;
 
     // Panels
-    g_PlayerCount = data.playerStates.length - 1;
+    g_PlayerCount = data.sim.playerStates.length - 1;
 
-    if (data.mapSettings.LockTeams)
+    if (data.sim.mapSettings.LockTeams)
     {
         // Count teams
         for (let t = 0; t < g_PlayerCount; ++t)
         {
-            let playerTeam = data.playerStates[t+1].team;
+            let playerTeam = g_GameData.sim.playerStates[t+1].team;
             g_Teams[playerTeam] = (g_Teams[playerTeam] || 0) + 1;
         }
 
         if (g_Teams.length == g_PlayerCount)
             g_Teams = false;    // Each player has his own team. Displaying teams makes no sense.
@@ -201 +241 @@
 
     // Erase teams data if teams are not displayed
     if (!g_Teams)
     {
         for (let p = 0; p < g_PlayerCount; ++p)
-            data.playerStates[p+1].team = -1;
+            g_GameData.sim.playerStates[p+1].team = -1;
     }
 
     g_WithoutTeam = g_PlayerCount;
     if (g_Teams)
     {

binaries/data/mods/public/gui/summary/summary.xml

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 
-<!--
-==========================================
-- POST-GAME SUMMARY SCREEN -
-==========================================
--->
-
 <objects>
     <script file="gui/common/functions_global_object.js"/>
     <script file="gui/common/functions_civinfo.js"/>
     <script file="gui/common/functions_utility.js"/>
     <script file="gui/common/settings.js"/>
@@ -162 +156 @@
             </object>
         </object>
 
         <object type="button" name="replayButton" style="ModernButtonRed" size="100%-310 100%-48 100%-170 100%-20">
             <translatableAttribute id="caption">Replay</translatableAttribute>
-            <action on="Press"><![CDATA[
-                if (g_GameData.isInGame)
-                    return;
-
-                if (Engine.HasXmppClient())
-                    messageBox(
-                        400, 200,
-                        translate("Are you sure you want to quit the lobby?"),
-                        translate("Confirmation"),
-                        [translate("No"), translate("Yes")],
-                        [null, startReplay]
-                    );
-                else
-                    startReplay();
-                ]]>
-            </action>
+            <action on="Press">confirmStartReplay();</action>
         </object>
 
         <object type="button" style="ModernButtonRed" size="100%-160 100%-48 100%-20 100%-20">
             <translatableAttribute id="caption">Continue</translatableAttribute>
-            <action on="Press"><![CDATA[
-                if (g_GameData.isInGame)
-                {
-                    Engine.PopGuiPageCB(0);
-                }
-                else if (g_GameData.isReplay)
-                {
-                    Engine.SwitchGuiPage("page_replaymenu.xml", { "replaySelectionData": g_GameData.replaySelectionData });
-                }
-                else if (!Engine.HasXmppClient())
-                {
-                    Engine.SwitchGuiPage("page_pregame.xml");
-                }
-                else
-                {
-                    Engine.LobbySetPlayerPresence("available");
-                    Engine.SwitchGuiPage("page_lobby.xml");
-                }
-                ]]>
-            </action>
+            <action on="Press">continueButton();</action>
         </object>
     </object>
 </objects>

binaries/data/mods/public/maps/scripts/ConquestCommon.js

@@ -23 +23 @@
     let index = entities.indexOf(msg.entity);
 
     if (index >= 0)
     {
         entities.splice(index, 1);
-        if (!entities.length && Engine.QueryInterface(this.conquestEntitiesByPlayer[msg.from].player, IID_Player).GetState() == "active")
-            Engine.PostMessage(this.conquestEntitiesByPlayer[msg.from].player, MT_PlayerDefeated, { "playerId": msg.from } );
+        if (!entities.length)
+        {
+            let cmpPlayer = QueryPlayerIDInterface(msg.from);
+            if (cmpPlayer)
+                cmpPlayer.SetState("defeated");
+        }
     }
 }
 
 Trigger.prototype.ConquestAddStructure = function(msg)
 {

binaries/data/mods/public/maps/scripts/TriggerHelper.js

@@ -125 +125 @@
 /**
  * Defeats a player
  */
 TriggerHelper.DefeatPlayer = function(playerID)
 {
-    let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
-    let playerEnt = cmpPlayerManager.GetPlayerByID(playerID);
-
-    Engine.PostMessage(playerEnt, MT_PlayerDefeated, { "playerId": playerID } );
+    let cmpPlayer = QueryPlayerIDInterface(playerID);
+    if (cmpPlayer)
+        cmpPlayer.SetState("defeated");
 };
 
 /**
  * Returns the number of current players
  */

binaries/data/mods/public/simulation/components/EndGameManager.js

@@ -1 +1 @@
 /**
- * System component which regularly checks victory/defeat conditions
- * and if they are satisfied then it marks the player as victorious/defeated.
+ * System component which regularly checks victory/defeat conditions and if
+ * they are satisfied then it marks the player as victorious/defeated.
  */
 function EndGameManager() {}
 
 EndGameManager.prototype.Schema =
     "<a:component type='system'/><empty/>";
@@ -50 +50 @@
     let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
     let numPlayers = cmpPlayerManager.GetNumPlayers();
 
     for (let i = 1; i < numPlayers; ++i)
     {
-        let playerEntityId = cmpPlayerManager.GetPlayerByID(i);
-        let cmpPlayer = Engine.QueryInterface(playerEntityId, IID_Player);
+        let cmpPlayer = QueryPlayerIDInterface(i);
 
-        if (cmpPlayer.GetState() != "active")
-            continue;
-
-        if (playerID == cmpPlayer.GetPlayerID() || this.alliedVictory && cmpPlayer.IsMutualAlly(playerID))
+        if (playerID == i || this.alliedVictory && cmpPlayer.IsMutualAlly(playerID))
             cmpPlayer.SetState("won");
         else
-            Engine.PostMessage(playerEntityId, MT_PlayerDefeated, {
-                "playerId": i,
-                "skipAlliedVictoryCheck": true
-            });
+            cmpPlayer.SetState("defeated");
     }
-
-    // Reveal the map to all players
-    let cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
-    cmpRangeManager.SetLosRevealAll(-1, true);
 };
 
 EndGameManager.prototype.SetAlliedVictory = function(flag)
 {
     this.alliedVictory = flag;
@@ -99 +88 @@
 
         allies.push(playerID);
     }
 
     if (this.alliedVictory || allies.length == 1)
-    {
         for (let playerID of allies)
         {
             let cmpPlayer = QueryPlayerIDInterface(playerID);
             if (cmpPlayer)
                 cmpPlayer.SetState("won");
         }
-
-        let cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
-        if (cmpRangeManager)
-            cmpRangeManager.SetLosRevealAll(-1, true);
-    }
     else
         this.lastManStandingMessage = cmpGuiInterface.AddTimeNotification({
             "message": markForTranslation("Last remaining player wins."),
             "translateMessage": true,
         }, 12 * 60 * 60 * 1000); // 12 hours

binaries/data/mods/public/simulation/components/Player.js

@@ -357 +357 @@
 Player.prototype.GetState = function()
 {
     return this.state;
 };
 
-Player.prototype.SetState = function(newState)
+Player.prototype.SetState = function(newState, resign, skipAlliedVictoryCheck)
 {
+    if (this.state != "active")
+        return;
+
+    if (newState != "won" && newState != "defeated")
+    {
+        warn("Can't change playerstate to " + this.state);
+        return;
+    }
+
     this.state = newState;
+
+    let won = newState == "won";
+
+    // Reveal map to all or only that player
+    let cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
+    cmpRangeManager.SetLosRevealAll(won ? -1 : this.playerID, true);
+
+    if (!won)
+    {
+        // Reassign all player's entities to Gaia
+        let entities = cmpRangeManager.GetEntitiesByPlayer(this.playerID);
+
+        // The ownership change is done in two steps so that entities don't hit idle
+        // (and thus possibly look for "enemies" to attack) before nearby allies get
+        // converted to Gaia as well.
+        for (let entity of entities)
+        {
+            let cmpOwnership = Engine.QueryInterface(entity, IID_Ownership);
+            cmpOwnership.SetOwnerQuiet(0);
+        }
+
+        // With the real ownership change complete, send OwnershipChanged messages.
+        for (let entity of entities)
+            Engine.PostMessage(entity, MT_OwnershipChanged, {
+                "entity": entity,
+                "from": this.playerID,
+                "to": 0
+            });
+    }
+
+    // Inform the simulation
+    if (won)
+        Engine.BroadcastMessage(MT_PlayerWon, { "playerId": this.playerID });
+    else
+        Engine.BroadcastMessage(MT_PlayerDefeated, {
+            "playerId": this.playerID,
+            "skipAlliedVictoryCheck": skipAlliedVictoryCheck
+        });
+
+    // Inform the GUI
+    let cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+    if (won)
+        cmpGUIInterface.PushNotification({
+            "type": "won",
+            "players": [this.playerID]
+        });
+    else
+        cmpGUIInterface.PushNotification({
+            "type": "defeat",
+            "players": [this.playerID],
+            "resign": resign
+        });
 };
 
 Player.prototype.GetTeam = function()
 {
     return this.team;
@@ -647 +708 @@
         if (cmpIdentity && cmpIdentity.HasClass("Hero"))
             this.heroes.push(msg.entity);
     }
 };
 
-Player.prototype.OnPlayerDefeated = function(msg)
-{
-    this.state = "defeated";
-
-    // Reassign all player's entities to Gaia
-    var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
-    var entities = cmpRangeManager.GetEntitiesByPlayer(this.playerID);
-
-    // The ownership change is done in two steps so that entities don't hit idle
-    // (and thus possibly look for "enemies" to attack) before nearby allies get
-    // converted to Gaia as well.
-    for (var entity of entities)
-    {
-        var cmpOwnership = Engine.QueryInterface(entity, IID_Ownership);
-        cmpOwnership.SetOwnerQuiet(0);
-    }
-
-    // With the real ownership change complete, send OwnershipChanged messages.
-    for (var entity of entities)
-        Engine.PostMessage(entity, MT_OwnershipChanged, {
-            "entity": entity,
-            "from": this.playerID,
-            "to": 0
-        });
-
-    // Reveal the map for this player.
-    cmpRangeManager.SetLosRevealAll(this.playerID, true);
-
-    // Send a chat message notifying of the player's defeat.
-    var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
-    cmpGUIInterface.PushNotification({
-        "type": "defeat",
-        "players": [this.playerID],
-        "resign": !!msg.resign
-    });
-};
-
 Player.prototype.OnResearchFinished = function(msg)
 {
     if (msg.tech == this.template.SharedLosTech)
         this.UpdateSharedLos();
     else if (msg.tech == this.template.SharedDropsitesTech)

binaries/data/mods/public/simulation/components/interfaces/EndGameManager.js

@@ -1 +1 @@
 Engine.RegisterInterface("EndGameManager");
 Engine.RegisterMessageType("PlayerDefeated");
+Engine.RegisterMessageType("PlayerWon");
 Engine.RegisterMessageType("GameTypeChanged");

binaries/data/mods/public/simulation/helpers/Cheat.js

@@ -46 +46 @@
             else
                 Engine.DestroyEntity(ent);
         }
         return;
     case "defeatplayer":
-        var playerEnt = cmpPlayerManager.GetPlayerByID(input.parameter);
-        if (playerEnt == INVALID_ENTITY)
-            return;
-        Engine.PostMessage(playerEnt, MT_PlayerDefeated, { "playerId": input.parameter });
+        cmpPlayer = QueryPlayerIDInterface(input.parameter);
+        if (cmpPlayer)
+            cmpPlayer.SetState("defeated");
         return;
     case "createunits":
         var cmpProductionQueue = input.selected.length && Engine.QueryInterface(input.selected[0], IID_ProductionQueue);
         if (!cmpProductionQueue)
         {

binaries/data/mods/public/simulation/helpers/Commands.js

@@ -412 +412 @@
         }
     },
 
     "defeat-player": function(player, cmd, data)
     {
-        // Send "OnPlayerDefeated" message to player
-        Engine.PostMessage(data.playerEnt, MT_PlayerDefeated, { "playerId": player, "resign": !!cmd.resign });
+        let cmpPlayer = QueryPlayerIDInterface(player);
+        if (cmpPlayer)
+            cmpPlayer.SetState("defeated", !!cmd.resign);
     },
 
     "garrison": function(player, cmd, data)
     {
         // Verify that the building can be controlled by the player or is mutualAlly