Ticket #2400: playerTimeout_v1.patch

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 (!g_IsController || 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_IsController || g_Players[message.hosts[host].player].state != "active") // TODO: check, if g_Players is getting updated.
+                    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 @@
+const REJOIN_TIME_LIMIT = 15; // rejoin time limit in seconds
+
 // Network Mode
 var g_IsNetworked = false;
 

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))