Ticket #643: gatherer-count.patch

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

@@ -23 +23 @@
 // Whether the player has lost/won and reached the end of their game
 var g_GameEnded = false;
 
+// The current ID of the timer that updates gatherer counters.
+var g_GathererPruneTimerID = undefined;
+
 // Colors to flash when pop limit reached
 const DEFAULT_POPULATION_COLOR = "white";
 const POPULATION_ALERT_COLOR = "orange";
@@ -406 +409 @@
     if (!playerState)
         return;
 
-    getGUIObjectByName("resourceFood").caption = playerState.resourceCounts.food;
-    getGUIObjectByName("resourceWood").caption = playerState.resourceCounts.wood;
-    getGUIObjectByName("resourceStone").caption = playerState.resourceCounts.stone;
-    getGUIObjectByName("resourceMetal").caption = playerState.resourceCounts.metal;
+    // Remove dead or non-gathering workers from the gatherer arrays once per second.
+    if (!g_GathererPruneTimerID)
+    {
+        g_GathererPruneTimerID = setTimeout(
+                function() { Engine.GuiInterfaceCall("PruneResourceGatherers", Engine.GetPlayerID());
+                g_GathererPruneTimerID = undefined; }, 1000
+        );
+    }
+
+    getGUIObjectByName("resourceFood").caption = playerState.resourceCounts.food +
+            " (" + playerState.resourceGatherers.food.length + ")";
+    getGUIObjectByName("resourceWood").caption = playerState.resourceCounts.wood +
+            " (" + playerState.resourceGatherers.wood.length + ")";
+    getGUIObjectByName("resourceStone").caption = playerState.resourceCounts.stone +
+            " (" + playerState.resourceGatherers.stone.length + ")";
+    getGUIObjectByName("resourceMetal").caption = playerState.resourceCounts.metal +
+            " (" + playerState.resourceGatherers.metal.length + ")";
     getGUIObjectByName("resourcePop").caption = playerState.popCount + "/" + playerState.popLimit;
 
     g_IsTrainingBlocked = playerState.trainingBlocked;

binaries/data/mods/public/gui/session/session.xml

@@ -310 +310 @@
             <!-- Player resource bar -->
             <!-- ================================  ================================ -->
             <object
-                size="10 0 45% 100%"
+                size="5 0 45%+5 100%"
             >
                 <!-- Food -->
-                <object size="0 0 90 100%" type="image" style="resourceCounter" tooltip="Food" tooltip_style="sessionToolTipBold">
+                <object size="0 0 100 100%" type="image" style="resourceCounter" tooltip="Food (Gatherers)" tooltip_style="sessionToolTipBold">
                     <object size="0 -4 40 36" type="image" sprite="stretched:session/icons/resources/food.png"/>
                     <object size="32 0 100% 100%-2" type="text" style="resourceText" name="resourceFood"/>
                 </object>
 
                 <!-- Wood -->
-                <object size="90 0 180 100%" type="image" style="resourceCounter" tooltip="Wood" tooltip_style="sessionToolTipBold">
+                <object size="90 0 190 100%" type="image" style="resourceCounter" tooltip="Wood (Gatherers)" tooltip_style="sessionToolTipBold">
                     <object size="0 -4 40 36" type="image" sprite="stretched:session/icons/resources/wood.png"/>
                     <object size="32 0 100% 100%-2" type="text" style="resourceText" name="resourceWood"/>
                 </object>
 
                 <!-- Stone -->
-                <object size="180 0 270 100%" type="image" style="resourceCounter" tooltip="Stone" tooltip_style="sessionToolTipBold">
+                <object size="180 0 280 100%" type="image" style="resourceCounter" tooltip="Stone (Gatherers)" tooltip_style="sessionToolTipBold">
                     <object size="0 -4 40 36" type="image" sprite="stretched:session/icons/resources/stone.png"/>
                     <object size="32 0 100% 100%-2" type="text" style="resourceText" name="resourceStone"/>
                 </object>
 
                 <!-- Metal -->
-                <object size="270 0 360 100%"  type="image" style="resourceCounter" tooltip="Metal" tooltip_style="sessionToolTipBold">
+                <object size="270 0 370 100%" type="image" style="resourceCounter" tooltip="Metal (Gatherers)" tooltip_style="sessionToolTipBold">
                     <object size="0 -4 40 36" type="image" sprite="stretched:session/icons/resources/metal.png"/>
                     <object size="32 0 100% 100%-2" type="text" style="resourceText" name="resourceMetal"/>
                 </object>
 
                 <!-- Population -->
-                <object size="360 0 450 100%" type="image" style="resourceCounter" tooltip="Population (current / limit)" tooltip_style="sessionToolTipBold">
+                <object size="365 0 450 100%" type="image" style="resourceCounter" tooltip="Population (current / limit)" tooltip_style="sessionToolTipBold">
                     <object size="0 -4 40 34" type="image" sprite="stretched:session/icons/resources/population.png"/>
                     <object size="32 0 100% 100%-2" type="text" style="resourceText" name="resourcePop"/>
                 </object>

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

@@ -78 +78 @@
             "popLimit": cmpPlayer.GetPopulationLimit(),
             "popMax": cmpPlayer.GetMaxPopulation(),
             "resourceCounts": cmpPlayer.GetResourceCounts(),
