Ticket #2373: resignation_v3.patch

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

@@ -22 +22 @@
 {
     if (btnCode !== undefined && g_messageBoxBtnFunctions[btnCode])
     {
-        if (g_messageBoxCallbackArgs[btnCode])
-            g_messageBoxBtnFunctions[btnCode](g_messageBoxCallbackArgs[btnCode]);
+        // cache the vales to make it possible to call a messageBox from a callback function.
+        var callbackFunction = g_messageBoxBtnFunctions[btnCode];
+        var callbackArgs = g_messageBoxCallbackArgs[btnCode]
+        g_messageBoxBtnFunctions  = [];
+        g_messageBoxCallbackArgs = [];
+
+        if (callbackArgs !== undefined)
+            callbackFunction(callbackArgs);
         else
-            g_messageBoxBtnFunctions[btnCode]();
+            callbackFunction();
+            
+        return;
     }
-
     g_messageBoxBtnFunctions  = [];
     g_messageBoxCallbackArgs = [];
 }

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

@@ -147 +147 @@
     closeOpenDialogs();
     pauseGame();
     var btCaptions = ["Yes", "No"];
-    var btCode = [leaveGame, resumeGame];
+    var btCode = [g_IsNetworked && !g_GameEnded ? networkReturnQuestion : prepareLeaveGame, resumeGame];
     messageBox(400, 200, "Are you sure you want to quit?", "Confirmation", 0, btCaptions, btCode);
 }
 
+function networkReturnQuestion()
+{
+    var btCaptions = ["Yes, I will return", "No, I resign"];
+    var btCode = [prepareLeaveGame, prepareLeaveGame];
+    var btArgs = [true, false];
+    messageBox(400, 200, "You are exiting the game, will you return soon?", "Confirmation", 0, btCaptions, btCode, btArgs);
+}
 
 function openDeleteDialog(selection)
 {

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

@@ -207 +207 @@
         {
             if (! message.hosts[host])
             {
+                // cache values
+                var removedPlayerID = g_PlayerAssignments[host].player;
+                var removedPlayerName = g_PlayerAssignments[host].name;
+                var removedPlayerState = g_Players[removedPlayerID].state;
                 // Tell the user about the disconnection
                 addChatMessage({ "type": "disconnect", "guid": host });
 
                 // Update the cached player data, so we can display the disconnection status
                 updatePlayerDataRemove(g_Players, host);
+
+                if (removedPlayerState != "active")
+                    return;
+                // start timer and show timeout message
+                Engine.PostNetworkCommand({
+                    "type": "start-player-timeout",
+                    "playerID": removedPlayerID,
+                    "playerName": removedPlayerName,
+                    "rejoinTimeLimit": REJOIN_TIME_LIMIT
+                });
             }
         }
 
@@ -225 +239 @@
 
                 // Tell the user about the connection
                 addChatMessage({ "type": "connect", "guid": host }, message.hosts);
+            
+                if (g_Players[message.hosts[host].player].state != "active")
+                    return;
+                // stop timer and show timeout message
+                Engine.PostNetworkCommand({
+                    "type": "stop-player-timeout",
+                    "playerID": message.hosts[host].player,
+                });
             }
         }
 

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

@@ -1 +1 @@
 // Network Mode
 var g_IsNetworked = false;
+const REJOIN_TIME_LIMIT = 15; // rejoin time limit in seconds
+const TIME_UNTIL_ENGINE_ENDS_GAME = 5000; // time in ms until the engine quits the game (in MP with resign)
 
 // Is this user in control of game settings (i.e. is a network server, or offline player)
 var g_IsController;
@@ -37 +39 @@
 // Whether the player has lost/won and reached the end of their game
 var g_GameEnded = false;
 
+// true, if prepareLeaveGame() was called
+var g_leaveGameInProcess = false;
+
 var g_Disconnected = false; // Lost connection to server
 
 // Holds player states from the last tick
@@ -234 +239 @@
     Engine.SubmitUserReport("profile", 3, JSON.stringify(data));
 }
 
-function resignGame()
+/**
+ * let's a player resign
+ * leaveGameAfterResign: if true, game is quit, after resign
+ */
+function resignGame(leaveGameAfterResign)
 {
     var simState = GetSimState();
 
@@ -248 +257 @@
         "playerId": Engine.GetPlayerID()
     });
 
