Ticket #1387: GathererLimits.patch

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

@@ -29 +29 @@
             "<value>treasure.metal</value>" +
             "<value>treasure.food</value>" +
         "</choice>" +
+    "</element>" +
+    "<element name='MaxGatherers' a:help='Amount of gatherers who can gather resources from this entity at the same time'>" +
+        "<data type='nonNegativeInteger'/>" +
     "</element>";
 
 ResourceSupply.prototype.Init = function()
 {
     // Current resource amount (non-negative)
     this.amount = this.GetMaxAmount();
+    this.gatherers = [];    // list of IDs
 };
 
 ResourceSupply.prototype.GetKillBeforeGather = function()
@@ -52 +56 @@
     return this.amount;
 };
 
+ResourceSupply.prototype.GetMaxGatherers = function()
+{
+    return +this.template.MaxGatherers;
+};
+ResourceSupply.prototype.GetGatherers = function()
+{
+    return this.gatherers;
+};
+
 ResourceSupply.prototype.TakeResources = function(rate)
 {
     // 'rate' should be a non-negative integer
@@ -77 +90 @@
     return { "generic": type, "specific": subtype };
 };
 
+ResourceSupply.prototype.IsAvailable = function(gathererID)
+{
+    if (this.gatherers.length < this.GetMaxGatherers() || this.gatherers.indexOf(gathererID) !== -1)
+        return true;
+    return false;
+};
+
+ResourceSupply.prototype.AddGatherer = function(gathererID)
+{
+    if (!this.IsAvailable(gathererID))
+        return false;
+    
+    if (this.gatherers.indexOf(gathererID) === -1)
+        this.gatherers.push(gathererID);
+
+    // broadcast message, mainly useful for the AIs.
+    Engine.PostMessage(this.entity, MT_ResourceSupplyGatherersChanged, { "to": this.gatherers });
+
+    return true;
+};
+
+// should this return false if the gatherer didn't gather from said resource?
+ResourceSupply.prototype.RemoveGatherer = function(gathererID)
+{
+    if (this.gatherers.indexOf(gathererID) !== -1)
+        this.gatherers.splice(this.gatherers.indexOf(gathererID),1);
+    
+    // broadcast message, mainly useful for the AIs.
+    Engine.PostMessage(this.entity, MT_ResourceSupplyGatherersChanged, { "to": this.gatherers });
+};
+
 Engine.RegisterComponentType(IID_ResourceSupply, "ResourceSupply", ResourceSupply);

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

@@ -261 +261 @@
             "max": cmpResourceSupply.GetMaxAmount(),
             "amount": cmpResourceSupply.GetCurrentAmount(),
             "type": cmpResourceSupply.GetType(),
-            "killBeforeGather": cmpResourceSupply.GetKillBeforeGather()
+            "killBeforeGather": cmpResourceSupply.GetKillBeforeGather(),
+            "maxGatherers": cmpResourceSupply.GetMaxGatherers(),
+            "gatherers": cmpResourceSupply.GetGatherers()
         };
     }
 

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

@@ -141 +141 @@
     this.changes.resourceSupplyAmount = msg.to;
 };
 
