Ticket #1973: regenerative-resources.patch

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

@@ -30 +30 @@
             "<value>treasure.food</value>" +
         "</choice>" +
     "</element>" +
+    "<optional>" +
+        "<element name='Regeneration' a:help='Controls whether this resource can regenerate its remaining amount.'>" +
+            "<interleave>" +
+                "<element name='Rate' a:help='Optional regeneration rate. Resources/second if the growth is linear or the rate of population growth if the growith is exponential.'>" +
+                    "<data type='decimal'/>" +
+                "</element>" +
+                "<element name='Delay' a:help='Seconds between when the number of gatherers hit 0 and the resource starts regenerating.'>" +
+                    "<data type='nonNegativeInteger'/>" +
+                "</element>" +
+                "<element name='Growth' a:help='Growth formula for regeneration. Either linear or exponential. Linear continually adds the rate, while exponential uses it as the rate in the standard population growth formula.'>" +
+                    "<choice>" +
+                        "<value>linear</value>" +
+                        "<value>exponential</value>" +
+                    "</choice>" +
+                "</element>" +
+            "</interleave>" +
+        "</element>" +
+    "</optional>" +
     "<element name='MaxGatherers' a:help='Amount of gatherers who can gather resources from this entity at the same time'>" +
         "<data type='nonNegativeInteger'/>" +
     "</element>";
@@ -38 +56 @@
 {
     // Current resource amount (non-negative)
     this.amount = this.GetMaxAmount();
-    this.gatherers = [];    // list of IDs
+    this.gatherers = [];    // list of IDs
+    if (this.template.Regeneration !== undefined) {
+        this.regenRate = +this.template.Regeneration.Rate;
+        this.regenDelay = +this.template.Regeneration.Delay;
+        this.regenGrowth = this.template.Regeneration.Growth;
+        this.RegenerateResources({rate: 0});
+    }
+    else {
+        this.regenRate = 0;
+        this.regenDelay = 0;
+        this.regenGrowth = "";
+    }
 };
 
 ResourceSupply.prototype.GetKillBeforeGather = function()
@@ -75 +104 @@
     var change = old - this.amount;
 
     // Remove entities that have been exhausted
-    if (this.amount == 0)
+    if (this.amount == 0 && !this.IsRegenerative())
         Engine.DestroyEntity(this.entity);
 
     Engine.PostMessage(this.entity, MT_ResourceSupplyChanged, { "from": old, "to": this.amount });
 
-    return { "amount": change, "exhausted": (this.amount == 0) };
+    return { "amount": change, "exhausted": this.amount == 0 };
 };
 
+ResourceSupply.prototype.RegenerateResources = function(data, lateness) {
+    var max = this.GetMaxAmount();
+    if (this.gatherers.length == 0 && !this.regenDelayTimer && this.amount < max) {
+        var old = this.amount;
+        if (this.regenTime == null)
+            this.regenTime == 0;
+        if (this.regenGrowth == "linear")
+            this.amount = Math.min(max, this.amount + data.rate);
+        else
+            this.amount = Math.min(max, Math.round(this.amount * Math.pow(Math.E, data.rate / 100 * this.regenTime)));
+        ++this.regenTime;
+        Engine.PostMessage(this.entity, MT_ResourceSupplyChanged, { "from": old, "to": this.amount });
+    }
+    if (this.amount == max)
+        this.regenTime = null;
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    var regenRate = this.GetRegenerationRate();
+    var absRegen = Math.abs(regenRate);
+    if (Math.floor(regenRate) == regenRate || this.regenGrowth == "exponential")
+        cmpTimer.SetTimeout(this.entity, IID_ResourceSupply, "RegenerateResources", 1000, { "rate": regenRate });
+    else
+        cmpTimer.SetTimeout(this.entity, IID_ResourceSupply, "RegenerateResources", 1000 / absRegen,
+                { "rate": absRegen == regenRate ? 1 : -1 });
+};
+
+ResourceSupply.prototype.StartRegenerationDelayTimer = function() {
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    this.regenDelayTimer = cmpTimer.SetTimeout(this.entity, IID_ResourceSupply, "CancelRegenerationDelayTimer", this.GetRegenerationDelay() * 1000, null);
+};
+
+ResourceSupply.prototype.CancelRegenerationDelayTimer = function() {
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    cmpTimer.CancelTimer(this.regenDelayTimer);
+    this.regenDelayTimer = null;
+};
+
 ResourceSupply.prototype.GetType = function()
 {
     // All resources must have both type and subtype
@@ -98 +163 @@
     return false;
 };
 
+ResourceSupply.prototype.IsRegenerative = function() {
+    return this.GetRegenerationRate() != 0;
+};
+
+ResourceSupply.prototype.GetTerritoryOwner = function () {
+    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpTerritoryManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TerritoryManager);
+    var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
+    if (!(cmpPosition && cmpPosition.IsInWorld()))
+        return 0;  // Something's wrong, just say we're in neutral territory.
+    var pos = cmpPosition.GetPosition2D();
+    return cmpPlayerManager.GetPlayerByID(cmpTerritoryManager.GetOwner(pos.x, pos.y));
+};
+
+ResourceSupply.prototype.GetRegenerationRate = function() {
+    return ApplyTechModificationsToPlayer("ResourceSupply/Regeneration/Rate", this.regenRate, this.GetTerritoryOwner());
+};
+
+ResourceSupply.prototype.GetRegenerationDelay = function() {
+    return ApplyTechModificationsToPlayer("ResourcesSupply/Regeneration/Delay", this.regenDelay, this.GetTerritoryOwner());
+};
+
 ResourceSupply.prototype.AddGatherer = function(gathererID)
 {
     if (!this.IsAvailable(gathererID))
@@ -106 +193 @@
     if (this.gatherers.indexOf(gathererID) === -1)
     {
         this.gatherers.push(gathererID);
+        this.CancelRegenerationDelayTimer();
         // broadcast message, mainly useful for the AIs.
         Engine.PostMessage(this.entity, MT_ResourceSupplyGatherersChanged, { "to": this.gatherers });
     }
@@ -122 +210 @@
         // broadcast message, mainly useful for the AIs.
         Engine.PostMessage(this.entity, MT_ResourceSupplyGatherersChanged, { "to": this.gatherers });
     }
+    if (this.gatherers.length == 0)
+        this.StartRegenerationDelayTimer();
 };
 
 Engine.RegisterComponentType(IID_ResourceSupply, "ResourceSupply", ResourceSupply);

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>8</MaxGatherers>
+    <MaxGatherers>8</MaxGatherers>
+    <Regeneration>
+      <Rate>10</Rate>
+      <Delay>10</Delay>
+      <Growth>linear</Growth>
+    </Regeneration>
   </ResourceSupply>
   <Selectable>
     <EditorOnly disable=""/>

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>
+    <MaxGatherers>4</MaxGatherers>
+    <Regeneration>
+      <Rate>1.68</Rate>
+      <Delay>5</Delay>
+      <Growth>exponential</Growth>
+    </Regeneration>
   </ResourceSupply>
   <Selectable>
     <Overlay>