Ticket #2587: team_exploration.patch

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

@@ -787 +787 @@
         sumVegetarianRatio();
         sumFeminisation();
         sumKillDeathRatio();
-        // TODO: probably change from simple sum to union from range manager
-        panels.miscelanous.counters.mapExploration.teamsScores[playerState.team] += playerState.statistics.percentMapExplored;
+        panels.miscelanous.counters.mapExploration.teamsScores[playerState.team] = playerState.statistics.teamPercentMapExplored;
         panels.miscelanous.counters.mapExploration.teamsScoresCaption[playerState.team] = panels.miscelanous.counters.mapExploration.teamsScores[playerState.team] + "%";
     }
     

binaries/data/mods/public/simulation/components/AIInterface.js

@@ -40 +40 @@
     var cmpGuiInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
     
     // Return the same game state as the GUI uses
-    var state = cmpGuiInterface.GetExtendedSimulationState(-1);
+    var state = cmpGuiInterface.GetSimulationState(-1);
     
     // Add some extra AI-specific data
     // add custom events and reset them for the next turn

binaries/data/mods/public/simulation/components/GuiInterface.js

@@ -119 +119 @@
     var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
     ret.timeElapsed = cmpTimer.GetTime();
 
-    // and the game type
+    // Add the game type
     var cmpEndGameManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager);
     ret.gameType = cmpEndGameManager.GetGameType();
 
+    // Add bartering prices
+    var cmpBarter = Engine.QueryInterface(SYSTEM_ENTITY, IID_Barter);
+    ret.barterPrices = cmpBarter.GetPrices();
+
     return ret;
 };
 
+/**
+ * Returns global information about the current game state, plus statistics.
+ * This is used by the GUI at the end of a game, in the summary screen.
+ * Note: Amongst statistics, the team exploration map percentage is computed from
+ * scratch, so the extended simulation state should not be requested too often.
+ */
 GuiInterface.prototype.GetExtendedSimulationState = function(player)
 {
     // Get basic simulation info
@@ -141 +151 @@
         ret.players[i].statistics = cmpPlayerStatisticsTracker.GetStatistics();
     }
 
-    // Add bartering prices
-    var cmpBarter = Engine.QueryInterface(SYSTEM_ENTITY, IID_Barter);
-    ret.barterPrices = cmpBarter.GetPrices();
-
     return ret;
 };
 

binaries/data/mods/public/simulation/components/StatisticsTracker.js

@@ -142 +142 @@
         "tributesReceived": this.tributesReceived,
         "tradeIncome": this.tradeIncome,
         "treasuresCollected": this.treasuresCollected,
-        "percentMapExplored": this.GetPercentMapExplored()
+        "percentMapExplored": this.GetPercentMapExplored(),
+        "teamPercentMapExplored": this.GetTeamPercentMapExplored()
     };
 };
 
@@ -336 +337 @@
     return cmpRangeManager.GetPercentMapExplored(cmpPlayer.GetPlayerID());
 };
 
+/**
+ * Note: cmpRangeManager.GetUnionPercentMapExplored computes statistics from scratch!
+ * As a consequence, this function should not be called too often.
+ */
+StatisticsTracker.prototype.GetTeamPercentMapExplored = function()
+{
+    var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
+
+    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpPlayer = Engine.QueryInterface(this.entity, IID_Player);
+
+    if (!cmpPlayer)
+        return 0;
+
+    var team = cmpPlayer.GetTeam();
+    // If teams are not locked, this statistic won't be displayed, so don't bother computing
+    if (team == -1 || !cmpPlayer.GetLockTeams())
+        return cmpRangeManager.GetPercentMapExplored(cmpPlayer.GetPlayerID());
+
+    var teamPlayers = [];
+    for (var i = 1; i < cmpPlayerManager.GetNumPlayers(); ++i)
+    {
+        let cmpOtherPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(i), IID_Player);
+        if (cmpOtherPlayer && cmpOtherPlayer.GetTeam() == team)
+            teamPlayers.push(i);
+    }
+
+    return cmpRangeManager.GetUnionPercentMapExplored(teamPlayers);
+};
+
 Engine.RegisterComponentType(IID_StatisticsTracker, "StatisticsTracker", StatisticsTracker);

binaries/data/mods/public/simulation/components/tests/test_GuiInterface.js

@@ -117 +117 @@
             },
             "treasuresCollected": 0,
             "percentMapExplored": 10,
