Ticket #3606: IdleRegenRate3.patch

simulation/ai/petra/researchManager.js

@@ -156 +156 @@
                 return tech[0];
             else if (template.modifications[i].value === "Health/RegenRate")
                 return tech[0];
+            else if (template.modifications[i].value === "Health/IdleRegenRate")
+                return tech[0];
         }
     }
     return false;

simulation/components/Health.js

@@ -5 +5 @@
     "<a:example>" +
         "<Max>100</Max>" +
         "<RegenRate>1.0</RegenRate>" +
+        "<IdleRegenRate>0</IdleRegenRate>" +
         "<DeathType>corpse</DeathType>" +
     "</a:example>" +
     "<element name='Max' a:help='Maximum hitpoints'>" +
@@ -23 +24 @@
     "<element name='RegenRate' a:help='Hitpoint regeneration rate per second.'>" +
         "<data type='decimal'/>" +
     "</element>" +
+    "<element name='IdleRegenRate' a:help='Hitpoint regeneration rate per second when idle or garrisoned.'>" +
+        "<data type='decimal'/>" +
+    "</element>" +
     "<element name='DeathType' a:help='Behaviour when the unit dies'>" +
         "<choice>" +
             "<value a:help='Disappear instantly'>vanish</value>" +
@@ -45 +49 @@
     // (Allowing 0 initial HP would break our death detection code)
     this.hitpoints = +(this.template.Initial || this.GetMaxHitpoints());
     this.regenRate = ApplyValueModificationsToEntity("Health/RegenRate", +this.template.RegenRate, this.entity);
+    if(this.template.IdleRegenRate == undefined)
+    {
+        this.idleRegenRate = 0;
+    }
+    else
+    {
+        this.idleRegenRate = ApplyValueModificationsToEntity("Health/IdleRegenRate", +this.template.IdleRegenRate, this.entity);
+    }
     this.CheckRegenTimer();
 };
 
@@ -107 +119 @@
     return this.template.Undeletable == "true";
 };
 
+Health.prototype.GetIdleRegenRate = function()
+{
+    return this.idleRegenRate;
+};
+
 Health.prototype.GetRegenRate = function()
 {
     return this.regenRate;
@@ -114 +131 @@
 
 Health.prototype.ExecuteRegeneration = function()
 {
-    var regen = this.GetRegenRate();
+    let regen = this.GetRegenRate();
     if (regen > 0)
         this.Increase(regen);
     else 
         this.Reduce(-regen);
+    if(this.GetIdleRegenRate() != 0)
+    {
+        let cmpUnitAI = Engine.QueryInterface(this.entity, IID_UnitAI);
+        if(cmpUnitAI && cmpUnitAI.IsResting())
+        {
+            let idleRegen = this.GetIdleRegenRate();
+            if (idleRegen > 0)
+                this.Increase(idleRegen);
+            else 
+                this.Reduce(-idleRegen);
+        }
+    }
 };
 
 /*
@@ -127 +156 @@
 Health.prototype.CheckRegenTimer = function()
 {
     // check if we need a timer
-    if (this.GetRegenRate() == 0 ||
-        this.GetHitpoints() == this.GetMaxHitpoints() && this.GetRegenRate() > 0 ||
-        this.GetHitpoints() == 0)
+    if ((this.GetRegenRate() == 0 && this.GetIdleRegenRate() == 0) ||
+        (this.GetHitpoints() == this.GetMaxHitpoints() && this.GetRegenRate() >= 0 && this.GetIdleRegenRate() >= 0) ||
+         this.GetHitpoints() == 0)
     {
         // we don't need a timer, disable if one exists
         if (this.regenTimer)
@@ -325 +354 @@
     if (msg.component != "Health")
         return;
 
-    var oldMaxHitpoints = this.GetMaxHitpoints();
-    var newMaxHitpoints = Math.round(ApplyValueModificationsToEntity("Health/Max", +this.template.Max, this.entity));
+    let oldMaxHitpoints = this.GetMaxHitpoints();
+    let newMaxHitpoints = Math.round(ApplyValueModificationsToEntity("Health/Max", +this.template.Max, this.entity));
     if (oldMaxHitpoints != newMaxHitpoints)
     {
-        var newHitpoints = Math.round(this.GetHitpoints() * newMaxHitpoints/oldMaxHitpoints);
+        let newHitpoints = Math.round(this.GetHitpoints() * newMaxHitpoints/oldMaxHitpoints);
         this.maxHitpoints = newMaxHitpoints;
         this.SetHitpoints(newHitpoints);
     }
 
-    var oldRegenRate = this.regenRate;
+    let oldRegenRate = this.regenRate;
     this.regenRate = ApplyValueModificationsToEntity("Health/RegenRate", +this.template.RegenRate, this.entity);
 
     if (this.regenRate != oldRegenRate)
         this.CheckRegenTimer();
+    
+    if(this.template.IdleRegenRate != undefined)
+    {
+        let oldIdleRegenRate = this.idleRegenRate;
+        this.idleRegenRate = ApplyValueModificationsToEntity("Health/IdleRegenRate", +this.template.IdleRegenRate, this.entity);
+    
+        if (this.idleRegenRate != oldIdleRegenRate)
+            this.CheckRegenTimer();
+    }
 };
 
 Health.prototype.OnHealthChanged = function()

simulation/components/UnitAI.js

@@ -3298 +3298 @@
     return this.isGarrisoned;
 };
 
+/**
+* Returns true if the unit is idle a turret and idle
+* or a non-turret garrisoned unit
+*/
+UnitAI.prototype.IsResting = function()
+{
+    if(this.IsIdle())
+        return true;
+    if(this.IsGarrisoned() && !this.IsTurret())
+        return true;
+    return false;
+};
+
 UnitAI.prototype.SetGarrisoned = function()
 {
     this.isGarrisoned = true;

simulation/data/technologies/health_regen_units.json

@@ -7 +7 @@
     "icon": "bandage.png",
     "researchTime": 40,
     "tooltip": "Organic units will slowly regenerate health over time when idle.",
-    "modifications": [{"value": "Health/RegenRate", "add": 0.5}],
+    "modifications": [{"value": "Health/IdleRegenRate", "add": 0.5}],
     "affects": ["Unit Organic"],
     "soundComplete": "interface/alarm/alarm_upgradearmory.xml"
 }

simulation/templates/template_structure.xml

@@ -47 +47 @@
   <Health>
     <DeathType>corpse</DeathType>
     <RegenRate>0</RegenRate>
+    <IdleRegenRate>0</IdleRegenRate>
     <Undeletable>false</Undeletable>
     <Unhealable>true</Unhealable>
   </Health>

simulation/templates/template_unit.xml

@@ -31 +31 @@
     <DeathType>corpse</DeathType>
     <Max>100</Max>
     <RegenRate>0</RegenRate>
+    <IdleRegenRate>0</IdleRegenRate>
     <Undeletable>false</Undeletable>
     <Unhealable>false</Unhealable>
   </Health>