Ticket #3991: t3991_const_simcontext_v1.patch

source/gui/scripting/ScriptFunctions.cpp

@@ -235 +235 @@
         g_Game->SetPlayerID(id);
 }
 
 void SetViewedPlayer(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), int id)
 {
-    if (!g_Game)
-        return;
-
-    g_Game->GetSimulation2()->GetSimContext().SetCurrentDisplayedPlayer(id);
+    if (g_Game)
+        g_Game->SetViewedPlayerID(id);
 }
 
 JS::Value GetEngineInfo(ScriptInterface::CxPrivate* pCxPrivate)
 {
     return SavedGames::GetEngineInfo(*(pCxPrivate->pScriptInterface));

source/ps/Game.cpp

@@ -343 +343 @@
 }
 
 void CGame::SetPlayerID(player_id_t playerID)
 {
     m_PlayerID = playerID;
+    m_ViewedPlayerID = playerID;
+
     if (m_TurnManager)
         m_TurnManager->SetPlayerID(m_PlayerID);
+}
+
+int CGame::GetViewedPlayerID()
+{
+    return m_ViewedPlayerID;
+}
 
-    m_Simulation2->SetCurrentDisplayedPlayer(g_Game->GetPlayerID());
+void CGame::SetViewedPlayerID(player_id_t playerID)
+{
+    m_ViewedPlayerID = playerID;
 }
 
 void CGame::StartGame(JS::MutableHandleValue attribs, const std::string& savedState)
 {
     if (m_ReplayLogger)

source/ps/Game.h

@@ -38 +38 @@
  * maintaining the relations between CPlayer and CWorld, CSimulation and CWorld.
  **/
 class CGame
 {
     NONCOPYABLE(CGame);
+
     /**
      * pointer to the CWorld object representing the game world.
      **/
     CWorld *m_World;
+
     /**
      * pointer to the CSimulation2 object operating on the game world.
      **/
     CSimulation2 *m_Simulation2;
+
     /**
      * pointer to the CGameView object representing the view into the game world.
      **/
     CGameView *m_GameView;
+
     /**
      * the game has been initialized and ready for use if true.
      **/
     bool m_GameStarted;
     /**
      * Timescale multiplier for simulation rate.
      **/
     float m_SimRate;
 
+    /**
+     * Index assigned to the current player.
+     * 1-8 to control players, 0 for gaia, -1 for observer.
+     */
     player_id_t m_PlayerID;
 
+    /**
+     * Differs from m_PlayerID if a defeated player or observer views another player.
+     */
+    player_id_t m_ViewedPlayerID;
+
     CNetTurnManager* m_TurnManager;
 
 public:
     CGame(bool disableGraphics = false, bool replayLog = true);
     ~CGame();
@@ -93 +106 @@
     void Interpolate(float simFrameLength, float realFrameLength);
 
     int GetPlayerID();
     void SetPlayerID(player_id_t playerID);
 
+    int GetViewedPlayerID();
+    void SetViewedPlayerID(player_id_t playerID);
+
     /**
      * Retrieving player colors from scripts is slow, so this updates an
      * internal cache of all players' colors.
      * Call this just before rendering, so it will always have the latest
      * colors.

source/simulation2/Simulation2.cpp

@@ -605 +605 @@
 void CSimulation2::EnableSerializationTest()
 {
     m->m_EnableSerializationTest = true;
 }
 
-void CSimulation2::SetCurrentDisplayedPlayer(int playerID)
-{
-    m->m_SimContext.SetCurrentDisplayedPlayer(playerID);
-}
-
 entity_id_t CSimulation2::AddEntity(const std::wstring& templateName)
 {
     return m->m_ComponentManager.AddEntity(templateName, m->m_ComponentManager.AllocateNewEntity());
 }
 
@@ -660 +655 @@
 const CSimulation2::InterfaceListUnordered& CSimulation2::GetEntitiesWithInterfaceUnordered(int iid)
 {
     return m->m_ComponentManager.GetEntitiesWithInterfaceUnordered(iid);
 }
 
-CSimContext& CSimulation2::GetSimContext() const
+const CSimContext& CSimulation2::GetSimContext() const
 {
     return m->m_SimContext;
 }
 
 ScriptInterface& CSimulation2::GetScriptInterface() const

source/simulation2/Simulation2.h

@@ -55 +55 @@
     ~CSimulation2();
 
     void EnableOOSLog();
     void EnableSerializationTest();
 
-    void SetCurrentDisplayedPlayer(int playerID);
-
     /**
      * Load all scripts in the specified directory (non-recursively),
      * so they can register new component types and functions. This
      * should be called immediately after constructing the CSimulation2 object.
      * @return false on failure
@@ -217 +215 @@
      * Returns a list of components implementing the given interface, and their
      * associated entities, as an unordered map.
      */
     const InterfaceListUnordered& GetEntitiesWithInterfaceUnordered(int iid);
 
-    CSimContext& GetSimContext() const;
+    const CSimContext& GetSimContext() const;
     ScriptInterface& GetScriptInterface() const;
 
     bool ComputeStateHash(std::string& outHash, bool quick);
     bool DumpDebugState(std::ostream& stream);
     bool SerializeState(std::ostream& stream);

source/simulation2/system/SimContext.cpp

@@ -22 +22 @@
 #include "ComponentManager.h"
 
 #include "ps/Game.h"
 
 CSimContext::CSimContext() :
-    m_ComponentManager(NULL), m_UnitManager(NULL), m_Terrain(NULL), m_CurrentDisplayedPlayer(0)
+    m_ComponentManager(NULL), m_UnitManager(NULL), m_Terrain(NULL)
 {
 }
 
 CSimContext::~CSimContext()
 {
@@ -65 +65 @@
     return GetComponentManager().GetScriptInterface();
 }
 
 int CSimContext::GetCurrentDisplayedPlayer() const
 {
-    return g_Game ? m_CurrentDisplayedPlayer : -1;
-}
-
-void CSimContext::SetCurrentDisplayedPlayer(int player)
-{
-    m_CurrentDisplayedPlayer = player;
+    return g_Game ? g_Game->GetViewedPlayerID() : -1;
 }

source/simulation2/system/SimContext.h

@@ -51 +51 @@
     /**
      * Returns the player ID that the current display is being rendered for.
      * Currently relies on g_Game being initialised (evil globals...)
      */
     int GetCurrentDisplayedPlayer() const;
-    void SetCurrentDisplayedPlayer(int player);
 
 private:
     CComponentManager* m_ComponentManager;
     CUnitManager* m_UnitManager;
     CTerrain* m_Terrain;
 
     CEntityHandle m_SystemEntity;
 
-    int m_CurrentDisplayedPlayer;
-
     friend class CSimulation2Impl;
 };
 
 #endif // INCLUDED_SIMCONTEXT