+            "teamPercentMapExplored": 10
         };
     },
     IncreaseTrainedUnitsCounter: function() { return 1; },
@@ -180 +181 @@
             },
             "treasuresCollected": 0,
             "percentMapExplored": 10,
+            "teamPercentMapExplored": 10
         };
     },
     IncreaseTrainedUnitsCounter: function() { return 1; },
@@ -254 +256 @@
     circularMap: false,
     timeElapsed: 0,
     gameType: "conquest",
+    barterPrices: {buy: {food: 150}, sell: {food: 25}}
 });
 
 TS_ASSERT_UNEVAL_EQUALS(cmp.GetExtendedSimulationState(), {
@@ -301 +304 @@
                 },
                 treasuresCollected: 0,
                 percentMapExplored: 10,
+                teamPercentMapExplored: 10
             },
         },
         {
@@ -346 +350 @@
                 },
                 treasuresCollected: 0,
                 percentMapExplored: 10,
+                teamPercentMapExplored: 10
             },
         }
     ],

source/simulation2/components/CCmpRangeManager.cpp

@@ -656 +656 @@
             {
                 for (i32 i = 0; i < m_TerrainVerticesPerSide; i++)
                 {
-                    if (!LosIsOffWorld(i, j))
-                    {
-                        for (u8 k = 1; k < MAX_LOS_PLAYER_ID+1; ++k)
-                            m_ExploredVertices.at(k) += ((m_LosState[j*m_TerrainVerticesPerSide + i] & (LOS_EXPLORED << (2*(k-1)))) > 0);
-                    }
+                    if (LosIsOffWorld(i, j))
+                        continue;
+
+                    for (u8 k = 1; k < MAX_LOS_PLAYER_ID+1; ++k)
+                        m_ExploredVertices.at(k) += ((m_LosState[j*m_TerrainVerticesPerSide + i] & (LOS_EXPLORED << (2*(k-1)))) > 0);
                 }
             }
         }
@@ -2048 +2048 @@
     {
         return m_ExploredVertices.at((u8)player) * 100 / m_TotalInworldVertices;
     }
+
+    virtual u8 GetUnionPercentMapExplored(std::vector<player_id_t> players)
+    {
+        u32 exploredVertices = 0;
+        std::vector<player_id_t>::iterator playerIt;
+
+        for (i32 j = 0; j < m_TerrainVerticesPerSide; j++)
+        {
+            for (i32 i = 0; i < m_TerrainVerticesPerSide; i++)
+            {
+                if (LosIsOffWorld(i, j))
+                    continue;
+
+                for (playerIt = players.begin(); playerIt != players.end(); ++playerIt)
+                {
+                    if ((m_LosState[j*m_TerrainVerticesPerSide + i] & (LOS_EXPLORED << (2*((*playerIt)-1)))) == 0)
+                        continue;
+
+                    exploredVertices += 1;
+                    break;
+                }
+            }
+        }
+
+        return exploredVertices * 100 / m_TotalInworldVertices;
+    }
 };
 
 REGISTER_COMPONENT_TYPE(RangeManager)

source/simulation2/components/ICmpRangeManager.cpp

@@ -56 +56 @@
 DEFINE_INTERFACE_METHOD_0("GetLosCircular", bool, ICmpRangeManager, GetLosCircular)
 DEFINE_INTERFACE_METHOD_2("SetSharedLos", void, ICmpRangeManager, SetSharedLos, player_id_t, std::vector<player_id_t>)
 DEFINE_INTERFACE_METHOD_1("GetPercentMapExplored", u8, ICmpRangeManager, GetPercentMapExplored, player_id_t)
+DEFINE_INTERFACE_METHOD_1("GetUnionPercentMapExplored", u8, ICmpRangeManager, GetUnionPercentMapExplored, std::vector<player_id_t>)
 END_INTERFACE_WRAPPER(RangeManager)

source/simulation2/components/ICmpRangeManager.h

@@ -380 +380 @@
      */
     virtual u8 GetPercentMapExplored(player_id_t player) = 0;
 
+    /**
+     * Get percent map explored statistics for specified set of players.
+     * Note: this function computes statistics from scratch and should not be called too often.
+     */
+    virtual u8 GetUnionPercentMapExplored(std::vector<player_id_t> players) = 0;
 
+
     /**
      * Perform some internal consistency checks for testing/debugging.
      */