Ticket #1949: rejoined_message_wip_v2.patch

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

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

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

@@ -113 +113 @@
 
     // 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

@@ -291 +291 @@
     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":
@@ -431 +435 @@
     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())

source/gui/scripting/ScriptFunctions.cpp

@@ -388 +388 @@
     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);
@@ -951 +958 @@
     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");
 

source/network/NetClient.cpp

@@ -115 +115 @@
     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);
@@ -286 +287 @@
     SendMessage(&readyStatus);
 }
 
+void CNetClient::SendRejoinedMessage()
+{
+    CRejoinedMessage rejoinedMessage;
+    SendMessage(&rejoinedMessage);
+}
+
 bool CNetClient::HandleMessage(CNetMessage* message)
 {
     // Handle non-FSM messages first
@@ -631 +638 @@
 
     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;
+}

source/network/NetClient.h

@@ -180 +180 @@
     
     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);
@@ -195 +202 @@
     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.

source/network/NetMessage.cpp

@@ -174 +174 @@
     case NMT_CHAT:
         pNewMessage = new CChatMessage;
         break;
-    
+
     case NMT_READY:
         pNewMessage = new CReadyMessage;
         break;
 
+    case NMT_REJOINED:
+        pNewMessage = new CRejoinedMessage;
+        break;
+
     case NMT_SIMULATION_COMMAND:
         pNewMessage = new CSimulationMessage(scriptInterface);
         break;

source/network/NetMessages.h

@@ -47 +47 @@
     NMT_AUTHENTICATE_RESULT,
     NMT_CHAT,       // Common chat message
     NMT_READY,
+    NMT_REJOINED,
     NMT_GAME_SETUP,
     NMT_PLAYER_ASSIGNMENT,
 
@@ -124 +125 @@
     NMT_FIELD_INT(m_Status, u8, 1)
 END_NMT_CLASS()
 
+START_NMT_CLASS_(Rejoined, NMT_REJOINED)
+    NMT_FIELD(CStr8, m_GUID)
+END_NMT_CLASS()
+
 START_NMT_CLASS_(PlayerAssignment, NMT_PLAYER_ASSIGNMENT)
     NMT_START_ARRAY(m_Hosts)
         NMT_FIELD(CStr8, m_GUID)

source/network/NetServer.cpp

@@ -598 +598 @@
     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);
@@ -922 +923 @@
     return true;
 }
 
+bool CNetServerWorker::OnRejoined(void* context, CFsmEvent* event)
+{
+    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::OnLoadedGame(void* context, CFsmEvent* event)
 {
     ENSURE(event->GetType() == (uint)NMT_LOADED_GAME);

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 OnRejoined(void* context, CFsmEvent* event);
     static bool OnLoadedGame(void* context, CFsmEvent* event);
     static bool OnJoinSyncingLoadedGame(void* context, CFsmEvent* event);
     static bool OnDisconnect(void* context, CFsmEvent* event);

source/ps/Game.cpp

@@ -235 +235 @@
     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())
     {
@@ -243 +246 @@
             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.