+            "resourceGatherers": cmpPlayer.GetResourceGatherers(),
             "trainingBlocked": cmpPlayer.IsTrainingBlocked(),
             "state": cmpPlayer.GetState(),
             "team": cmpPlayer.GetTeam(),
@@ -1452 +1453 @@
     return 0;
 };
 
+GuiInterface.prototype.PruneResourceGatherers = function(player)
+{
+    var cmpPlayerMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpPlayer = Engine.QueryInterface(cmpPlayerMan.GetPlayerByID(player), IID_Player);
+    cmpPlayer.PruneResourceGatherers();
+};
+
 GuiInterface.prototype.GetTradingDetails = function(player, data)
 {
     var cmpEntityTrader = Engine.QueryInterface(data.trader, IID_Trader);
@@ -1572 +1580 @@
     "GetFoundationSnapData": 1,
     "PlaySound": 1,
     "FindIdleUnit": 1,
+    "PruneResourceGatherers": 1,
     "GetTradingDetails": 1,
     "CanAttack": 1,
 

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

@@ -19 +19 @@
         "metal": 300,   
         "stone": 300    
     };
+    this.resourceGatherers = {
+        "food": [],
+        "wood": [],
+        "metal": [],
+        "stone": []
+    };
 
     this.team = -1; // team number of the player, players on the same team will always have ally diplomatic status - also this is useful for team emblems, scoring, etc.
     this.state = "active"; // game state - one of "active", "defeated", "won"
@@ -137 +143 @@
     return this.resourceCount;
 };
 
+Player.prototype.PruneResourceGatherers = function()
+{
+    for (var resource in this.resourceGatherers)
+    {
+        for (var i = 0; i < this.resourceGatherers[resource].length; i++)
+        {
+            var gatherer = this.resourceGatherers[resource][i];
+            var cmpTempMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+            var entState = cmpTempMan.GetCurrentTemplateName(gatherer);
+
+            // Prune entities if they no longer exist.
+            if (!entState)
+            {
+                delete this.resourceGatherers[resource][i];
+                continue;
+            }
+
+            var cmpResourceGatherer = Engine.QueryInterface(gatherer, IID_ResourceGatherer);
+            var cmpUnitAI = Engine.QueryInterface(gatherer, IID_UnitAI);
+            var gatheredResource = undefined;
+            for (var j = 0; j < cmpUnitAI.orderQueue.length; j++ )
+            {
+                var order = cmpUnitAI.orderQueue[j];
+                if (order.type == "Gather" && !order.data.force)
+                    var gatheredResource = order.data.type.generic;
+            }
+
+            // Prune entities if they're no longer gathering or gathering a different resource.
+            if (!cmpResourceGatherer || !gatheredResource || gatheredResource != resource)
+            {
+                cmpResourceGatherer.lastGathered = undefined;
+                delete this.resourceGatherers[resource][i];
+            }
+        }
+
+        // Remove undefined elements.
+        this.resourceGatherers[resource] = this.resourceGatherers[resource].filter(Number);
+    }
+};
+
+Player.prototype.GetResourceGatherers = function()
+{
+    // Define if necessary, for older saves.
+    if (typeof this.resourceGatherers === "undefined")
+    {
+        this.resourceGatherers = {
+            "food": [],
+            "wood": [],
+            "metal": [],
+            "stone": []
+        };
+    }
+    return this.resourceGatherers;
+};
+
+Player.prototype.AddResourceGatherer = function(gatherer, type)
+{
+    // We want to add units that are gathering a new resource.
+    var cmpResourceGatherer = Engine.QueryInterface(gatherer, IID_ResourceGatherer);
+    if (cmpResourceGatherer)
+    {
+        var lastGathered = cmpResourceGatherer.GetLastGathered();
+        if (!lastGathered || lastGathered != type.generic)
+        {
+            cmpResourceGatherer.lastGathered = type;
+            this.resourceGatherers[type.generic].push(gatherer);
+        }
+    }
+};
+
 /**
  * Add resource of specified type to player
  * @param type Generic type of resource (string)

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

@@ -65 +65 @@
 
     // The last exact type gathered, so we can render appropriate props
     this.lastCarriedType = undefined; // { generic, specific }
+    this.lastGathered = undefined;
 };
 
 /**
@@ -125 +126 @@
         return undefined;
 };
 
+ResourceGatherer.prototype.GetLastGathered = function()
+{
+    if ( this.lastGathered )
+        return this.lastGathered.generic;
+    else
+        return undefined;
+}
+
 ResourceGatherer.prototype.GetGatherRates = function()
 {
     var ret = {};

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

@@ -1022 +1022 @@
                         return;
                     }
 
+                    // Attempt to put the gatherer into the player's gatherer array.
+                    var cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
+                    if (cmpOwnership)
+                    {
+                        var owner = cmpOwnership.GetOwner();
+                        var cmpPlayerMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+                        var cmpPlayer = Engine.QueryInterface(cmpPlayerMan.GetPlayerByID(owner), IID_Player);
+                        if (cmpPlayer)
+                            cmpPlayer.AddResourceGatherer(this.entity, this.order.data.type);
+                    }
+
                     // Scale timing interval based on rate, and start timer
                     // The offset should be at least as long as the repeat time so we use the same value for both.
                     var offset = 1000/rate;