Ticket #4079: upgradeEntity.patch

binaries/data/mods/public/globalscripts/Templates.js

@@ -303 +303 @@
             ret.speed.run = getEntityValue("UnitMotion/Run/Speed");
     }
 
+    if (template.Upgrade)
+    {
+        ret.upgrades = [];
+        for (let upKey in template.Upgrade)
+        {
+            let upgrade = {
+                "name": upKey,
+                "entity": template.Upgrade[upKey].Entity,
+                "tooltip": template.Upgrade[upKey].Tooltip,
+                "cost": {},
+            };
+
+            for (let res in template.Upgrade[upKey].Cost)
+                upgrade.cost[res] = getEntityValue("Upgrade/" + upKey + "/Cost/" + res);
+
+            if (template.Upgrade[upKey].Time)
+                upgrade.cost.time = getEntityValue("Upgrade/" + upKey + "/Time");
+
+            if (template.Upgrade[upKey].Icon)
+                upgrade.icon = template.Upgrade[upKey].Icon;
+
+            if (template.RequiredTechnology)
+                upgrade.requiredTechnology = template.RequiredTechnology;
+
+            ret.upgrades.push(upgrade);
+        }
+    }
+
     if (template.ProductionQueue)
     {
         ret.techCostMultiplier = {};

binaries/data/mods/public/gui/structree/draw.js

@@ -82 +82 @@
                         p++;
                     }
 
+                if (stru.upgrades[prod_pha])
+                    for (let upgrade of stru.upgrades[prod_pha])
+                    {
+                        if (!drawProdIcon(i, s, r, p, upgrade.data))
+                            break;
+                        p++;
+                    }
+
                 if (stru.wallset && prod_pha == pha)