+AIProxy.prototype.ResourceSupplyGatherersChanged = function(msg)
+{
+    this.NotifyChange();
+    this.changes.resourceSupplyGatherers = msg.to;
+};
+
 AIProxy.prototype.OnResourceCarryingChanged = function(msg)
 {
     this.NotifyChange();
@@ -225 +231 @@
     {
         // Updated by OnResourceSupplyChanged
         ret.resourceSupplyAmount = cmpResourceSupply.GetCurrentAmount();
+        ret.resourceSupplyGatherers = cmpResourceSupply.GetGatherers();
     }
 
     var cmpResourceGatherer = Engine.QueryInterface(this.entity, IID_ResourceGatherer);

binaries/data/mods/public/simulation/components/interfaces/ResourceSupply.js

@@ -3 +3 @@
 // Message of the form { "from": 100, "to", 90 },
 // sent whenever supply level changes.
 Engine.RegisterMessageType("ResourceSupplyChanged");
+
+// Message of the form { "to", [array of gatherers ID] },
+// sent whenever the number of gatherer changes
+Engine.RegisterMessageType("ResourceSupplyGatherersChanged");

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

@@ -1539 +1539 @@
             "APPROACHING": {
                 "enter": function() {
                     this.SelectAnimation("move");
+                    
+                    this.gatheringTarget = this.order.data.target;  // temporary, deleted in "leave".
+
+                    // check that we can gather from the resource we're supposed to gather from.
+                    var cmpSupply = Engine.QueryInterface(this.order.data.target, IID_ResourceSupply);
+                    if (!cmpSupply || !cmpSupply.AddGatherer(this.entity))
+                    {
+                        // Save the current order's data in case we need it later
+                        var oldType = this.order.data.type;
+                        var oldTarget = this.order.data.target;
+                        var oldTemplate = this.order.data.template;
+
+                        // Try the next queued order if there is any
+                        if (this.FinishOrder())
+                            return true;
+                        
+                        // Try to find another nearby target of the same specific type
+                        // Also don't switch to a different type of huntable animal
+                        var nearby = this.FindNearbyResource(function (ent, type, template) {
+                            return (
+                                ent != oldTarget
+                                 && ((type.generic == "treasure" && oldType.generic == "treasure")
+                                 || (type.specific == oldType.specific
+                                 && (type.specific != "meat" || oldTemplate == template)))
+                            );
+                        });
+                        if (nearby)
+                        {
+                            this.PerformGather(nearby, false, false);
+                            return true;
+                        }
+
+                        var nearby = this.FindNearestDropsite(oldType.generic);
+                        if (nearby)
+                        {
+                            this.PushOrderFront("ReturnResource", { "target": nearby, "force": false });
+                            return true;
+                        }
+                        
+                        return true;
+                    }
+                    return false;
                 },
 
                 "MoveCompleted": function(msg) {
@@ -1546 +1588 @@
                     {
                         // We failed to reach the target
 
+                        // remove us from the list of entities gathering from Resource.
+                        var cmpSupply = Engine.QueryInterface(this.gatheringTarget, IID_ResourceSupply);
+                        if (cmpSupply)
+                            cmpSupply.RemoveGatherer(this.entity);
+
                         // Save the current order's data in case we need it later
                         var oldType = this.order.data.type;
                         var oldTarget = this.order.data.target;
@@ -1580 +1627 @@
                     // We reached the target - start gathering from it now
                     this.SetNextState("GATHERING");
                 },
+                
+                "leave": function() {
+                    var cmpSupply = Engine.QueryInterface(this.gatheringTarget, IID_ResourceSupply);
+                    if (cmpSupply)
+                        cmpSupply.RemoveGatherer(this.entity);
+                    delete this.gatheringTarget;
+                },
             },
             
             // Walking to a good place to gather resources near, used by GatherNearPosition
@@ -1617 +1671 @@
             "GATHERING": {
                 "enter": function() {
                     var target = this.order.data.target;
-
+                    if (target)
+                    {
+                        this.gatheringTarget = target;  // temporary, deleted in "leave".
+                        
+                        // Check that we can gather from the resource we're supposed to gather from.
+                        // Will only be added if we're not already in.
+                        var cmpSupply = Engine.QueryInterface(this.gatheringTarget, IID_ResourceSupply);
+                        if (!cmpSupply || !cmpSupply.AddGatherer(this.entity))
+                        {
+                            this.StartTimer(0);
+                            return false;
+                        }
+                    }
                     // If this order was forced, the player probably gave it, but now we've reached the target
                     //  switch to an unforced order (can be interrupted by attacks)
                     this.order.data.force = false;
@@ -1664 +1730 @@
 
                 "leave": function() {
                     this.StopTimer();
-
+                    
+                    var cmpSupply = Engine.QueryInterface(this.gatheringTarget, IID_ResourceSupply);
+                    if (cmpSupply)
+                        cmpSupply.RemoveGatherer(this.entity);
+                    delete this.gatheringTarget;
+                    
                     // Show the carried resource, if we've gathered anything.
                     this.SetGathererAnimationOverride();
                 },
@@ -1673 +1744 @@
                     var target = this.order.data.target;
                     var resourceTemplate = this.order.data.template;
                     var resourceType = this.order.data.type;
+                    
+                    var cmpSupply = Engine.QueryInterface(this.gatheringTarget, IID_ResourceSupply);
+                        
                     // Check we can still reach and gather from the target
-                    if (this.CheckTargetRange(target, IID_ResourceGatherer) && this.CanGather(target))
+                    if (this.CheckTargetRange(target, IID_ResourceGatherer) && this.CanGather(target) && cmpSupply && cmpSupply.IsAvailable(this.entity))
                     {
                         // Gather the resources:
 
@@ -1714 +1788 @@
                         if (!status.exhausted)
                             return;
                     }
-                    else
+                    else if (cmpSupply && cmpSupply.IsAvailable(this.entity))
                     {
                         // Try to follow the target
                         if (this.MoveToTargetRange(target, IID_ResourceGatherer))
@@ -2997 +3071 @@
         if (template.indexOf("resource|") != -1)
             template = template.slice(9);
 
-        if (amount > 0 && filter(ent, type, template))
+        if (amount > 0 && cmpResourceSupply.IsAvailable(this.entity) && filter(ent, type, template))
             return ent;
     }
 

binaries/data/mods/public/simulation/ai/qbot/worker.js

@@ -168 +168 @@
         if (!supply.position()){
             return;
         }
+                             
+        if (supply.isFull === true) {
+            return;
+        }
         
         // measure the distance to the resource
         var dist = VectorDistance(supply.position(), ent.position());

binaries/data/mods/public/simulation/ai/qbot-wc/worker.js

@@ -312 +312 @@
             return;
         }
                              
-        // too many workers trying to gather from this resource
-        if (supply.getMetadata(PlayerID, "full") === true) {
-            //debug ("full");
+        if (supply.isFull === true) {
             return;
         }
                              

binaries/data/mods/public/simulation/ai/common-api-v2/entity.js

@@ -161 +161 @@
             return undefined;
         return +this._template.ResourceSupply.Amount;
     },
-    
+                           
+    maxGatherers: function()
+    {
+        if (this._template.ResourceSupply !== undefined)
+            return this._template.ResourceSupply.MaxGatherers;
+        return 0;
+    },
+
     resourceGatherRates: function() {
         if (!this._template.ResourceGatherer)
             return undefined;
@@ -339 +346 @@
         return this._entity.resourceSupplyAmount;
     },
 
+    resourceSupplyGatherers: function()
+    {
+        if (this._entity.resourceSupplyGatherers !== undefined)
+            return this._entity.resourceSupplyGatherers;
+        return [];
+    },
+    
+    isFull: function()
+    {
+        if (this._entity.resourceSupplyGatherers !== undefined)
+            return (this.maxGatherers === this._entity.resourceSupplyGatherers.length);
+        return undefined;
+    },
+
     resourceCarrying: function() {
         if(this._entity.resourceCarrying === undefined)
             return undefined;

binaries/data/mods/public/simulation/ai/common-api-v3/entity.js

@@ -326 +326 @@
         return +this._template.ResourceSupply.Amount;
     },
     
+    maxGatherers: function()
+    {
+        if (this._template.ResourceSupply !== undefined)
+            return this._template.ResourceSupply.MaxGatherers;
+        return 0;
+    },
+
     resourceGatherRates: function() {
         if (!this._template.ResourceGatherer)
             return undefined;
@@ -523 +530 @@
             return undefined;
         return this._entity.resourceSupplyAmount;
     },
+    
+    resourceSupplyGatherers: function()
+    {
+        if (this._entity.resourceSupplyGatherers !== undefined)
+            return this._entity.resourceSupplyGatherers;
+        return [];
+    },
 
+    isFull: function()
+    {
+        if (this._entity.resourceSupplyGatherers !== undefined)
+            return (this.maxGatherers === this._entity.resourceSupplyGatherers.length);
+        return undefined;
+    },
+
     resourceCarrying: function() {
         if(this._entity.resourceCarrying === undefined)
             return undefined;

binaries/data/mods/public/simulation/templates/template_gaia_treasure.xml

@@ -21 +21 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>300</Amount>
     <Type>treasure.metal</Type>
+    <MaxGatherers>1</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_gaia_flora_bush_berry.xml

@@ -19 +19 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>200</Amount>
     <Type>food.fruit</Type>
+    <MaxGatherers>6</MaxGatherers>
   </ResourceSupply>
   <Selectable>
     <EditorOnly disable=""/>

binaries/data/mods/public/simulation/templates/template_structure_resource_corral.xml

@@ -60 +60 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>200</Amount>
     <Type>food.milk</Type>
+    <MaxGatherers>6</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_unit_fauna_hunt.xml

@@ -8 +8 @@
     <KillBeforeGather>true</KillBeforeGather>
     <Amount>100</Amount>
     <Type>food.meat</Type>
+    <MaxGatherers>8</MaxGatherers>
   </ResourceSupply>
 </Entity>

binaries/data/mods/public/simulation/templates/template_unit_fauna_hunt_whale.xml

@@ -14 +14 @@
     <KillBeforeGather>true</KillBeforeGather>
     <Amount>500</Amount>
     <Type>food.meat</Type>
-  </ResourceSupply>
+    <MaxGatherers>4</MaxGatherers>
+ </ResourceSupply>
 </Entity>

binaries/data/mods/public/simulation/templates/template_unit_fauna_fish.xml

@@ -22 +22 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>1000</Amount>
     <Type>food.fish</Type>
+    <MaxGatherers>4</MaxGatherers>
   </ResourceSupply>
   <Selectable>
     <Overlay>

binaries/data/mods/public/simulation/templates/template_unit_fauna_herd.xml

@@ -13 +13 @@
     <KillBeforeGather>true</KillBeforeGather>
     <Amount>100</Amount>
     <Type>food.meat</Type>
+    <MaxGatherers>8</MaxGatherers>
   </ResourceSupply>
   <Vision>
     <Range>20</Range>

binaries/data/mods/public/simulation/templates/template_gaia_ruins.xml

@@ -21 +21 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>500</Amount>
     <Type>stone.ruins</Type>
+    <MaxGatherers>1</MaxGatherers>
   </ResourceSupply>
   <Selectable>
     <EditorOnly disable=""/>

binaries/data/mods/public/simulation/templates/template_gaia_geo_rock_slabs.xml

@@ -12 +12 @@
   </Position>
   <ResourceSupply>
     <Amount>5000</Amount>
+    <MaxGatherers>16</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_gaia_geo_mineral.xml

@@ -14 +14 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>1000</Amount>
     <Type>metal.ore</Type>
+    <MaxGatherers>8</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_gaia_geo_rock.xml

@@ -14 +14 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>1000</Amount>
     <Type>stone.rock</Type>
+    <MaxGatherers>8</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_structure_resource_field.xml

@@ -53 +53 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>2000</Amount>
     <Type>food.grain</Type>
+    <MaxGatherers>20</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_gaia_geo_mineral_slabs.xml

@@ -12 +12 @@
   </Position>
   <ResourceSupply>
     <Amount>5000</Amount>
+    <MaxGatherers>16</MaxGatherers>
   </ResourceSupply>
   <Sound>
     <SoundGroups>

binaries/data/mods/public/simulation/templates/template_gaia_flora_tree.xml

@@ -14 +14 @@
     <KillBeforeGather>false</KillBeforeGather>
     <Amount>200</Amount>
     <Type>wood.tree</Type>
+    <MaxGatherers>6</MaxGatherers>
   </ResourceSupply>
   <Selectable>
     <EditorOnly disable=""/>