Ticket #2706: UpgradeComponent.2.patch

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

@@ -1614 +1614 @@
     });
 }
 
-// Transform a wall to a gate
-function transformWallToGate(template)
+// Upgrade an entity to another
+function upgradeEntity(Template)
 {
     var selection = g_Selection.toList();
     Engine.PostNetworkCommand({
-        "type": "wall-to-gate",
-        "entities": selection.filter( function(e) { return getWallGateTemplate(e) == template } ),
-        "template": template,
+        "type": "upgrade",
+        "entities": selection,
+        "template": Template,
+        "queued": false
     });
 }
 
-// Gets the gate form (if any) of a given long wall piece
-function getWallGateTemplate(entity)
+// Cancel upgrading entities
+function cancelUpgradeEntity()
 {
-    // TODO: find the gate template name in a better way
-    var entState = GetEntityState(entity);
-    var index;
-
-    if (entState && !entState.foundation && hasClass(entState, "LongWall") && (index = entState.template.indexOf("long")) >= 0)
-        return entState.template.substr(0, index) + "gate";
-    return undefined;
+    var selection = g_Selection.toList();
+    Engine.PostNetworkCommand({
+        "type": "cancel-upgrade",
+        "entities": selection,
+        "queued": false
+    });
 }
 
 // Set the camera to follow the given unit

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

