Ticket #3581: t3581_stop_simulation_after_replay_v1.patch

source/network/NetTurnManager.cpp

@@ -59 +59 @@
 }
 
 CNetTurnManager::CNetTurnManager(CSimulation2& simulation, u32 defaultTurnLength, int clientId, IReplayLogger& replay) :
     m_Simulation2(simulation), m_CurrentTurn(0), m_ReadyTurn(1), m_TurnLength(defaultTurnLength), m_DeltaSimTime(0),
     m_PlayerId(-1), m_ClientId(clientId), m_HasSyncError(false), m_Replay(replay),
-    m_TimeWarpNumTurns(0)
+    m_TimeWarpNumTurns(0), m_FinalTurn(0)
 {
     // When we are on turn n, we schedule new commands for n+2.
     // We know that all other clients have finished scheduling commands for n (else we couldn't have got here).
     // We know we have not yet finished scheduling commands for n+2.
     // Hence other clients can be on turn n-1, n, n+1, and no other.
@@ -89 +89 @@
 
 bool CNetTurnManager::WillUpdate(float simFrameLength)
 {
     // Keep this in sync with the return value of Update()
 
+    if (m_FinalTurn > 0 && m_CurrentTurn > m_FinalTurn)
+        return false;
+
     if (m_DeltaSimTime + simFrameLength < 0)
         return false;
 
     if (m_ReadyTurn <= m_CurrentTurn)
         return false;
@@ -100 +103 @@
     return true;
 }
 
 bool CNetTurnManager::Update(float simFrameLength, size_t maxTurns)
 {
+
+    if (m_FinalTurn > 0 && m_CurrentTurn > m_FinalTurn)
+        return false;
+
     m_DeltaSimTime += simFrameLength;
 
     // If the game becomes laggy, m_DeltaSimTime increases progressively.
     // The engine will fast forward accordingly to catch up.
     // To keep the game playable, stop fast forwarding after 2 turn lengths.
@@ -513 +520 @@
         m_TurnLength = m_ReplayTurnLengths[0];
 }
 
 void CNetReplayTurnManager::StoreFinalReplayTurn(u32 turn)
 {
-    m_FinalReplayTurn = turn;
+    m_FinalTurn = turn;
 }
 
 void CNetReplayTurnManager::NotifyFinishedUpdate(u32 turn)
 {
-    if (turn > m_FinalReplayTurn)
+    if (turn > m_FinalTurn)
         return;
 
-    debug_printf("Executing turn %d of %d\n", turn, m_FinalReplayTurn);
+    debug_printf("Executing turn %d of %d\n", turn, m_FinalTurn);
     DoTurn(turn);
 
     // Compare hash if it exists in the replay and if we didn't have an OOS already
     if (m_HasSyncError || m_ReplayHash.find(turn) == m_ReplayHash.end())
         return;
@@ -553 +560 @@
         JS::RootedValue command(m_Simulation2.GetScriptInterface().GetContext());
         m_Simulation2.GetScriptInterface().ParseJSON(pair.second, &command);
         AddCommand(m_ClientId, pair.first, command, m_CurrentTurn + 1);
     }
 
-    if (turn == m_FinalReplayTurn)
+    if (turn == m_FinalTurn)
         g_GUI->SendEventToAll("ReplayFinished");
 }
 
 CNetServerTurnManager::CNetServerTurnManager(CNetServerWorker& server) :
     m_NetServer(server), m_ReadyTurn(1), m_TurnLength(DEFAULT_TURN_LENGTH_MP), m_HasSyncError(false)

source/network/NetTurnManager.h

@@ -188 +188 @@
 
     bool m_HasSyncError;
 
     IReplayLogger& m_Replay;
 
+    // The number of the last turn that is allowed to be executed (used for replays)
+    u32 m_FinalTurn;
+
 private:
     size_t m_TimeWarpNumTurns; // 0 if disabled
     std::list<std::string> m_TimeWarpStates;
     std::string m_QuickSaveState; // TODO: should implement a proper disk-based quicksave system
     std::string m_QuickSaveMetadata;
@@ -271 +274 @@
     // Contains the length of every turn
     std::map<u32, u32> m_ReplayTurnLengths;
 
     // Contains all replay hash values and weather or not the quick hash method was used
     std::map<u32, std::pair<std::string, bool> > m_ReplayHash;
-
-    // The number of the last turn in the replay
-    u32 m_FinalReplayTurn;
-
 };
 /**
  * The server-side counterpart to CNetClientTurnManager.
  * Records the turn state of each client, and sends turn advancement messages
  * when all clients are ready.