-    global.music.setState(global.music.states.DEFEAT);
-    resumeGame();
+    // resume to the game, if the resign button was used
+    if (!leaveGameAfterResign)
+    {
+        global.music.setState(global.music.states.DEFEAT);
+        resumeGame();
+    }
 }
 
-function leaveGame()
+/**
+ * prepare to leave the game
+ * willRejoin: can be set to true, in case of network game, if the player just has to reboot or restart the game
+ */
+function prepareLeaveGame(willRejoin)
 {
     var extendedSimState = Engine.GuiInterfaceCall("GetExtendedSimulationState");
     var playerState = extendedSimState.players[Engine.GetPlayerID()];
     var mapSettings = Engine.GetMapSettings();
     var gameResult;
+    var timeUntilEngineEndsGame = 1;
 
     if (g_Disconnected)
     {
@@ -274 +292 @@
     else // "active"
     {
         gameResult = "You have abandoned the game.";
-
-        // Tell other players that we have given up and been defeated
-        Engine.PostNetworkCommand({
-            "type": "defeat-player",
-            "playerId": Engine.GetPlayerID()
-        });
-
         global.music.setState(global.music.states.DEFEAT);
+        
+        // resign, if player click on "No, I resign"
+        if (!willRejoin)
+        {
+            gameResult = "You have been defeated...";
+            resignGame(true);
+            timeUntilEngineEndsGame = TIME_UNTIL_ENGINE_ENDS_GAME; // give engine some time to deliver the network message (before the client disconnects...)
+        }
     }
+    g_leaveGameInProcess = true;
+    setTimeout(function() { leaveGame({"gameResult": gameResult, "extendedSimState": extendedSimState, "mapSettings": mapSettings}); }, timeUntilEngineEndsGame);
+}
 
+/**
+ * leaves the game; is needed to give network messages time to reach their destination
+ * data: must contain gameResult, extendedSimState and mapSettings
+ */
+function leaveGame(data)
+{
     stopAmbient();
     Engine.EndGame();
 
@@ -291 +319 @@
         Engine.SendUnregisterGame();
 
     Engine.SwitchGuiPage("page_summary.xml", {
-                            "gameResult"  : gameResult,
-                            "timeElapsed" : extendedSimState.timeElapsed,
-                            "playerStates": extendedSimState.players,
+                            "gameResult"  : data.gameResult,
+                            "timeElapsed" : data.extendedSimState.timeElapsed,
+                            "playerStates": data.extendedSimState.players,
                             "players": g_Players,
-                            "mapSettings": mapSettings
+                            "mapSettings": data.mapSettings
                          });
 }
 
@@ -427 +455 @@
         var btCode = [null];
         var message = "Press OK to continue";
     }
-    else
+    else if (!g_leaveGameInProcess)
     {
         var btCaptions = ["Yes", "No"];
-        var btCode = [leaveGame, null];
+        var btCode = [prepareLeaveGame, null];
         var message = "Do you want to quit?";
     }
+    else
+    {
+        var btCaptions = ["Ok"];
+        var btCode = [null];
+        var message = "You have been defeated. Game will exit now.";
+    }
 
     if (playerState.state == "defeated")
     {

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

@@ -39 +39 @@
     <!--
         <action on="Press"><![CDATA[
             messageBox(400, 200, "Do you really want to quit?", "Confirmation", 0,
-                ["Yes", "No!"], [leaveGame, null]);
+                ["Yes", "No!"], [prepareLeaveGame, null]);
         ]]></action>
     -->
 
@@ -776 +776 @@
         z="40"
     >
         <object size="4 36 100%-4 50%+20">
+        
+            <!-- Manual button -->
+            <object type="button"
+                name="manualButton"
+                style="StoneButtonFancy"
+                size="0 0 100% 28"
+                tooltip_style="sessionToolTip"
+            >
+                Manual
+                <action on="Press">openManual();</action>
+            </object>
+            
+            <!-- Chat button -->
+            <object type="button"
+                name="chatButton"
+                style="StoneButtonFancy"
+                size="0 32 100% 60"
+                tooltip_style="sessionToolTip"
+            >
+                Chat
+                <action on="Press">chatMenuButton();</action>
+            </object>
 