@@ -372 +372 @@
         for (var i in selection)
         {
             var state = GetEntityState(selection[i]);
-            if (hasClass(state, "LongWall") && !state.gate && !longWallTypes[state.template])
+            if (state.gate && !gates.length)
             {
-                var gateTemplate = getWallGateTemplate(state.id);
-                if (gateTemplate)
-                {
-                    var tooltipString = GetTemplateDataWithoutLocalization(state.template).gateConversionTooltip;
-                    if (!tooltipString)
-                    {
-                        warn(state.template + " is supposed to be convertable to a gate, but it's missing the GateConversionTooltip in the Identity template");
-                        tooltipString = "";
-                    }
-                    walls.push({
-                        "tooltip": translate(tooltipString),
-                        "template": gateTemplate,
-                        "callback": function (item) { transformWallToGate(item.template); }
-                    });
-                }
-
-                // We only need one entity per type.
-                longWallTypes[state.template] = true;
-            }
-            else if (state.gate && !gates.length)
-            {
                 gates.push({
                     "gate": state.gate,
                     "tooltip": translate("Lock Gate"),
@@ -424 +403 @@
     },
     "setTooltip": function(data)
     {
-        var tooltip = data.item.tooltip;
-        if (data.item.template)
-        {
-            data.template = GetTemplateData(data.item.template);
-            data.wallCount = data.selection.reduce(function (count, ent) {
-                    var state = GetEntityState(ent);
-                    if (hasClass(state, "LongWall") && !state.gate)
-                        count++;
-                    return count;
-                }, 0);
-
-            tooltip += "\n" + getEntityCostTooltip(data.template, data.wallCount);
-
-
-            data.neededResources = Engine.GuiInterfaceCall("GetNeededResources", multiplyEntityCosts(data.template, data.wallCount));
-            if (data.neededResources)
-                tooltip += getNeededResourcesTooltip(data.neededResources);
-        }
-        data.button.tooltip = tooltip;
+        data.button.tooltip = data.item.tooltip;
     },
     "setGraphics": function(data)
     {
-        data.affordableMask.hidden == data.neededResources ? true : false;
         var gateIcon;
         if (data.item.gate)
         {
-            // If already a gate, show locking actions
+            // Show locking actions
             gateIcon = "icons/lock_" + GATE_ACTIONS[data.item.locked ? 0 : 1] + "ed.png";
             if (data.item.gate.locked === undefined)
                 data.guiSelection.hidden = false
@@ -457 +417 @@
             else
                 data.guiSelection.hidden = data.item.gate.locked != data.item.locked;
         }
-        else
-        {
-            // otherwise show gate upgrade icon
-            var template = GetTemplateData(data.item.template);
-            if (!template)
-                return;
-            gateIcon = data.template.icon ? "portraits/" + data.template.icon : "icons/gate_closed.png";
-            data.guiSelection.hidden = true;
-        }
-
         data.icon.sprite = "stretched:session/" + gateIcon;
     },
     "setPosition": function(data)
@@ -541 +491 @@
     },
 };
 
+// UPGRADE
+g_SelectionPanels.Upgrade = {
+    "getMaxNumberOfItems": function()
+    {
+        return 24 - getNumberOfRightPanelButtons();
+    },
+    "getItems": function(unitEntState, selection)
+    {
+        // Interface becomes complicated with multiple units and this is meant per-entity, so prevent it if the selection has multiple units.
+        if (selection.length > 1)
+            return false;
+        var items = [];
+
+        if (!unitEntState.upgrade)
+            return false;
+        
+        for each (var upgrade in unitEntState.upgrade.upgrades)
+        {
+            var item = {};
+            item.entType = upgrade.entity;
+            item.template = GetTemplateData(upgrade.entity);
+            if (!item.template) // abort if no template
+                return false;
+
+            item.icon = upgrade.icon;
+            if (!item.icon)
+                item.icon = "portraits/" + item.template.icon;
+
+            if (upgrade.requiredTechnology !== null)
+            {
+                item.requiredTechnology = upgrade.requiredTechnology;
+                if (!item.requiredTechnology && item.template.requiredTechnology)
+                    item.requiredTechnology = item.template.requiredTechnology
+            }
+            item.cost = upgrade.cost;
+            item.time = upgrade.time;
+
+            if (unitEntState.upgrade.progress === undefined)
+            {
+                item.upgrading = UPGRADING_NOT_STARTED;
+                item.tooltip = translate("Upgrade into a " + item.template.name.generic + (upgrade.tooltip? ".\n" + upgrade.tooltip : "."));
+                item.callback = function(data) { upgradeEntity(data.entType); };
+            }
+            else if (unitEntState.upgrade.template !== upgrade.entity)
+            {
+                item.upgrading = UPGRADING_CHOSEN_OTHER;
+                item.tooltip = translate("Cannot upgrade when the entity is already upgrading.");
+                item.callback = function(data) { };
+            }
+            else
+            {
+                item.upgrading = unitEntState.upgrade.progress;
+                item.tooltip = translate("Cancel Upgrading");
+                item.callback = function(data) { cancelUpgradeEntity(); };
+            }
+            items.push(item);
+        }
+        return items;
+    },
+    "addData" : function(data)
+    {
+        data.item.technologyEnabled = true;
+        if (data.item.requiredTechnology)
+            data.item.technologyEnabled = Engine.GuiInterfaceCall("IsTechnologyResearched", data.item.requiredTechnology);
+        if (data.item.cost)
+        {
+            var totalCost = {};
+            for (var i in data.item.cost)
+                totalCost[i] = data.item.cost[i];
+            data.item.neededResources = Engine.GuiInterfaceCall("GetNeededResources", totalCost);
+        }
+        data.item.limits = getEntityLimitAndCount(data.playerState, data.item.entType);
+        return true;
+    },
+    "setAction": function(data)
+    {
+        data.button.onPress = function() { data.item.callback(data.item); };
+    },
+    "setTooltip": function(data)
+    {
+        var tooltip = data.item.tooltip;
+
+        if (data.item.upgrading !== UPGRADING_NOT_STARTED)
+        {
+            data.button.tooltip = tooltip;
+            return;
+        }
+
+        if (data.item.cost)
+            tooltip += "\n" + getEntityCostTooltip(data.item);
+        
+        tooltip += formatLimitString(data.item.limits.entLimit, data.item.limits.entCount, data.item.limits.entLimitChangers);
+        if (!data.item.technologyEnabled)
+        {
+            var techName = getEntityNames(GetTechnologyData(data.item.requiredTechnology));
+            tooltip += "\n" + sprintf(translate("Requires %(technology)s"), { technology: techName });
+        }
+        if (data.item.neededResources)
+            tooltip += getNeededResourcesTooltip(data.item.neededResources);
+
+        data.button.tooltip = tooltip;
+    },
+    "setGraphics": function(data)
+    {
+        var grayscale = "";
+        if (data.item.upgrading == UPGRADING_CHOSEN_OTHER || !data.item.technologyEnabled || (data.item.limits.canBeAddedCount == 0 && data.item.upgrading == UPGRADING_NOT_STARTED))
+        {
+            data.button.enabled = false;
+            grayscale = "grayscale:";
+            data.affordableMask.hidden = false;
+            data.affordableMask.sprite = "colour: 0 0 0 127";
+        }
+        else if (data.item.upgrading == UPGRADING_NOT_STARTED && data.item.neededResources)
+        {
+            data.button.enabled = false;
+            data.affordableMask.hidden = false;
+            data.affordableMask.sprite = resourcesToAlphaMask(data.item.neededResources);
+        }
+        
+        data.icon.sprite = "stretched:" + grayscale + "session/" + data.item.icon;
+
+        var guiObject = Engine.GetGUIObjectByName("unitUpgradeProgressSlider["+data.i+"]");
+        var size = guiObject.size;
+        if (data.item.upgrading < 0)
+            size.top = size.right;
+        else
+            size.top = size.left + Math.round(Math.max(0,data.item.upgrading) * (size.right - size.left));
+        guiObject.size = size;
+    },
+    "setPosition": function(data)
+    {
+        var index = data.i + getNumberOfRightPanelButtons();
+        setPanelObjectPosition(data.button, index, data.rowLength);
+    },
+};
+
 // QUEUE
 g_SelectionPanels.Queue = {
     "getMaxNumberOfItems": function()
@@ -1015 +1101 @@
     // RIGHT PANE
     "Gate", // must always be shown on gates
     "Pack", // must always be shown on packable entities
+    "Upgrade", // must always be shown on upgradable entities
     "Training",
     "Construction",
     "Research", // normal together with training

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

@@ -8 +8 @@
 // Gate constants
 const GATE_ACTIONS = ["lock", "unlock"];
 
+// upgrade constants
+const UPGRADING_NOT_STARTED = -2;
+const UPGRADING_CHOSEN_OTHER = -1;
+
 // ==============================================
 // BARTER HELPERS
 // Resources to sell on barter panel

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

@@ -1 +1 @@
 // The number of currently visible buttons (used to optimise showing/hiding)
-var g_unitPanelButtons = {"Selection": 0, "Queue": 0, "Formation": 0, "Garrison": 0, "Training": 0, "Research": 0, "Barter": 0, "Construction": 0, "Command": 0, "Stance": 0, "Gate": 0, "Pack": 0};
+var g_unitPanelButtons = {"Selection": 0, "Queue": 0, "Formation": 0, "Garrison": 0, "Training": 0, "Research": 0, "Barter": 0, "Construction": 0, "Command": 0, "Stance": 0, "Gate": 0, "Pack": 0, "Upgrade": 0};
 
 /**
  * Set the position of a panel object according to the index,
@@ -289 +289 @@
         sum += g_unitPanelButtons["Pack"];
     if (g_SelectionPanels["Gate"].used)
         sum += g_unitPanelButtons["Gate"];
+    if (g_SelectionPanels["Upgrade"].used)
+        sum += g_unitPanelButtons["Upgrade"];
     return sum;
 }

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

@@ -7 +7 @@
         <object name="unitGateButton[n]" hidden="true" style="iconButton" type="button" size="0 0 46 46" tooltip_style="sessionToolTipBottom">
         <object name="unitGateIcon[n]" type="image" ghost="true" size="3 3 43 43"/>
         <object name="unitGateSelection[n]" hidden="true" type="image" ghost="true" size="3 3 43 43" sprite="stretched:session/icons/corners.png"/>
-        <object name="unitGateUnaffordable[n]" hidden="true" type="image" ghost="true" size="3 3 43 43" sprite="colour: 255 0 0 127"/>
         </object>
     </repeat>
     </object>

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

@@ +1 @@
+<?xml version="1.0" encoding="utf-8"?>
+<object name="unitUpgradePanel"
+    size="10 12 100% 100%"
+>
+    <object size="0 0 100% 100%">
+    <repeat count="8">
+        <object name="unitUpgradeButton[n]" hidden="true" style="iconButton" type="button" size="0 0 46 46" tooltip_style="sessionToolTipBottom">
+        <object name="unitUpgradeIcon[n]" type="image" ghost="true" size="3 3 43 43"/>
+        <object name="unitUpgradeUpgradeIcon[n]" type="image" ghost="true" size="3 3 43 43" sprite="stretched:session/icons/upgrade.png"/>
+        <object name="unitUpgradeProgressSlider[n]" type="image" sprite="queueProgressSlider" ghost="true" size="3 3 43 43" z="20"/>
+        <object name="unitUpgradeSelection[n]" hidden="true" type="image" ghost="true" size="3 3 43 43" sprite="stretched:session/icons/corners.png"/>
+        <object name="unitUpgradeUnaffordable[n]" hidden="true" type="image" ghost="true" size="3 3 43 43" sprite="colour: 255 0 0 127"/>
+        </object>
+    </repeat>
+    </object>
+</object>

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

@@ -180 +180 @@
         "gate": null,
         "guard": null,
         "pack": null,
+        "upgrade" : null,
         "player": -1,
         "position": null,
         "production": null,
@@ -232 +233 @@
         };
     }
 
+    var cmpUpgrade = Engine.QueryInterface(ent, IID_Upgrade);
+    if (cmpUpgrade)
+    {
+        ret.upgrade = {
+            "upgrades" : cmpUpgrade.GetUpgrades(),
+            "progress": cmpUpgrade.GetProgress(),
+            "template": cmpUpgrade.GetUpgradingTo()
+        };
+    }
+
     var cmpProductionQueue = Engine.QueryInterface(ent, IID_ProductionQueue);
     if (cmpProductionQueue)
     {
@@ -653 +664 @@
         };
         ret.icon = template.Identity.Icon;
         ret.tooltip =  template.Identity.Tooltip;
-        ret.gateConversionTooltip =  template.Identity.GateConversionTooltip;
         ret.requiredTechnology = template.Identity.RequiredTechnology;
         ret.visibleIdentityClasses = GetVisibleIdentityClasses(template.Identity);
     }

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

@@ -30 +30 @@
         "</element>" +
     "</optional>" +
     "<optional>" +
-        "<element name='GateConversionTooltip'>" +
-            "<text/>" +
-        "</element>" +
-    "</optional>" +
-    "<optional>" +
         "<element name='Rollover'>" +
             "<text/>" +
         "</element>" +

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

@@ -116 +116 @@
 
 Pack.prototype.PackProgress = function(data, lateness)
 {
-    if (this.elapsedTime >= this.GetPackTime())
+    if (this.elapsedTime < this.GetPackTime())
     {
-        this.CancelTimer();
+        this.SetElapsedTime(this.GetElapsedTime() + PACKING_INTERVAL + lateness);
+        return;
+    }
 
-        this.packed = !this.packed;
-        Engine.PostMessage(this.entity, MT_PackFinished, { packed: this.packed });
+    this.CancelTimer();
 
-        // Done un/packing, copy our parameters to the final entity
-        var newEntity = Engine.AddEntity(this.template.Entity);
-        if (newEntity == INVALID_ENTITY)
-        {
-            // Error (e.g. invalid template names)
-            error("PackProgress: Error creating entity for '" + this.template.Entity + "'");
-            return;
-        }
+    this.packed = !this.packed;
+    Engine.PostMessage(this.entity, MT_PackFinished, { packed: this.packed });
 
-        var cmpPosition = Engine.QueryInterface(this.entity, IID_Position);
-        var cmpNewPosition = Engine.QueryInterface(newEntity, IID_Position);
-        if (cmpPosition.IsInWorld())
-        {
-            var pos = cmpPosition.GetPosition2D();
-            cmpNewPosition.JumpTo(pos.x, pos.y);
-        }
-        var rot = cmpPosition.GetRotation();
-        cmpNewPosition.SetYRotation(rot.y);
-        cmpNewPosition.SetXZRotation(rot.x, rot.z);
-        cmpNewPosition.SetHeightOffset(cmpPosition.GetHeightOffset());
+    var newEntity = ChangeEntityTemplate(this.entity, this.template.Entity);
 
-        var cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
-        var cmpNewOwnership = Engine.QueryInterface(newEntity, IID_Ownership);
-        cmpNewOwnership.SetOwner(cmpOwnership.GetOwner());
-
-        // Maintain current health level
-        var cmpHealth = Engine.QueryInterface(this.entity, IID_Health);
-        var cmpNewHealth = Engine.QueryInterface(newEntity, IID_Health);
-        var healthLevel = Math.max(0, Math.min(1, cmpHealth.GetHitpoints() / cmpHealth.GetMaxHitpoints()));
-        cmpNewHealth.SetHitpoints(Math.round(cmpNewHealth.GetMaxHitpoints() * healthLevel));
-
-        var cmpUnitAI = Engine.QueryInterface(this.entity, IID_UnitAI);
-        var cmpNewUnitAI = Engine.QueryInterface(newEntity, IID_UnitAI);
-        if (cmpUnitAI && cmpNewUnitAI)
-        {
-            var pos = cmpUnitAI.GetHeldPosition();
-            if (pos)
-                cmpNewUnitAI.SetHeldPosition(pos.x, pos.z);
-            if (cmpUnitAI.GetStanceName())
-                cmpNewUnitAI.SwitchToStance(cmpUnitAI.GetStanceName());
-            cmpNewUnitAI.AddOrders(cmpUnitAI.GetOrders());
-            cmpNewUnitAI.SetGuardOf(cmpUnitAI.IsGuardOf());
-        }
-
-        // Maintain the list of guards
-        var cmpGuard = Engine.QueryInterface(this.entity, IID_Guard);
-        var cmpNewGuard = Engine.QueryInterface(newEntity, IID_Guard);
-        if (cmpGuard && cmpNewGuard)
-            cmpNewGuard.SetEntities(cmpGuard.GetEntities());
-
-        Engine.BroadcastMessage(MT_EntityRenamed, { entity: this.entity, newentity: newEntity });
-
-        // Play notification sound
+    // Play notification sound
+    if (newEntity)
+    {
         var sound = this.packed ? "packed" : "unpacked";
         PlaySound(sound, newEntity);
-
-        // Destroy current entity
-        Engine.DestroyEntity(this.entity);
     }
-    else
-    {
-        this.SetElapsedTime(this.GetElapsedTime() + PACKING_INTERVAL + lateness);
-    }
 };
 
 Engine.RegisterComponentType(IID_Pack, "Pack", Pack);

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

@@ +1 @@
+function Upgrade() {}
+
+const UPGRADING_PROGRESS_INTERVAL = 250;
+
+Upgrade.prototype.Schema =
+    "<oneOrMore>" +
+        "<element>" +
+            "<anyName />" +
+            "<interleave>" +
+                "<element name='Entity' a:help='Entity to upgrade to'>" +
+                    "<text/>" +
+                "</element>" +
+                "<optional>" +
+                    "<element name='Icon' a:help='Icon to show in the GUI'>" +
+                        "<text/>" +
+                    "</element>" +
+                "</optional>" +
+                "<optional>" +
+                    "<element name='Tooltip' a:help='This will be added to the tooltip to help the player choose why to upgrade.'>" +
+                        "<text/>" +
+                    "</element>" +
+                "</optional>" +
+                "<optional>" +
+                    "<element name='Time' a:help='Time required to upgrade this entity, in milliseconds'>" +
+                        "<data type='nonNegativeInteger'/>" +
+                    "</element>" +
+                "</optional>" +
+                "<optional>" +
+                    "<element name='Cost' a:help='Resource cost to upgrade this unit'>" +
+                        "<oneOrMore>" +
+                            "<choice>" +
+                                "<element name='food'><data type='nonNegativeInteger'/></element>" +
+                                "<element name='wood'><data type='nonNegativeInteger'/></element>" +
+                                "<element name='stone'><data type='nonNegativeInteger'/></element>" +
+                                "<element name='metal'><data type='nonNegativeInteger'/></element>" +
+                            "</choice>" +
+                        "</oneOrMore>" +
+                    "</element>" +
+                "</optional>" +
+                "<optional>" +
+                    "<element name='RequiredTechnology' a:help='Define what technology is required for this upgrade'>" +
+                        "<choice>" +
+                            "<text/>" +
+                            "<empty/>" +
+                        "</choice>" +
+                    "</element>" +
+                "</optional>" +
+                "<optional>" +
+                    "<element name='CheckPlacementRestrictions' a:help='Upgrading will check for placement restrictions'><empty/></element>" +
+                "</optional>" +
+            "</interleave>" +
+        "</element>" +
+    "</oneOrMore>";
+
+Upgrade.prototype.Init = function()
+{
+    this.upgrading = false;
+    this.elapsedTime = 0;
+    this.timer = undefined;
+
+    this.upgradeTemplates = {};
+
+    for (var choice in this.template)
+    {
+        var cmpIdentity = Engine.QueryInterface(this.entity, IID_Identity);
+        var name = this.template[choice].Entity;
+        if (cmpIdentity)
+            name = name.replace(/\{civ\}/g, cmpIdentity.GetCiv());
+        this.upgradeTemplates[name] = choice;
+    }
+};
+
+// On owner change, abort the upgrade
+// This will also deal with the "OnDestroy" case.
+Upgrade.prototype.OnOwnershipChanged = function(msg)
+{
+    this.CancelUpgrade();
+
+    if (msg.to !== -1)
+        this.owner = msg.to;
+};
+
+Upgrade.prototype.ChangeUpgradedEntityCount = function(amount)
+{
+    if (!this.IsUpgrading())
+        return;
+    var cmpTempMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+    var template = cmpTempMan.GetTemplate(this.upgrading);
+    var category = null;
+    if (template.TrainingRestrictions)
+        category = template.TrainingRestrictions.Category;
+    else if (template.BuildRestrictions)
+        category = template.BuildRestrictions.Category;
+
+    var cmpEntityLimits = QueryPlayerIDInterface(this.owner, IID_EntityLimits);
+    cmpEntityLimits.ChangeCount(category,amount);
+};
+
+Upgrade.prototype.CanUpgradeTo = function(Template)
+{
+    return this.upgradeTemplates[Template] !== undefined;
+};
+
+Upgrade.prototype.GetUpgrades = function()
+{
+    var ret = [];
+
+    var cmpIdentity = Engine.QueryInterface(this.entity, IID_Identity);
+
+    for each (var choice in this.template)
+    {
+        var entType = choice.Entity;
+        if (cmpIdentity)
+            entType = entType.replace(/\{civ\}/g, cmpIdentity.GetCiv());
+
+        var hasCosts = false;
+        var cost = {};
+        if (choice.Cost)
+        {
+            hasCosts = true;
+            for (var type in choice.Cost)
+                cost[type] = ApplyValueModificationsToTemplate("Upgrade/Cost/"+type, +choice.Cost[type], this.owner, entType);
+        }
+        if (choice.Time)
+        {
+            hasCosts = true;
+            cost["time"] = ApplyValueModificationsToTemplate("Upgrade/Time", +choice.Time/1000.0, this.owner, entType);
+        }
+        ret.push(
+        {
+            "entity": entType,
+            "icon": choice.Icon || undefined,
+            "cost": hasCosts ? cost : undefined,
+            "tooltip": choice.Tooltip || undefined,
+            "requiredTechnology": "RequiredTechnology" in choice ? choice.RequiredTechnology : null,
+        });
+    }
+
+    return ret;
+};
+
+Upgrade.prototype.CancelTimer = function()
+{
+    if (this.timer)
+    {
+        var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+        cmpTimer.CancelTimer(this.timer);
+        this.timer = undefined;
+    }
+};
+
+Upgrade.prototype.IsUpgrading = function()
+{
+    return this.upgrading !== false;
+};
+
+Upgrade.prototype.GetUpgradingTo = function()
+{
+    return this.upgrading;
+};
+
+Upgrade.prototype.CheckPlacementRestrictions = function(Template)
+{
+    if (!this.upgradeTemplates[Template])
+        return undefined;
+
+    return ("CheckPlacementRestrictions" in this.template[this.upgradeTemplates[Template]]);
+};
+
+Upgrade.prototype.GetRequiredTechnology = function(Template)
+{
+    if (!this.upgradeTemplates[Template])
+        return undefined;
+
+    var choice = this.upgradeTemplates[Template];
+
+    if ("RequiredTechnology" in this.template[choice] && this.template[choice].RequiredTechnology === undefined)
+    {
+        var cmpTemplateManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+        var template = cmpTemplateManager.GetTemplate(this.template[choice].Entity);
+        if (template.Identity.RequiredTechnology)
+            return template.Identity.RequiredTechnology;
+    }
+    else if ("RequiredTechnology" in this.template[choice])
+        return this.template[choice].RequiredTechnology;
+    return null;
+};
+
+Upgrade.prototype.GetResourceCosts = function(Template)
+{
+    if (!this.upgradeTemplates[Template])
+        return undefined;
+
+    var choice = this.upgradeTemplates[Template];
+    if (!this.template[choice].Cost)
+        return {};
+
+    var costs = {};
+    for (var r in this.template[choice].Cost)
+    {
+        costs[r] = +this.template[choice].Cost[r];
+        costs[r] = ApplyValueModificationsToEntity("Upgrade/Cost/"+r, costs[r], this.entity);
+    }
+    return costs;
+};
+
+Upgrade.prototype.Upgrade = function(Template)
+{
+    if (this.IsUpgrading())
+        return false;
+
+    if (!this.upgradeTemplates[Template])
+        return false;
+
+    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(this.owner), IID_Player);
+
+    if (!cmpPlayer.TrySubtractResources(this.GetResourceCosts(Template)))
+        return false;
+
+    this.upgrading = Template;
+
+    // prevent cheating
+    this.ChangeUpgradedEntityCount(1);
+
+    if (this.GetUpgradeTime(Template) !== 0)
+    {
+        var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+        this.timer = cmpTimer.SetInterval(this.entity, IID_Upgrade, "UpgradeProgress", 0, UPGRADING_PROGRESS_INTERVAL, {"upgrading": Template});
+    }
+    else
+        this.UpgradeProgress();
+
+    return true;
+};
+
+Upgrade.prototype.CancelUpgrade = function()
+{
+    if (this.IsUpgrading() === false)
+        return;
+
+    var cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+    var cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(this.owner), IID_Player);
+    if (cmpPlayer)
+    {
+        var costs = this.GetResourceCosts(this.upgrading);
+        cmpPlayer.AddResources(costs);
+    }
+
+    this.ChangeUpgradedEntityCount(-1);
+
+    this.upgrading = false;
+    this.CancelTimer();
+    this.SetElapsedTime(0);
+};
+
+Upgrade.prototype.GetUpgradeTime = function(Template)
+{
+    var template = this.upgrading || Template;
+    var choice = this.upgradeTemplates[template];
+    if (!choice)
+        return undefined;
+    return this.template[choice].Time ? ApplyValueModificationsToEntity("Upgrade/Time", +this.template[choice].Time, this.entity) : 0;
+};
+
+Upgrade.prototype.GetElapsedTime = function()
+{
+    return this.elapsedTime;
+};
+
+Upgrade.prototype.GetProgress = function()
+{
+    // Hopefully undefined and 0 are the only thing that would trigger that.
+    if (!this.IsUpgrading())
+        return undefined;
+    return this.GetUpgradeTime() == 0 ? 1 : this.elapsedTime / this.GetUpgradeTime();
+};
+
+Upgrade.prototype.SetElapsedTime = function(time)
+{
+    this.elapsedTime = time;
+};
+
+Upgrade.prototype.UpgradeProgress = function(data, lateness)
+{
+    if (this.elapsedTime < this.GetUpgradeTime())
+    {
+        this.SetElapsedTime(this.GetElapsedTime() + UPGRADING_PROGRESS_INTERVAL + lateness);
+        return;
+    }
+
+    this.CancelTimer();
+
+    var newEntity = ChangeEntityTemplate(this.entity, this.upgrading);
+
+    // Play notification sound
+    if (newEntity)
+        PlaySound("upgraded", newEntity);
+};
+
+Engine.RegisterComponentType(IID_Upgrade, "Upgrade", Upgrade);

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

@@ +1 @@
+Engine.RegisterInterface("Upgrade");

binaries/data/mods/public/simulation/helpers/Commands.js

@@ -551 +551 @@
         }
     },
 
-    "wall-to-gate": function(player, cmd, data)
-    {
-        for each (var ent in data.entities)
-        {
-            TryTransformWallToGate(ent, data.cmpPlayer, cmd.template);
-        }
-    },
-
     "lock-gate": function(player, cmd, data)
     {
         for each (var ent in data.entities)
@@ -642 +634 @@
             }
         }
     },
+
+    "upgrade": function(player, cmd, data)
+    {
+        for each (var ent in data.entities)
+        {
+            var cmpUpgrade = Engine.QueryInterface(ent, IID_Upgrade);
+
+            var templateName = cmd.template;
+
+            if (!cmpUpgrade || !cmpUpgrade.CanUpgradeTo(templateName))
+                continue;
+
+            if (cmpUpgrade.CheckPlacementRestrictions(templateName) && !CheckObstructionsForTemplateChange(ent, templateName))
+            {
+                var notification = {"players": [data.cmpPlayer.GetPlayerID()], "message": "Cannot upgrade as distance requirements are not verified or terrain is obstructed." };
+                var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+                cmpGUIInterface.PushNotification(notification);
+                continue;
+            }
+
+            if (!CheckGarrisonedCanChangeTemplate(ent, templateName))
+            {
+                var notification = {"players": [data.cmpPlayer.GetPlayerID()], "message": "Cannot upgrade a garrisoned entity." };
+                var cmpGUIInterface = Engine.QueryInterface(SYSTEM_ENTITY, IID_GuiInterface);
+                cmpGUIInterface.PushNotification(notification);
+                continue;
+            }
+
+            // Check entity limits
+            var cmpTempMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+            var template = cmpTempMan.GetTemplate(templateName);
+            var cmpEntityLimits = QueryPlayerIDInterface(player, IID_EntityLimits);
+            if ((template.TrainingRestrictions && !cmpEntityLimits.AllowedToTrain(template.TrainingRestrictions.Category,1))
+                || (template.BuildRestrictions && !cmpEntityLimits.AllowedToBuild(template.BuildRestrictions.Category)))
+            {
+                if (g_DebugCommands)
+                    warn("Invalid command: build limits check failed for player "+player+": "+uneval(cmd));
+                continue;
+            }
+
+            var cmpTechnologyManager = QueryOwnerInterface(ent, IID_TechnologyManager);
+            if (cmpUpgrade.GetRequiredTechnology() && !cmpTechnologyManager.IsTechnologyResearched(cmpUpgrade.GetRequiredTechnology()))
+            {
+                if (g_DebugCommands)
+                    warn("Invalid command: upgrading requires unresearched technology: " + uneval(cmd));
+                continue;
+            }
+
+            cmpUpgrade.Upgrade(templateName, data.cmpPlayer);
+        }
+    },
+
+    "cancel-upgrade": function(player, cmd, data)
+    {
+        for each (var ent in data.entities)
+        {
+            var cmpUpgrade = Engine.QueryInterface(ent, IID_Upgrade);
+
+            if (!cmpUpgrade)
+                continue
+
+            cmpUpgrade.CancelUpgrade(data.cmpPlayer);
+        }
+    },
+
     "dialog-answer": function(player, cmd, data)
     {
         // Currently nothing. Triggers can read it anyway, and send this
@@ -1512 +1569 @@
     return entities.filter(function(ent) { return CanControlUnitOrIsAlly(ent, player, controlAll);} );
 }
 
-/**
- * Try to transform a wall to a gate 
- */
-function TryTransformWallToGate(ent, cmpPlayer, template)
-{
-    var cmpIdentity = Engine.QueryInterface(ent, IID_Identity);
-    if (!cmpIdentity)
-        return;
-
-    // Check if this is a valid long wall segment
-    if (!cmpIdentity.HasClass("LongWall"))
-    {
-        if (g_DebugCommands)
-            warn("Invalid command: invalid wall conversion to gate for player "+player+": "+uneval(cmd));
-        return;
-    }
-
-    var civ = cmpIdentity.GetCiv();
-    var gate = Engine.AddEntity(template);
-
-    var cmpCost = Engine.QueryInterface(gate, IID_Cost);
-    if (!cmpPlayer.TrySubtractResources(cmpCost.GetResourceCosts()))
-    {
-        if (g_DebugCommands)
-            warn("Invalid command: convert gate cost check failed for player "+player+": "+uneval(cmd));
-
-        Engine.DestroyEntity(gate);
-        return;
-    }
-
-    ReplaceBuildingWith(ent, gate);
-}
-
-/**
- * Unconditionally replace a building with another one
- */
-function ReplaceBuildingWith(ent, building)
-{
-    // Move the building to the right place
-    var cmpPosition = Engine.QueryInterface(ent, IID_Position);
-    var cmpBuildingPosition = Engine.QueryInterface(building, IID_Position);
-    var pos = cmpPosition.GetPosition2D();
-    cmpBuildingPosition.JumpTo(pos.x, pos.y);
-    var rot = cmpPosition.GetRotation();
-    cmpBuildingPosition.SetYRotation(rot.y);
-    cmpBuildingPosition.SetXZRotation(rot.x, rot.z);
-
-    // Copy ownership
-    var cmpOwnership = Engine.QueryInterface(ent, IID_Ownership);
-    var cmpBuildingOwnership = Engine.QueryInterface(building, IID_Ownership);
-    cmpBuildingOwnership.SetOwner(cmpOwnership.GetOwner());
-
-    // Copy control groups
-    var cmpObstruction = Engine.QueryInterface(ent, IID_Obstruction);
-    var cmpBuildingObstruction = Engine.QueryInterface(building, IID_Obstruction);
-    cmpBuildingObstruction.SetControlGroup(cmpObstruction.GetControlGroup());
-    cmpBuildingObstruction.SetControlGroup2(cmpObstruction.GetControlGroup2());
-
-    // Copy health level from the old entity to the new
-    var cmpHealth = Engine.QueryInterface(ent, IID_Health);
-    var cmpBuildingHealth = Engine.QueryInterface(building, IID_Health);
-    var healthFraction = Math.max(0, Math.min(1, cmpHealth.GetHitpoints() / cmpHealth.GetMaxHitpoints()));
-    var buildingHitpoints = Math.round(cmpBuildingHealth.GetMaxHitpoints() * healthFraction);
-    cmpBuildingHealth.SetHitpoints(buildingHitpoints);
-
-    PlaySound("constructed", building);
-
-    Engine.PostMessage(ent, MT_ConstructionFinished,
-        { "entity": ent, "newentity": building });
-    Engine.BroadcastMessage(MT_EntityRenamed, { entity: ent, newentity: building });
-
-    Engine.DestroyEntity(ent);
-}
-
 Engine.RegisterGlobal("GetFormationRequirements", GetFormationRequirements);
 Engine.RegisterGlobal("CanMoveEntsIntoFormation", CanMoveEntsIntoFormation);
 Engine.RegisterGlobal("GetDockAngle", GetDockAngle);

binaries/data/mods/public/simulation/helpers/Transform.js

@@ +1 @@
+// Helper functions to change an entity's template and check if the transformation is possible
+
+// returns the ID of the new entity or false.
+var ChangeEntityTemplate = function(oldEntityID, newTemplate)
+{
+    // Done un/packing, copy our parameters to the final entity
+    var newEntity = Engine.AddEntity(newTemplate);
+    if (newEntity == INVALID_ENTITY)
+    {
+        // Error (e.g. invalid template names)
+        error("Transform.js: Error replacing entity " + oldEntity + " for a '" + newTemplate + "'");
+        return false;
+    }
+
+    var cmpPosition = Engine.QueryInterface(oldEntityID, IID_Position);
+    var cmpNewPosition = Engine.QueryInterface(newEntity, IID_Position);
+    if (cmpPosition && cmpNewPosition)
+    {
+        if (cmpPosition.IsInWorld())
+        {
+            var pos = cmpPosition.GetPosition2D();
+            cmpNewPosition.JumpTo(pos.x, pos.y);
+        }
+        var rot = cmpPosition.GetRotation();
+        cmpNewPosition.SetYRotation(rot.y);
+        cmpNewPosition.SetXZRotation(rot.x, rot.z);
+        cmpNewPosition.SetHeightOffset(cmpPosition.GetHeightOffset());
+    }
+
+    var cmpOwnership = Engine.QueryInterface(oldEntityID, IID_Ownership);
+    var cmpNewOwnership = Engine.QueryInterface(newEntity, IID_Ownership);
+    if (cmpOwnership && cmpNewOwnership)
+        cmpNewOwnership.SetOwner(cmpOwnership.GetOwner());
+
+    // Copy control groups
+    var cmpObstruction = Engine.QueryInterface(oldEntityID, IID_Obstruction);
+    var cmpNewObstruction = Engine.QueryInterface(newEntity, IID_Obstruction);
+    if (cmpObstruction && cmpNewObstruction)
+    {
+        cmpNewObstruction.SetControlGroup(cmpObstruction.GetControlGroup());
+        cmpNewObstruction.SetControlGroup2(cmpObstruction.GetControlGroup2());
+    }
+
+    // Maintain current health level
+    var cmpHealth = Engine.QueryInterface(oldEntityID, IID_Health);
+    var cmpNewHealth = Engine.QueryInterface(newEntity, IID_Health);
+    if (cmpHealth && cmpNewHealth)
+    {
+        var healthLevel = Math.max(0, Math.min(1, cmpHealth.GetHitpoints() / cmpHealth.GetMaxHitpoints()));
+        cmpNewHealth.SetHitpoints(Math.round(cmpNewHealth.GetMaxHitpoints() * healthLevel));
+    }
+
+    var cmpUnitAI = Engine.QueryInterface(oldEntityID, IID_UnitAI);
+    var cmpNewUnitAI = Engine.QueryInterface(newEntity, IID_UnitAI);
+    if (cmpUnitAI && cmpNewUnitAI)
+    {
+        var pos = cmpUnitAI.GetHeldPosition();
+        if (pos)
+            cmpNewUnitAI.SetHeldPosition(pos.x, pos.z);
+        if (cmpUnitAI.GetStanceName())
+            cmpNewUnitAI.SwitchToStance(cmpUnitAI.GetStanceName());
+        cmpNewUnitAI.AddOrders(cmpUnitAI.GetOrders());
+        cmpNewUnitAI.SetGuardOf(cmpUnitAI.IsGuardOf());
+    }
+
+    // Maintain the list of guards
+    var cmpGuard = Engine.QueryInterface(oldEntityID, IID_Guard);
+    var cmpNewGuard = Engine.QueryInterface(newEntity, IID_Guard);
+    if (cmpGuard && cmpNewGuard)
+        cmpNewGuard.SetEntities(cmpGuard.GetEntities());
+
+    TransferGarrisonedUnits(oldEntityID, newEntity);
+
+    Engine.BroadcastMessage(MT_EntityRenamed, { entity: oldEntityID, newentity: newEntity });
+
+    // Destroy current entity
+    Engine.DestroyEntity(oldEntityID);
+
+    return newEntity;
+};
+
+var CheckGarrisonedCanChangeTemplate = function(entityID, Template)
+{
+    var cmpPosition = Engine.QueryInterface(entityID, IID_Position);
+    var unitAI = Engine.QueryInterface(entityID, IID_UnitAI);
+    if (cmpPosition && !cmpPosition.IsInWorld() && unitAI && unitAI.IsGarrisoned())
+    {
+        // We're a garrisoned unit, assume impossibility as I've been unable to find a way to get the holder ID.
+        return false;
+    }
+    return true;
+}
+
+var CheckObstructionsForTemplateChange = function(entityID, Template) 
+{
+    var previewEntity = Engine.AddEntity("preview|"+Template); 
+
+    if (previewEntity == INVALID_ENTITY)
+        return false;   // no need to destroy since it was invalid in the first place.
+
+    var cmpBuildRestrictions = Engine.QueryInterface(previewEntity, IID_BuildRestrictions); 
+    var cmpPosition = Engine.QueryInterface(entityID, IID_Position);
+    var cmpOwnership = Engine.QueryInterface(entityID, IID_Ownership); 
+
+    if (!cmpBuildRestrictions || !cmpPosition || !cmpOwnership) 
+    {
+        Engine.DestroyEntity(previewEntity);
+        return true;
+    }
+
+    var canTransform = true;
+
+    var pos = cmpPosition.GetPosition2D(); 
+    var angle = cmpPosition.GetRotation(); 
+    // move us away to avoid our obstruction blocking the upgrade.
+    cmpPosition.MoveOutOfWorld(); 
+
+    var cmpNewPosition = Engine.QueryInterface(previewEntity, IID_Position); 
+    cmpNewPosition.JumpTo(pos.x, pos.y); 
+    cmpNewPosition.SetYRotation(angle.y); 
+
+    var cmpNewOwnership = Engine.QueryInterface(previewEntity, IID_Ownership);
+    cmpNewOwnership.SetOwner(cmpOwnership.GetOwner()); 
+
+    var checkPlacement = cmpBuildRestrictions.CheckPlacement(); 
+    if (checkPlacement && !checkPlacement.success)
+        canTransform = false;
+
+    var cmpTempMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_TemplateManager);
+    var template = cmpTempMan.GetTemplate(cmpTempMan.GetCurrentTemplateName());
+    var newTemplate = cmpTempMan.GetTemplate(Template);
+
+    var obstruction = template.Obstruction;
+
+    // Check if units are blocking our template change
+    if (canTransform && template.Obstruction && newTemplate.Obstruction)
+    {
+        // This only needs to be done if the new template is strictly bigger than the old one
+        // "Obstructions" are annoying to test so just check.
+        if (newTemplate.Obstruction.Obstructions
+            || (template.Obstruction.Static && template.Obstruction.Static.width > newTemplate.Obstruction.Static.width
+                                            && template.Obstruction.Static.depth > newTemplate.Obstruction.Static.depth)
+            || (template.Obstruction.Unit && template.Obstruction.Unit.radius > newTemplate.Obstruction.Unit.radius))
+        {
+            var cmpNewObstruction = Engine.QueryInterface(previewEntity, IID_Obstruction);  
+            if (cmpNewObstruction && cmpNewObstruction.GetBlockMovementFlag())
+            {
+                // Check for units
+                var collisions = cmpNewObstruction.GetEntityCollisions(false, true);
+                if (collisions.length !== 0)
+                    canTransform = false;
+            }
+        }
+    }
+
+    // Move preview entity out of world so it won't interfere with additional calls 
+    //    to this function for entityID on the same sim update. 
+    // Specifically, CheckPlacement() would incorrectly spot and fail on earlier preview entities 
+    //    if those are left in the world. 
+    cmpNewPosition.MoveOutOfWorld();
+    cmpPosition.JumpTo(pos.x, pos.y); 
+    cmpPosition.SetYRotation(angle.y);
+
+    Engine.DestroyEntity(previewEntity);
+    return canTransform;
+};
+
+var TransferGarrisonedUnits = function(oldEntityID, newEntityID)
+{
+    // Transfer garrisoned units if possible, or unload them 
+    var cmpGarrison = Engine.QueryInterface(oldEntityID, IID_GarrisonHolder); 
+    var cmpNewGarrison = Engine.QueryInterface(newEntityID, IID_GarrisonHolder);
+    if (!cmpNewGarrison)
+        return; // nothing to do as the code will by default unload all.
+
+    if (cmpGarrison && cmpGarrison.GetEntities().length > 0) 
+    { 
+        var garrisonedEntities = cmpGarrison.GetEntities().slice();
+        cmpGarrison.UnloadAll(true);
+        for (var j = 0; j < garrisonedEntities.length; ++j)
+        {
+            var cmpUnitAI = Engine.QueryInterface(garrisonedEntities[j], IID_UnitAI);
+            cmpUnitAI.Autogarrison(newEntityID);
+            cmpNewGarrison.Garrison(garrisonedEntities[j]);
+        }
+    }
+}
+
+Engine.RegisterGlobal("ChangeEntityTemplate", ChangeEntityTemplate);
+Engine.RegisterGlobal("CheckGarrisonedCanChangeTemplate", CheckGarrisonedCanChangeTemplate);
+Engine.RegisterGlobal("CheckObstructionsForTemplateChange", CheckObstructionsForTemplateChange);
+ No newline at end of file

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

@@ -51 +51 @@
   <Identity>
     <Classes datatype="tokens">LongWall</Classes>
     <Tooltip>Long wall segments can be converted to gates.</Tooltip>
-    <GateConversionTooltip>Convert Stone Wall into City Gate</GateConversionTooltip>
   </Identity>
+  <Upgrade>
+    <Gate>
+      <Entity>structures/{civ}_wall_gate</Entity>
+      <Tooltip>This will allow you to let units circulate through your fortifications.</Tooltip>
+      <Cost>
+        <stone>60</stone>
+      </Cost>
+      <Time>10000</Time>
+    </Gate>
+  </Upgrade>
 </Entity>

binaries/data/mods/public/simulation/templates/other/palisades_rocks_long.xml

@@ -21 +21 @@
     <SelectionGroupName>other/wallset_palisade</SelectionGroupName>
     <SpecificName>Palisade</SpecificName>
     <GenericName>Wooden Wall</GenericName>
-    <GateConversionTooltip>Convert Wooden Wall into Wooden Gate</GateConversionTooltip>
     <Classes datatype="tokens">-StoneWall Palisade</Classes>
     <History>A cheap, quick defensive structure constructed with sharpened tree trunks</History>
     <Icon>gaia/special_palisade.png</Icon>
@@ -41 +40 @@
   <WallPiece>
     <Length>11.0</Length>
   </WallPiece>
+  <Upgrade>
+    <Gate>
+      <Entity>other/palisades_rocks_gate</Entity>
+      <Cost>
+        <stone>0</stone>
+        <wood>20</wood>
+      </Cost>
+      <Time>5000</Time>
+    </Gate>
+  </Upgrade>
 </Entity>

binaries/data/mods/public/simulation/templates/structures/rome_siege_wall_long.xml

@@ -55 +55 @@
     </Classes>
     <Icon>structures/palisade.png</Icon>
     <Tooltip>A wooden and turf palisade buildable in enemy and neutral territories.</Tooltip>
-    <GateConversionTooltip>Convert Siege Wall into Siege Wall Gate</GateConversionTooltip>
     <History>Quick building, but expensive wooden and earthen walls used to surround and siege an enemy town or fortified position. The most famous examples are the Roman sieges of the Iberian stronghold of Numantia and the Gallic stronghold of Alesia.</History>
   </Identity>
   <Obstruction>