Ticket #643: gatherer-count-11052012.patch

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

@@ -443 +443 @@
     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;
+    getGUIObjectByName("resourceFood").caption = playerState.resourceCounts.food +
+            " (" + playerState.resourceGatherers.count.food + ")";
+    getGUIObjectByName("resourceWood").caption = playerState.resourceCounts.wood +
+            " (" + playerState.resourceGatherers.count.wood + ")";
+    getGUIObjectByName("resourceStone").caption = playerState.resourceCounts.stone +
+            " (" + playerState.resourceGatherers.count.stone + ")";
+    getGUIObjectByName("resourceMetal").caption = playerState.resourceCounts.metal +
+            " (" + playerState.resourceGatherers.count.metal + ")";
     getGUIObjectByName("resourcePop").caption = playerState.popCount + "/" + playerState.popLimit;
 
     g_IsTrainingBlocked = playerState.trainingBlocked;

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

@@ -422 +422 @@
         <!-- 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 20% 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" ghost="true"/>
             <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="20% 0 40% 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" ghost="true"/>
             <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="40% 0 60% 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" ghost="true"/>
             <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="60% 0 80% 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" ghost="true"/>
             <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="80% 0 100% 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" ghost="true"/>
             <object size="32 0 100% 100%-2" type="text" style="resourceText" name="resourcePop"/>
         </object>

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

@@ -85 +85 @@
             "popLimit": cmpPlayer.GetPopulationLimit(),
             "popMax": cmpPlayer.GetMaxPopulation(),
             "resourceCounts": cmpPlayer.GetResourceCounts(),
+            "resourceGatherers": cmpPlayer.GetResourceGatherers(),
             "trainingBlocked": cmpPlayer.IsTrainingBlocked(),
             "state": cmpPlayer.GetState(),
             "team": cmpPlayer.GetTeam(),

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

@@ -19 +19 @@
         "metal": 300,   
         "stone": 300    
     };
+    this.resourceGatherers = {
+        "food": {},
+        "wood": {},
+        "metal": {},
+        "stone": {},
+        "count": {
+            "food": 0,
+            "wood": 0,
+            "metal": 0,
+            "stone": 0
+        }
+    };
 
     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.teamsLocked = false;
@@ -144 +156 @@
     return this.resourceCount;
 };
 
+Player.prototype.RemoveResourceGatherer = function(gatherer, force)
+{
+    var cmpResourceGatherer = Engine.QueryInterface(gatherer, IID_ResourceGatherer);
+    if (!cmpResourceGatherer)
+        return false;
+
+    var resource = cmpResourceGatherer.GetLastGathered();
+    if (!resource)
+        return false;
+
+    var cmpUnitAI = Engine.QueryInterface(gatherer, IID_UnitAI);
+    var orders = cmpUnitAI.GetOrders();
+
+    var gatheredResource = undefined;
+    for (var j = 0; j < orders.length; ++j)
+    {
+        var order = orders[j];
+        if (order.type == "Gather" && !order.data.force)
+            gatheredResource = order.data.type.generic;
+    }
+
+    // Prune entities if they're no longer gathering or gathering a different resource.
+    if (!gatheredResource || gatheredResource != resource.generic || force)
+    {
+        cmpResourceGatherer.SetLastGathered(undefined);
+        var resourceType = (resource.generic == "treasure") ? resource.specific : resource.generic;
+        delete this.resourceGatherers[resourceType][gatherer];
+        this.resourceGatherers.count[resourceType]--;
+        return true;
+    }
+
+    return false;
+};
+
+Player.prototype.GetResourceGatherers = function()
+{
+    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.generic != type.generic)
+        {
+            cmpResourceGatherer.SetLastGathered(type);
+            var resourceType = (type.generic == "treasure") ? type.specific : type.generic;
+            this.resourceGatherers[resourceType][gatherer] = true;
+            this.resourceGatherers.count[resourceType]++;
+            return true;
+        }
+    }
+    return false;
+};
+
 /**
  * Add resource of specified type to player
  * @param type Generic type of resource (string)

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

@@ -74 +74 @@
     {
         var carriedResorces = cmpCurrentUnitResourceGatherer.GetCarryingStatus();
         cmpPromotedUnitResourceGatherer.GiveResources(carriedResorces);
+        cmpPromotedUnitResourceGatherer.SetLastCarriedType( cmpCurrentUnitResourceGatherer.GetLastCarriedType() );
     }
     
     var cmpCurrentUnitAI = Engine.QueryInterface(this.entity, IID_UnitAI);
@@ -85 +86 @@
     var orders = cmpCurrentUnitAI.GetOrders();
     cmpPromotedUnitAI.AddOrders(orders);
 
+    // Add the promoted entity to the gatherer counter if necessary. The
+    // old entity will be removed from the counter upon its destruction.
+    if (cmpCurrentUnitAI.IsGatherer() && cmpCurrentUnitResourceGatherer && cmpPromotedUnitResourceGatherer)
+    {
+        var cmpPlayer = cmpPromotedUnitAI.GetOwner(promotedUnitEntity);
+        if (cmpPlayer)
+            cmpPromotedUnitAI.SetGathering( cmpPlayer.AddResourceGatherer(promotedUnitEntity,
+                    cmpCurrentUnitResourceGatherer.GetLastGathered()) );
+    }
+
     Engine.BroadcastMessage(MT_EntityRenamed, { entity: this.entity, newentity: promotedUnitEntity });
 
     // Destroy current entity

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;
 };
 
 /**
@@ -87 +88 @@
 
 /**
  * Used to instantly give resources to unit
- * @param resources The same structure as returned form GetCarryingStatus
+ * @param resources The same structure as returned from GetCarryingStatus
  */
 ResourceGatherer.prototype.GiveResources = function(resources)
 {
@@ -125 +126 @@
         return undefined;
 };
 
