Ticket #1949: rejoined_message_v4.patch

binaries/data/mods/public/gui/gamesetup/gamesetup_mp.js

@@ -109 +109 @@
 
             case "start":
                 Engine.SwitchGuiPage("page_loading.xml", {
                     "attribs": g_GameAttributes,
                     "isNetworked" : true,
+                    "isRejoining" : g_IsRejoining,
                     "playerAssignments": g_PlayerAssignments
                 });
                 break;
 
             case "chat":

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

@@ -111 +111 @@
     // Switch GUI from loading screen to game session.
     Engine.SwitchGuiPage("page_session.xml", g_Data);
 
     // Restore default cursor.
     Engine.SetCursor("arrow-default");
+    
+    // Notify the other clients that we have finished the loading screen
+    if (g_Data.isNetworked && g_Data.isRejoining)
+        Engine.SendNetworkRejoined();
 }

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

@@ -298 +298 @@
 
     case "aichat":
         addChatMessage({ "type": "message", "guid": message.guid, "text": message.text, "translate": true });
         break;
 
+    case "rejoined":
+        addChatMessage({ "type": "rejoined", "guid": message.guid});
+        break;
+        
     // To prevent errors, ignore these message types that occur during autostart
     case "gamesetup":
     case "start":
         break;
 
@@ -437 +441 @@
     var formatted;
 
     switch (msg.type)
     {
     case "connect":
-        formatted = sprintf(translate("%(player)s has joined the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        formatted = sprintf(translate("%(player)s is connecting..."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
         break;
     case "disconnect":
         formatted = sprintf(translate("%(player)s has left the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
         break;
+    case "rejoined":
+        formatted = sprintf(translate("%(player)s has rejoined the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
     case "defeat":
         // In singleplayer, the local player is "You". "You has" is incorrect.
         if (!g_IsNetworked && msg.player == Engine.GetPlayerID())
             formatted = translate("You have been defeated.");
         else

source/gui/scripting/ScriptFunctions.cpp

@@ -386 +386 @@
     ENSURE(g_NetClient);
 
     g_NetClient->SendChatMessage(message);
 }
 
+void SendNetworkRejoined(ScriptInterface::CxPrivate* UNUSED(pCxPrivate))
+{
+    ENSURE(g_NetClient);
+
+    g_NetClient->SendRejoinedMessage();
+}
+
 void SendNetworkReady(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), int message)
 {
     ENSURE(g_NetClient);
 
     g_NetClient->SendReadyMessage(message);
@@ -949 +956 @@
     scriptInterface.RegisterFunction<void, int, std::string, &AssignNetworkPlayer>("AssignNetworkPlayer");
     scriptInterface.RegisterFunction<void, std::string, int, &SetNetworkPlayerStatus>("SetNetworkPlayerStatus");
     scriptInterface.RegisterFunction<void, &ClearAllPlayerReady>("ClearAllPlayerReady");
     scriptInterface.RegisterFunction<void, std::wstring, &SendNetworkChat>("SendNetworkChat");
     scriptInterface.RegisterFunction<void, int, &SendNetworkReady>("SendNetworkReady");
+    scriptInterface.RegisterFunction<void, &SendNetworkRejoined>("SendNetworkRejoined");
     scriptInterface.RegisterFunction<JS::Value, &GetAIs>("GetAIs");
     scriptInterface.RegisterFunction<JS::Value, &GetEngineInfo>("GetEngineInfo");
 
     // Saved games
     scriptInterface.RegisterFunction<JS::Value, std::wstring, &StartSavedGame>("StartSavedGame");

source/network/NetClient.cpp

@@ -113 +113 @@
     AddTransition(NCS_INGAME, (uint)NMT_GAME_SETUP, NCS_INGAME, (void*)&OnGameSetup, context);
     AddTransition(NCS_INGAME, (uint)NMT_PLAYER_ASSIGNMENT, NCS_INGAME, (void*)&OnPlayerAssignment, context);
     AddTransition(NCS_INGAME, (uint)NMT_SIMULATION_COMMAND, NCS_INGAME, (void*)&OnInGame, context);
     AddTransition(NCS_INGAME, (uint)NMT_SYNC_ERROR, NCS_INGAME, (void*)&OnInGame, context);
     AddTransition(NCS_INGAME, (uint)NMT_END_COMMAND_BATCH, NCS_INGAME, (void*)&OnInGame, context);
+    AddTransition(NCS_INGAME, (uint)NMT_REJOINED, NCS_INGAME, (void*)&OnRejoined, context);
 
     // Set first state
     SetFirstState(NCS_UNCONNECTED);
 }
 
@@ -284 +285 @@
     CReadyMessage readyStatus;
     readyStatus.m_Status = status;
     SendMessage(&readyStatus);
 }
 
+void CNetClient::SendRejoinedMessage()
+{
+    CRejoinedMessage rejoinedMessage;
+    SendMessage(&rejoinedMessage);
+}
+
 bool CNetClient::HandleMessage(CNetMessage* message)
 {
     // Handle non-FSM messages first
 
     Status status = m_Session->GetFileTransferer().HandleMessageReceive(message);
@@ -582 +589 @@
     client->m_ClientTurnManager->UpdateFastForward();
 
     return true;
 }
 
+bool CNetClient::OnRejoined(void *context, CFsmEvent* event)
+{
+    ENSURE(event->GetType() == (uint)NMT_REJOINED);
+
+    CNetClient* client = (CNetClient*)context;
+    JSContext* cx = client->GetScriptInterface().GetContext();
+
+    CRejoinedMessage* message = (CRejoinedMessage*)event->GetParamRef();
+    JS::RootedValue msg(cx);
+    client->GetScriptInterface().Eval("({'type':'rejoined'})", &msg);
+    client->GetScriptInterface().SetProperty(msg, "guid", std::string(message->m_GUID), false);
+    client->PushGuiMessage(msg);
+
+    return true;
+}
+
 bool CNetClient::OnLoadedGame(void* context, CFsmEvent* event)
 {
     ENSURE(event->GetType() == (uint)NMT_LOADED_GAME);
 
     CNetClient* client = (CNetClient*)context;

source/network/NetClient.h

@@ -178 +178 @@
 
     void SendChatMessage(const std::wstring& text);
     
     void SendReadyMessage(const int status);
 
+    /**
+     * Call when the client has rejoined a running match and finished
+     * the loading screen.
+     */
+    void SendRejoinedMessage();
+
 private:
     // Net message / FSM transition handlers
     static bool OnConnect(void* context, CFsmEvent* event);
     static bool OnHandshake(void* context, CFsmEvent* event);
     static bool OnHandshakeResponse(void* context, CFsmEvent* event);
@@ -193 +199 @@
     static bool OnInGame(void* context, CFsmEvent* event);
     static bool OnGameStart(void* context, CFsmEvent* event);
     static bool OnJoinSyncStart(void* context, CFsmEvent* event);
     static bool OnJoinSyncEndCommandBatch(void* context, CFsmEvent* event);
     static bool OnLoadedGame(void* context, CFsmEvent* event);
+    static bool OnRejoined(void* context, CFsmEvent* event);
 
     /**
      * Take ownership of a session object, and use it for all network communication.
      */
     void SetAndOwnSession(CNetClientSession* session);

source/network/NetMessage.cpp

@@ -129 +129 @@
 
     case NMT_JOIN_SYNC_START:
         pNewMessage = new CJoinSyncStartMessage;
         break;
 
+    case NMT_REJOINED:
+        pNewMessage = new CRejoinedMessage;
+        break;
+
     case NMT_LOADED_GAME:
         pNewMessage = new CLoadedGameMessage;
         break;
 
     case NMT_SERVER_HANDSHAKE:
@@ -172 +176 @@
         break;
 
     case NMT_CHAT:
         pNewMessage = new CChatMessage;
         break;
-    
+
     case NMT_READY:
         pNewMessage = new CReadyMessage;
         break;
 
     case NMT_SIMULATION_COMMAND:

source/network/NetMessages.h

@@ -45 +45 @@
     NMT_SERVER_HANDSHAKE_RESPONSE,
     NMT_AUTHENTICATE,       // Authentication stage
     NMT_AUTHENTICATE_RESULT,
     NMT_CHAT,       // Common chat message
     NMT_READY,
+    NMT_REJOINED,
     NMT_GAME_SETUP,
     NMT_PLAYER_ASSIGNMENT,
 
     NMT_FILE_TRANSFER_REQUEST,
     NMT_FILE_TRANSFER_RESPONSE,
@@ -153 +154 @@
 END_NMT_CLASS()
 
 START_NMT_CLASS_(JoinSyncStart, NMT_JOIN_SYNC_START)
 END_NMT_CLASS()
 
+START_NMT_CLASS_(Rejoined, NMT_REJOINED)
+    NMT_FIELD(CStr8, m_GUID)
+END_NMT_CLASS()
+
 START_NMT_CLASS_(LoadedGame, NMT_LOADED_GAME)
     NMT_FIELD_INT(m_CurrentTurn, u32, 4)
 END_NMT_CLASS()
 
 START_NMT_CLASS_(GameStart, NMT_GAME_START)

source/network/NetServer.cpp

@@ -596 +596 @@
     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);
     session->AddTransition(NSS_INGAME, (uint)NMT_SYNC_CHECK, NSS_INGAME, (void*)&OnInGame, context);
     session->AddTransition(NSS_INGAME, (uint)NMT_END_COMMAND_BATCH, NSS_INGAME, (void*)&OnInGame, context);
+    session->AddTransition(NSS_INGAME, (uint)NMT_REJOINED, NSS_INGAME, (void*)&OnRejoined, context);
 
     // Set first state
     session->SetFirstState(NSS_HANDSHAKE);
 }
 
@@ -986 +987 @@
     session->SendMessage(&loaded);
 
     return true;
 }
 
+bool CNetServerWorker::OnRejoined(void* context, CFsmEvent* event)
+{
+
+    // A client has finished rejoining and his/her loading screen disappeared.
+
+    ENSURE(event->GetType() == (uint)NMT_REJOINED);
+
+    CNetServerSession* session = (CNetServerSession*)context;
+    CNetServerWorker& server = session->GetServer();
+
+    CRejoinedMessage* message = (CRejoinedMessage*)event->GetParamRef();
+
+    message->m_GUID = session->GetGUID();
+
+    server.Broadcast(message);
+
+    return true;
+}
+
 bool CNetServerWorker::OnDisconnect(void* context, CFsmEvent* event)
 {
     ENSURE(event->GetType() == (uint)NMT_CONNECTION_LOST);
 
     CNetServerSession* session = (CNetServerSession*)context;

source/network/NetServer.h

@@ -260 +260 @@
     static bool OnInGame(void* context, CFsmEvent* event);
     static bool OnChat(void* context, CFsmEvent* event);
     static bool OnReady(void* context, CFsmEvent* event);
     static bool OnLoadedGame(void* context, CFsmEvent* event);
     static bool OnJoinSyncingLoadedGame(void* context, CFsmEvent* event);
+    static bool OnRejoined(void* context, CFsmEvent* event);
     static bool OnDisconnect(void* context, CFsmEvent* event);
 
     void CheckGameLoadStatus(CNetServerSession* changedSession);
 
     void ConstructPlayerAssignmentMessage(CPlayerAssignmentMessage& message);

source/ps/Game.cpp

@@ -233 +233 @@
     
     // Render a frame to begin loading assets
     if (CRenderer::IsInitialised())
         Render();
 
+    if (g_NetClient)
+        g_NetClient->LoadFinished();
+
     // Call the reallyStartGame GUI function, but only if it exists
     if (g_GUI && g_GUI->HasPages())
     {
         JS::RootedValue global(cx, g_GUI->GetActiveGUI()->GetGlobalObject());
         if (g_GUI->GetActiveGUI()->GetScriptInterface()->HasProperty(global, "reallyStartGame"))
             g_GUI->GetActiveGUI()->GetScriptInterface()->CallFunctionVoid(global, "reallyStartGame");
     }
 
-    if (g_NetClient)
-        g_NetClient->LoadFinished();
-
     debug_printf("GAME STARTED, ALL INIT COMPLETE\n");
 
     // The call tree we've built for pregame probably isn't useful in-game.
     if (CProfileManager::IsInitialised())
         g_Profiler.StructuralReset();