Ticket #3016: api_fix.patch

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

@@ -128 +128 @@
     var cmpBarter = Engine.QueryInterface(SYSTEM_ENTITY, IID_Barter);
     ret.barterPrices = cmpBarter.GetPrices();
 
+    // Add basic statistics to each player
+    var cmpPlayerMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var n = cmpPlayerMan.GetNumPlayers();
+    for (var i = 0; i < n; ++i)
+    {
+        var playerEnt = cmpPlayerMan.GetPlayerByID(i);
+        var cmpPlayerStatisticsTracker = Engine.QueryInterface(playerEnt, IID_StatisticsTracker);
+        if (cmpPlayerStatisticsTracker)
+            ret.players[i].statistics = cmpPlayerStatisticsTracker.GetBasicStatistics();
+    }
+
     return ret;
 };
 

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

@@ -121 +121 @@
     this.treasuresCollected = 0;
 };
 
+/**
+ * Returns a subset of statistics that will be added to the simulation state,
+ * thus called each turn. Basic statistics should not contain data that would 
+ * be expensive to compute.
+ *
+ * Note: as of now, nothing in the game needs that, but some AIs developed by
+ * modders need it in the API.
+ */
+StatisticsTracker.prototype.GetBasicStatistics = function()
+{
+    return {
+        "resourcesGathered": this.resourcesGathered,
+        "percentMapExplored": this.GetPercentMapExplored()
+    };
+};
+
 StatisticsTracker.prototype.GetStatistics = function()
 {
     return {

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

@@ -101 +101 @@
 });
 
 AddMock(100, IID_StatisticsTracker, {
+    GetBasicStatistics: function() { 
+        return {
+            "resourcesGathered": {
+                "food": 100,    
+                "wood": 0,  
+                "metal": 0, 
+                "stone": 0,
+                "vegetarianFood": 0, 
+            },
+            "percentMapExplored": 10
+        };
+    },
     GetStatistics: function() { 
         return {
             "unitsTrained": 10,
@@ -165 +177 @@
 });
 
 AddMock(101, IID_StatisticsTracker, {
+    GetBasicStatistics: function() { 
+        return {
+            "resourcesGathered": {
+                "food": 100,    
+                "wood": 0,  
+                "metal": 0, 
+                "stone": 0,
+                "vegetarianFood": 0, 
+            },
+            "percentMapExplored": 10
+        };
+    },
     GetStatistics: function() { 
         return {
             "unitsTrained": 10,
@@ -222 +246 @@
             researchedTechs: {},
             classCounts: {},
             typeCountsByClass: {},
+            statistics: {
+                resourcesGathered: {
+                    food: 100,
+                    wood: 0,
+                    metal: 0,
+                    stone: 0,
+                    vegetarianFood: 0, 
+                },
+                percentMapExplored: 10
+            },
         },
         {
             name: "Player 2",
@@ -251 +285 @@
             researchedTechs: {},
             classCounts: {},
             typeCountsByClass: {},
+            statistics: {
+                resourcesGathered: {
+                    food: 100,
+                    wood: 0,
+                    metal: 0,
+                    stone: 0,
+                    vegetarianFood: 0, 
+                },
+                percentMapExplored: 10
+            },
         }
     ],
     circularMap: false,