Ticket #2373: resignation_v6.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 = [prepareLeaveGame, resumeGame];
+    if (g_IsNetworked && !g_GameEnded)
+        btCode = [g_IsController ? abortNetworkGameQuestion : networkReturnQuestion, resumeGame];
     messageBox(400, 200, "Are you sure you want to quit?", "Confirmation", 0, btCaptions, btCode);
 }
 
+function networkReturnQuestion()
+{
+    var btCaptions = ["I resign", "I will return"];
+    var btCode = [prepareLeaveGame, prepareLeaveGame];
+    var btArgs = [false, true];
+    messageBox(400, 200, "You are exiting the game. Will you return soon or do you want to resign?", "Confirmation", 0, btCaptions, btCode, btArgs);
+}
 
+function abortNetworkGameQuestion()
+{
+    var btCaptions = ["Exit the game", "Resume"];
+    var btCode = [prepareLeaveGame, resumeGame];
+    messageBox(400, 200, "Because you are the host the game will end for all players if you leave.\n\nAre you sure you want to do that?", "Confirmation", 0, btCaptions, btCode);
+}
+
 function openDeleteDialog(selection)
 {
     closeMenu();

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

@@ +1 @@
+const TIME_UNTIL_ENGINE_ENDS_GAME = 3000; // time in ms until the engine quits the game (in MP with resign)
+
 // Network Mode
 var g_IsNetworked = false;
 
@@ -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()];
@@ -274 +291 @@
     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);
+        }
     }
+    g_leaveGameInProcess = true;
+    // exit the game
+    if(g_IsNetworked)
+        setTimeout(function() { leaveGame({"gameResult": gameResult, "extendedSimState": extendedSimState, "mapSettings": mapSettings}); }, TIME_UNTIL_ENGINE_ENDS_GAME);
+    else
+        leaveGame({"gameResult": gameResult, "extendedSimState": extendedSimState, "mapSettings": mapSettings});
+}
 
+/**
+ * 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 +321 @@
         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 +457 @@
         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>