Ticket #1950: pausing.patch

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

@@ -149 +149 @@
     let messages = [];
     let maxTextWidth = 0;
 
-    // TODO: Players who paused the game should be added here
-
     // Add network warnings
     if (Engine.ConfigDB_GetValue("user", "overlay.netwarnings") == "true")
     {

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

@@ -682 +682 @@
     Engine.SetPaused(true);
 }
 
+/**
+ * Resume the game in single player mode.
+ */
 function resumeGame()
 {
+    if (g_IsNetworked)
+        return;
+
     Engine.GetGUIObjectByName("pauseButtonText").caption = translate("Pause");
     Engine.GetGUIObjectByName("pauseOverlay").hidden = true;
     Engine.SetPaused(false);
@@ -696 +702 @@
 
     closeOpenDialogs();
 
+    Engine.GetGUIObjectByName("pauseOverlayNotPausing").hidden = true;
+
     let pauseOverlay = Engine.GetGUIObjectByName("pauseOverlay");
 
     Engine.SetPaused(pauseOverlay.hidden);

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

@@ -25 +25 @@
 var g_ChatTimers = [];
 
 /**
+ * The list of GUIDs of players who have currently paused the game.
+ */
+var g_PausingPlayers = [];
+
+/**
  * Handle all netmessage types that can occur.
  */
 var g_NetMessageTypes = {
@@ -31 +36 @@
     "netstatus": msg => handleNetStatusMessage(msg),
     "netwarn": msg => addNetworkWarning(msg),
     "players": msg => handlePlayerAssignmentsMessage(msg),
+    "paused": msg => handlePlayerPausedMessage(msg),
     "rejoined": msg => addChatMessage({ "type": "rejoined", "guid": msg.guid }),
     "kicked": msg => addChatMessage({ "type": "system", "text": sprintf(translate("%(username)s has been kicked"), { "username": msg.username }) }),
     "banned": msg => addChatMessage({ "type": "system", "text": sprintf(translate("%(username)s has been banned"), { "username": msg.username }) }),
@@ -496 +502 @@
     }
 }
 
+function handlePlayerPausedMessage(message)
+{
+    // Update list of pausing players.
+    if (message.pause)
+        g_PausingPlayers.push(message.guid);
+    else
+        g_PausingPlayers.splice(g_PausingPlayers.indexOf(message.guid));
+
+    var pausingListText = "";
+
+    g_PausingPlayers.forEach(player => {
+        pausingListText += colorizePlayernameByGUID(player) + "\n";
+    });
+
+    Engine.GetGUIObjectByName("pausingListText").caption = pausingListText;
+
+    // Display the overlay for players who didn't pause the game.
+    if (g_PausingPlayers.indexOf(Engine.GetPlayerGUID()) == -1)
+    {
+        let pauseOverlay = Engine.GetGUIObjectByName("pauseOverlayNotPausing");
+
+        closeOpenDialogs();
+
+        pauseOverlay.hidden = g_PausingPlayers.length == 0 || g_PausingPlayers == null;
+        Engine.PauseLocalSimulation(!pauseOverlay.hidden);
+    }
+}
+
 function updateChatAddressees()
 {
     let addressees = [

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

@@ -192 +192 @@
     </object>
 
     <!-- ================================  ================================ -->
+    <!-- Pause Overlay for other players who have not paused. -->
+    <!-- ================================  ================================ -->
+    <object name="pauseOverlayNotPausing" size="0 0 100% 100%" type="image" sprite="devCommandsBackground" ghost="false" hidden="true" z="0">
+        <object size="50%-128 50%-20 50%+128 50%+20" type="text" style="PauseText" ghost="true" z="0">
+            <translatableAttribute id="caption">Game Paused by:</translatableAttribute>
+        </object>
+
+        <object name="pausingListText" size="50%-128 50%+20 50%+128 80%" type="text" style="PausingListText" ghost="true" z="0"/>
+    </object>
+
+    <!-- ================================  ================================ -->
     <!-- Notification Area -->
     <!-- ================================  ================================ -->
     <object name="notificationPanel" type="image" size="50%-300 60 50%+300 120" ghost="true">

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

@@ -19 +19 @@
        text_valign="center"
     />
 
+    <style name="PausingListText"
+       font="sans-stroke-16"
+       textcolor="white"
+       text_align="center"
+       text_valign="top"
+    />
+
     <style name="BuildNameText"
        font="sans-stroke-12"
        textcolor="white"

source/gui/scripting/ScriptFunctions.cpp

@@ -780 +780 @@
         return;
     }
     g_Game->m_Paused = pause;
+
+    // Only send a message over the network if the game is networked.
+    if (g_NetClient)
+        g_NetClient->SendPausedMessage(pause);
+
 #if CONFIG2_AUDIO
     if (g_SoundManager)
         g_SoundManager->Pause(pause);
@@ -786 +791 @@
 #endif
 }
 