+ResourceGatherer.prototype.SetLastCarriedType = function(type)
+{
+    this.lastCarriedType = type;
+};
+
+/**
+ * Gets the type of the last resource that was gathered. Unlike
+ * lastCarriedType, this is updated as soon as a unit initiates
+ * gathering, not when it completes its first full action.
+ */
+ResourceGatherer.prototype.GetLastGathered = function()
+{
+    if (this.lastGathered)
+        return this.lastGathered;
+    else
+        return undefined;
+}
+
+ResourceGatherer.prototype.SetLastGathered = function(type)
+{
+    this.lastGathered = type;
+}
+
 ResourceGatherer.prototype.GetGatherRates = function()
 {
     var ret = {};

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

@@ -1143 +1143 @@
                     {
                         var typename = "gather_" + this.order.data.type.specific;
                         this.SelectAnimation(typename, false, 1.0, typename);
+
+                        var cmpPlayer = this.GetOwnerPlayer(this.entity);
+                        if (cmpPlayer && cmpPlayer.AddResourceGatherer(this.entity, this.order.data.type))
+                            this.isGatherer = true;
                     }
                     return false;
                 },
 
                 "leave": function() {
+                    var cmpPlayer = this.GetOwnerPlayer(this.entity);
+                    if (cmpPlayer && cmpPlayer.RemoveResourceGatherer(this.entity, false))
+                        this.isGatherer = false;
+
                     this.StopTimer();
                 },
 
@@ -1848 +1856 @@
     this.formationController = INVALID_ENTITY; // entity with IID_Formation that we belong to
     this.isGarrisoned = false;
     this.isIdle = false;
+    this.isGatherer = false;
     this.lastFormationName = "";
 
     // For preventing increased action rate due to Stop orders or target death.
@@ -1891 +1900 @@
     return this.isIdle;
 };
 
+UnitAI.prototype.SetGathering = function(gathering)
+{
+    this.isGatherer = gathering;
+};
+
+UnitAI.prototype.IsGatherer = function()
+{
+    return this.isGatherer;
+};
+
 UnitAI.prototype.IsGarrisoned = function()
 {
     return this.isGarrisoned;
@@ -1943 +1962 @@
         this.SetStance(this.template.DefaultStance);
         this.Stop(false);
     }
+    
+    // Ensure the entity is no longer counted as gathering.
+    if (msg.from != -1 && this.isGatherer && !this.IsFormationController())
+    {
+        var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+        var cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(msg.from), IID_Player);
+        if (cmpPlayer)
+            cmpPlayer.RemoveResourceGatherer(this.entity, true);
+    }
 };
 
 UnitAI.prototype.OnDestroy = function()
@@ -2109 +2137 @@
     Engine.PostMessage(this.entity, MT_UnitAIStateChanged, { "to": state });
 };
 
+UnitAI.prototype.GetOwnerPlayer = function(entity)
+{
+    var cmpOwnership = Engine.QueryInterface(entity, IID_Ownership);
+    if (!cmpOwnership)
+        return undefined;
+
+    var owner = cmpOwnership.GetOwner();
+    if (owner == -1)
+        return undefined;
+
+    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(owner), IID_Player);
+    if (!cmpPlayer)
+        return undefined;
+
+    return cmpPlayer;
+};
+
 /**
  * Call when the current order has been completed (or failed).
  * Removes the current order from the queue, and processes the
@@ -2229 +2275 @@
     {
         this.orderQueue = [];
         this.PushOrder(type, data);
+
+        if (this.isGatherer)
+        {
+            var cmpPlayer = this.GetOwnerPlayer(this.entity);
+            if (cmpPlayer && cmpPlayer.RemoveResourceGatherer(this.entity, true))
+                this.isGatherer = false;
+        }
     }
 };