-                    for (let prod of [stru.wallset.gate, stru.wallset.tower])
+                    for (let prod of [stru.wallset.tower])
                     {
                         if (!drawProdIcon(i, s, r, p, prod))
                             break;
@@ -156 +164 @@
         thisEle.hidden = false;
         
         let p = 0;
-        for (let prodType in trainer.production)
-        {
-            for (let prod of trainer.production[prodType])
+        if (trainer.production)
+            for (let prodType in trainer.production)
             {
-                switch (prodType)
+                for (let prod of trainer.production[prodType])
                 {
-                case "units":
-                    prod = g_ParsedData.units[prod];
-                    break;
-                case "techs":
-                    prod = clone(g_ParsedData.techs[prod]);
-                    for (let res in trainer.techCostMultiplier)
-                        if (prod.cost[res])
-                            prod.cost[res] *= trainer.techCostMultiplier[res];
-                    break;
-                default:
-                    continue;
+                    switch (prodType)
+                    {
+                    case "units":
+                        prod = g_ParsedData.units[prod];
+                        break;
+                    case "techs":
+                        prod = clone(g_ParsedData.techs[prod]);
+                        for (let res in trainer.techCostMultiplier)
+                            if (prod.cost[res])
+                                prod.cost[res] *= trainer.techCostMultiplier[res];
+                        break;
+                    default:
+                        continue;
+                    }
+                    if (!drawProdIcon(null, t, null, p, prod))
+                        break;
+                    ++p;
                 }
-                if (!drawProdIcon(null, t, null, p, prod))
+            }
+        if (trainer.upgrades)
+            for (let upgrade of trainer.upgrades)
+            {
+                if (!drawProdIcon(null, t, null, p, upgrade.data))
                     break;
                 ++p;
             }
-        }
         hideRemaining("trainer["+t+"]_prod[", p, "]");
 
         let size = thisEle.size;

binaries/data/mods/public/gui/structree/helper.js

@@ -93 +93 @@
 }
 
 /**
+ * Function is used to move attribute values from an Upgrade component
+ * entry to its designated entity data object, overriding current values.
+ */
+function transferUpgradeData(from, to)
+{
+    to.cost = from.cost;
+    to.icon = from.icon || to.icon;
+    to.tooltip = from.tooltip || to.tooltip;
+    to.requiredTechnology = from.requiredTechnology || to.requiredTechnology;
+    return to;
+}
+
+/**
  * This is needed because getEntityCostTooltip in tooltip.js needs to get
  * the template data of the different wallSet pieces. In the session this
  * function does some caching, but here we do that in loadTemplate already.

binaries/data/mods/public/gui/structree/load.js

@@ -78 +78 @@
                 g_Lists.structures.push(build);
         }
 
+    if (unit.upgrades)
+        for (let idx in unit.upgrades)
+        {
+            unit.upgrades[idx].entity = unit.upgrades[idx].entity.replace("{civ}", g_SelectedCiv);
+
+            let data = loadUnit(unit.upgrades[idx].entity);
+            data = transferUpgradeData(unit.upgrades[idx], data);
+            unit.upgrades[idx].data = data;
+        }
+
     return unit;
 }
 
@@ -111 +121 @@
             }
     }
 
+    if (structure.upgrades)
+        for (let idx in structure.upgrades)
+        {
+            structure.upgrades[idx].entity = structure.upgrades[idx].entity.replace("{civ}", g_SelectedCiv);
+
+            let data = loadStructure(structure.upgrades[idx].entity);
+            data = transferUpgradeData(structure.upgrades[idx], data);
+            structure.upgrades[idx].data = data;
+        }
+
     if (structure.wallSet)
     {
         structure.wallset = {};
 
+        if (!structure.upgrades)
+            structure.upgrades = [];
+
         // Note: Assume wall segments of all lengths have the same armor and auras
         let struct = loadStructure(structure.wallSet.templates.long);
         structure.armour = struct.armour;
@@ -134 +157 @@
             for (let research of wPart.production.technology)
                 structure.production.technology.push(research);
 
+            if (wPart.upgrades)
+                structure.upgrades = structure.upgrades.concat(wPart.upgrades);
+
             if (["gate", "tower"].indexOf(wSegm) != -1)
                 continue;
 

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

@@ -161 +161 @@
         }
     }
 
-    // Group production lists of structures by phase
+    // Group production and upgrade lists of structures by phase
     for (let structCode of g_Lists.structures)
     {
         let structInfo = g_ParsedData.structures[structCode];
@@ -222 +222 @@
             "technology": newProdTech,
             "units": newProdUnits
         };
+
+        // Sort upgrades by phase
+        let newUpgrades = {};
+        if (structInfo.upgrades)
+        {
+            for (let upgrade of structInfo.upgrades)
+            {
+                let phase = GetPhaseOfTemplate(upgrade.data);
+
+                if (g_ParsedData.phaseList.indexOf(phase) < structPhaseIdx)
+                    phase = structInfo.phase;
+
+                if (!(phase in newUpgrades))
+                    newUpgrades[phase] = [];
+                newUpgrades[phase].push(upgrade);
+            }
+        }
+        g_ParsedData.structures[structCode].upgrades = newUpgrades;
     }
 
     // Determine the buildList for the civ (grouped by phase)
@@ -234 +252 @@
         let phase = g_ParsedData.structures[structCode].phase;
         buildList[phase].push(structCode);
     }
+
     for (let unitCode of g_Lists.units)
-        if (g_ParsedData.units[unitCode] && g_ParsedData.units[unitCode].production)
+        if (g_ParsedData.units[unitCode] && (g_ParsedData.units[unitCode].production || g_ParsedData.units[unitCode].upgrades))
             trainerList.push(unitCode);
 
     g_CivData[g_SelectedCiv].buildList = buildList;

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

@@ -1 +1 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Entity parent="template_structure_defense_wall_long">
   <Auras disable=""/>
+  <Cost disable=""/>
   <GarrisonHolder disable=""/>
   <Gate>
     <PassRange>20</PassRange>