-        <!-- Settings button -->
-        <object type="button"
-            name="settingsButton"
-            style="StoneButtonFancy"
-            size="0 0 100% 28"
-            tooltip_style="sessionToolTip"
-        >
-            Settings
-            <action on="Press">settingsMenuButton();</action>
-        </object>
+            <!-- Save game button -->
+            <object type="button"
+                name="saveGameButton"
+                style="StoneButtonFancy"
+                size="0 64 100% 92"
+                tooltip_style="sessionToolTip"
+            >
+                Save
+                <action on="Press">
+                openSave();
+                </action>
+            </object>
+            
+            <!-- Settings button -->
+            <object type="button"
+                name="settingsButton"
+                style="StoneButtonFancy"
+                size="0 96 100% 124"
+                tooltip_style="sessionToolTip"
+            >
+                Settings
+                <action on="Press">settingsMenuButton();</action>
+            </object>
 
-
-        <!-- Save game button -->
-        <object type="button"
-            name="saveGameButton"
-            style="StoneButtonFancy"
-            size="0 32 100% 60"
-            tooltip_style="sessionToolTip"
-        >
-            Save
-            <action on="Press">
-            openSave();
-            </action>
+            <!-- Pause / Resume Button -->
+            <object type="button"
+                name="pauseButton"
+                style="StoneButtonFancy"
+                size="0 128 100% 156"
+                tooltip_style="sessionToolTip"
+            >
+                <object name="pauseButtonText" type="text" style="CenteredButtonText" ghost="true">Pause</object>
+                <action on="Press">togglePause();</action>
+            </object>
+            
+            <!-- Resign button -->
+            <object type="button"
+                name="menuResignButton"
+                style="StoneButtonFancy"
+                size="0 160 100% 188"
+                tooltip_style="sessionToolTip"
+            >
+                Resign
+                <action on="Press">resignMenuButton();</action>
+            </object>
+            
+            <!-- Exit button -->
+            <object type="button"
+                name="menuExitButton"
+                style="StoneButtonFancy"
+                size="0 192 100% 220"
+                tooltip_style="sessionToolTip"
+            >
+                Exit
+                <action on="Press">exitMenuButton();</action>
+            </object>
         </object>
-
-        <!-- Chat button -->
-        <object type="button"
-            name="chatButton"
-            style="StoneButtonFancy"
-            size="0 64 100% 92"
-            tooltip_style="sessionToolTip"
-        >
-            Chat
-            <action on="Press">chatMenuButton();</action>
-        </object>
-
-        <!-- Resign button -->
-        <object type="button"
-            name="menuResignButton"
-            style="StoneButtonFancy"
-            size="0 96 100% 124"
-            tooltip_style="sessionToolTip"
-        >
-            Resign
-            <action on="Press">resignMenuButton();</action>
-        </object>
-
-        <!-- Exit button -->
-        <object type="button"
-            name="menuExitButton"
-            style="StoneButtonFancy"
-            size="0 128 100% 156"
-            tooltip_style="sessionToolTip"
-        >
-            Exit
-            <action on="Press">exitMenuButton();</action>
-        </object>
-
-        <!-- Pause / Resume Button -->
-        <object type="button"
-            name="pauseButton"
-            style="StoneButtonFancy"
-            size="0 160 100% 188"
-            tooltip_style="sessionToolTip"
-        >
-            <object name="pauseButtonText" type="text" style="CenteredButtonText" ghost="true">Pause</object>
-            <action on="Press">togglePause();</action>
-        </object>
-
-        <!-- Manual button -->
-        <object type="button"
-            name="manualButton"
-            style="StoneButtonFancy"
-            size="0 192 100% 220"
-            tooltip_style="sessionToolTip"
-        >
-            Manual
-            <action on="Press">openManual();</action>
-        </object>
-        </object>
     </object>
 
     <!-- In-progress research -->
@@ -1354 +1353 @@
         tooltip_style="sessionToolTip"
     >
         <object size="0 0 100% 100%" type="text" style="CenteredButtonText" name="disconnectedExitButtonText" ghost="true">Exit</object>
-        <action on="Press">leaveGame()</action>
+        <action on="Press">prepareLeaveGame()</action>
     </object>
 
     </object>

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