+// Pause the local simulation (does not send a paused message over the network).
+void PauseLocalSimulation(ScriptInterface::CxPrivate* pCxPrivate, bool pause)
+{
+    if (!g_Game)
+    {
+        JS_ReportError(pCxPrivate->pScriptInterface->GetContext(), "Game is not started");
+        return;
+    }
+    g_Game->m_Paused = pause;
+
+#if CONFIG2_AUDIO
+    if (g_SoundManager)
+        g_SoundManager->Pause(pause);
+#endif
+}
+
 // Return the global frames-per-second value.
 // params:
 // returns: FPS [int]
@@ -1088 +1109 @@
     scriptInterface.RegisterFunction<void, &ExitProgram>("Exit");
     scriptInterface.RegisterFunction<bool, &IsPaused>("IsPaused");
     scriptInterface.RegisterFunction<void, bool, &SetPaused>("SetPaused");
+    scriptInterface.RegisterFunction<void, bool, &PauseLocalSimulation>("PauseLocalSimulation");
     scriptInterface.RegisterFunction<int, &GetFps>("GetFPS");
     scriptInterface.RegisterFunction<std::wstring, int, &GetBuildTimestamp>("GetBuildTimestamp");
     scriptInterface.RegisterFunction<JS::Value, std::wstring, &ReadJSONFile>("ReadJSONFile");

source/network/NetClient.cpp

@@ -121 +121 @@
     AddTransition(NCS_INGAME, (uint)NMT_KICKED, NCS_INGAME, (void*)&OnKicked, context);
     AddTransition(NCS_INGAME, (uint)NMT_CLIENT_TIMEOUT, NCS_INGAME, (void*)&OnClientTimeout, context);
     AddTransition(NCS_INGAME, (uint)NMT_CLIENT_PERFORMANCE, NCS_INGAME, (void*)&OnClientPerformance, context);
+    AddTransition(NCS_INGAME, (uint)NMT_CLIENT_PAUSED, NCS_INGAME, (void*)&OnClientPaused, context);
     AddTransition(NCS_INGAME, (uint)NMT_CHAT, NCS_INGAME, (void*)&OnChat, context);
     AddTransition(NCS_INGAME, (uint)NMT_GAME_SETUP, NCS_INGAME, (void*)&OnGameSetup, context);
     AddTransition(NCS_INGAME, (uint)NMT_PLAYER_ASSIGNMENT, NCS_INGAME, (void*)&OnPlayerAssignment, context);
@@ -340 +341 @@
     SendMessage(&rejoinedMessage);
 }
 
+void CNetClient::SendPausedMessage(bool pause)
+{
+    CClientPausedMessage pausedMessage;
+    pausedMessage.m_Pause = pause;
+    SendMessage(&pausedMessage);
+}
+
 bool CNetClient::HandleMessage(CNetMessage* message)
 {
     // Handle non-FSM messages first
@@ -725 +733 @@
     return true;
 }
 
+bool CNetClient::OnClientPaused(void *context, CFsmEvent *event)
+{
+    ENSURE(event->GetType() == (uint)NMT_CLIENT_PAUSED);
+
+    CNetClient* client = (CNetClient*)context;
+    JSContext* cx = client->GetScriptInterface().GetContext();
+    CClientPausedMessage* message = (CClientPausedMessage*)event->GetParamRef();
+
+    JS::RootedValue msg(cx);
+    client->GetScriptInterface().Eval("({ 'type':'paused' })", &msg);
+    client->GetScriptInterface().SetProperty(msg, "pause", message->m_Pause);
+    client->GetScriptInterface().SetProperty(msg, "guid", message->m_GUID);
+    client->PushGuiMessage(msg);
+
+    return true;
+}
+
 bool CNetClient::OnLoadedGame(void* context, CFsmEvent* event)
 {
     ENSURE(event->GetType() == (uint)NMT_LOADED_GAME);

source/network/NetClient.h

@@ -197 +197 @@
      */
     void SendRejoinedMessage();
 
+    /**
+     * Call when the client has paused or unpaused the game.
+     */
+    void SendPausedMessage(bool pause);
+
 private:
     // Net message / FSM transition handlers
     static bool OnConnect(void* context, CFsmEvent* event);
@@ -215 +220 @@
     static bool OnKicked(void* context, CFsmEvent* event);
     static bool OnClientTimeout(void* context, CFsmEvent* event);
     static bool OnClientPerformance(void* context, CFsmEvent* event);
+    static bool OnClientPaused(void* context, CFsmEvent* event);
     static bool OnLoadedGame(void* context, CFsmEvent* event);
 
     /**

source/network/NetMessage.cpp

@@ -147 +147 @@
         pNewMessage = new CClientPerformanceMessage;
         break;
 
+    case NMT_CLIENT_PAUSED:
+        pNewMessage = new CClientPausedMessage;
+        break;
+
     case NMT_LOADED_GAME:
         pNewMessage = new CLoadedGameMessage;
         break;

source/network/NetMessages.h

@@ -28 +28 @@
 
 #define PS_PROTOCOL_MAGIC               0x5073013f      // 'P', 's', 0x01, '?'
 #define PS_PROTOCOL_MAGIC_RESPONSE      0x50630121      // 'P', 'c', 0x01, '!'
-#define PS_PROTOCOL_VERSION             0x01010011      // Arbitrary protocol
+#define PS_PROTOCOL_VERSION             0x01010012      // Arbitrary protocol
 #define PS_DEFAULT_PORT                 0x5073          // 'P', 's'
 
 // Defines the list of message types. The order of the list must not change.
@@ -62 +62 @@
 
     NMT_CLIENT_TIMEOUT,
     NMT_CLIENT_PERFORMANCE,
+    NMT_CLIENT_PAUSED,
 
     NMT_LOADED_GAME,
     NMT_GAME_START,
@@ -182 +183 @@
     NMT_END_ARRAY()
 END_NMT_CLASS()
 
+START_NMT_CLASS_(ClientPaused, NMT_CLIENT_PAUSED)
+    NMT_FIELD(CStr, m_GUID)
+    NMT_FIELD_INT(m_Pause, u8, 1)
+END_NMT_CLASS()
+
 START_NMT_CLASS_(LoadedGame, NMT_LOADED_GAME)
     NMT_FIELD_INT(m_CurrentTurn, u32, 4)
 END_NMT_CLASS()

source/network/NetServer.cpp

@@ -661 +661 @@
     session->AddTransition(NSS_JOIN_SYNCING, (uint)NMT_LOADED_GAME, NSS_INGAME, (void*)&OnJoinSyncingLoadedGame, context);
 
     session->AddTransition(NSS_INGAME, (uint)NMT_REJOINED, NSS_INGAME, (void*)&OnRejoined, context);
+    session->AddTransition(NSS_INGAME, (uint)NMT_CLIENT_PAUSED, NSS_INGAME, (void*)&OnClientPaused, context);
     session->AddTransition(NSS_INGAME, (uint)NMT_CONNECTION_LOST, NSS_UNCONNECTED, (void*)&OnDisconnect, context);
     session->AddTransition(NSS_INGAME, (uint)NMT_CHAT, NSS_INGAME, (void*)&OnChat, context);
     session->AddTransition(NSS_INGAME, (uint)NMT_SIMULATION_COMMAND, NSS_INGAME, (void*)&OnInGame, context);
@@ -704 +705 @@
 
 void CNetServerWorker::OnUserLeave(CNetServerSession* session)
 {
+    std::vector<CStr>::iterator pausing = std::find(m_PausingPlayers.begin(), m_PausingPlayers.end(), session->GetGUID());
+    if (pausing != m_PausingPlayers.end())
+    {
+        // Unpause for the leaving player.
+        m_PausingPlayers.erase(pausing);
+
+        CClientPausedMessage pausedMsg;
+        pausedMsg.m_GUID = session->GetGUID();
+        pausedMsg.m_Pause = false;
+        Broadcast(&pausedMsg);
+    }
+
     RemovePlayer(session->GetGUID());
 
     if (m_ServerTurnManager && session->GetCurrState() != NSS_JOIN_SYNCING)
@@ -1206 +1219 @@
     return true;
 }
 
+bool CNetServerWorker::OnClientPaused(void *context, CFsmEvent *event)
+{
+    ENSURE(event->GetType() == (uint)NMT_CLIENT_PAUSED);
+
+    CNetServerSession* session = (CNetServerSession*)context;
+    CNetServerWorker& server = session->GetServer();
+
+    CClientPausedMessage* message = (CClientPausedMessage*)event->GetParamRef();
+
+    message->m_GUID = session->GetGUID();
+
+    // Update the list of pausing players.
+    std::vector<CStr>::iterator player = std::find(server.m_PausingPlayers.begin(), server.m_PausingPlayers.end(), session->GetGUID());
+
+    if (message->m_Pause)
+    {
+        if (player != server.m_PausingPlayers.end())
+        {
+            LOGERROR("Player paused, but is already included in the list of paused players on the server.");
+            return true;
+        }
+
+        server.m_PausingPlayers.push_back(session->GetGUID());
+    }
+    else
+    {
+        if (player == server.m_PausingPlayers.end())
+        {
+            LOGERROR("Player unpaused, but is not included in the list of paused players on the server.");
+            return true;
+        }
+
+        server.m_PausingPlayers.erase(player);
+    }
+
+    server.Broadcast(message);
+
+    return true;
+}
+
 void CNetServerWorker::CheckGameLoadStatus(CNetServerSession* changedSession)
 {
     for (const CNetServerSession* session : m_Sessions)

source/network/NetServer.h

@@ -274 +274 @@
     static bool OnJoinSyncingLoadedGame(void* context, CFsmEvent* event);
     static bool OnRejoined(void* context, CFsmEvent* event);
     static bool OnDisconnect(void* context, CFsmEvent* event);
+    static bool OnClientPaused(void* context, CFsmEvent* event);
 
     void CheckGameLoadStatus(CNetServerSession* changedSession);
 
@@ -316 +317 @@
     std::vector<CStr> m_BannedIPs;
     std::vector<CStrW> m_BannedPlayers;
 
+    /**
+     * Holds the GUIDs of all currently paused players.
+     */
+    std::vector<CStr> m_PausingPlayers;
+
     u32 m_NextHostID;
 
     CNetServerTurnManager* m_ServerTurnManager;