@@ -19 +19 @@
     // Allied victory means allied players can win if victory conditions are met for each of them
     // Would be false for a "last man standing" game (when diplomacy is fully implemented)
     this.alliedVictory = true;
+    
+    // is used to store IDs of timer for auto timeout in multiplayer game
+    // uses as indices the playerID of the player, which times out.
+    this.autoPlayerTimeout = [];
 };
 
 EndGameManager.prototype.SetGameType = function(newGameType)
@@ -32 +36 @@
     return this.gameType == type;
 };
 
+/**
+ * starts the timeout counter, if a player leaves a multiplayer game
+ * playerID: ID of the player which left
+ * playerName: name of the player which left
+ * timeout: time in ms until the is timed out
+ */
+EndGameManager.prototype.startPlayerTimeout = function(playerID, playerName, timeout)
+{
+    // check, if the player is active
+    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var playerEntityId = cmpPlayerManager.GetPlayerByID(playerID);
+    var cmpPlayer =  Engine.QueryInterface(playerEntityId, IID_Player);
+
+    if (!cmpPlayer || cmpPlayer.GetState() != "active")
+        return;
+    // query some stuff
+    var cmpGuiInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    if (!cmpGuiInterface || !cmpTimer || !cmpPlayerManager)
+        return;
+        
+    // get players to send the message
+    var players = [];
+    for (var i = 1; i < cmpPlayerManager.GetNumPlayers(); i++)
+            players.push(i);    
+
+    // add timers
+    var textTimerID = cmpGuiInterface.AddTimeNotification({
+        "message": playerName + " will be auto-resigned in %T",
+        "players": players,
+        "time": timeout
+    });     
+    var timerID = cmpTimer.SetTimeout(SYSTEM_ENTITY, IID_EndGameManager, "MarkPlayerAsAutoResigned", timeout, playerID);
+    // save timer IDs
+    this.autoPlayerTimeout[playerID] = [textTimerID, timerID];
+};
+
+/**
+ * stops the timeout of a player, if he rejoins
+ * playerID: ID of the player which rejoined
+ */
+EndGameManager.prototype.stopPlayerTimeout = function(playerID)
+{
+    if (!this.autoPlayerTimeout[playerID]) // no timeout for player running
+        return;
+    var cmpGuiInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    if (!cmpGuiInterface || !cmpTimer)
+        return;
+    
+    // delete the timers
+    var timerIDs = this.autoPlayerTimeout[playerID];
+    cmpGuiInterface.DeleteTimeNotification(timerIDs[0]);
+    cmpTimer.CancelTimer(timerIDs[1]);
+    delete this.autoPlayerTimeout[playerID];
+};
+
+
+/**
+ * marks an player as auto resigned after an timeout. (is called by startPlayerTimeout normally)
+ * playerID: player ID of the player to mark as auto resigned
+ */
+EndGameManager.prototype.MarkPlayerAsAutoResigned = function(playerID)
+{
+    var cmpPlayerMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    if (!cmpPlayerMan)
+        return;
+
+    var playerEnt = cmpPlayerMan.GetPlayerByID(playerID);
+    if (playerEnt == INVALID_ENTITY)
+        return;
+
+    // send OnPlayerDefeated message 
+    Engine.PostMessage(playerEnt, MT_PlayerDefeated, { "playerId": playerID } );
+};
+
 EndGameManager.prototype.MarkPlayerAsWon = function(playerID)
 {
     var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);

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

@@ -321 +321 @@
         Engine.PostMessage(playerEnt, MT_PlayerDefeated, { "playerId": player } );
         break;
 
+    case "start-player-timeout":
+        var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
+        if (!cmpEndGameManager)
+            return;
+        cmpEndGameManager.startPlayerTimeout(cmd.playerID, cmd.playerName, cmd.rejoinTimeLimit * 1000);
+        break;
+        
+    case "stop-player-timeout":
+        var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
+        if (!cmpEndGameManager)
+            return;
+        cmpEndGameManager.stopPlayerTimeout(cmd.playerID);
+        break;
+        
     case "garrison":
         // Verify that the building can be controlled by the player or is mutualAlly
         if (CanControlUnitOrIsAlly(cmd.target, player, controlAllUnits))