Ticket #3177: camouflaging.patch

binaries/data/config/default.cfg

@@ -280 +280 @@
 garrison = Ctrl              ; Modifier to garrison when clicking on building
 autorallypoint = Ctrl        ; Modifier to set the rally point on the building itself
 guard = "G"                  ; Modifier to escort/guard when clicking on unit/building
+camouflage = Space           ; Toggle camouflaging
 queue = Shift                ; Modifier to queue unit orders instead of replacing
 batchtrain = Shift           ; Modifier to train units in batches
 massbarter = Shift           ; Modifier to barter bunch of resources

binaries/data/mods/public/gui/session/hotkeys/misc.xml

@@ -58 +58 @@
         <action on="Press">stopUnits(g_Selection.toList());</action>
     </object>
 
+    <!-- Toggle camouflaging for selected units -->
+    <object hotkey="session.camouflage">
+        <action on="Press">toggleCamouflaging(g_Selection.toList());</action>
+    </object>
+
     <!-- Find idle warrior - TODO: Potentially move this to own UI button? -->
     <object hotkey="selection.idlewarrior">
         <action on="Press">findIdleUnit(["Hero", "Champion", "CitizenSoldier", "Siege", "Warship", "Dog"]);</action>

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

@@ -1753 +1753 @@
     Engine.PostNetworkCommand({ "type": "stop", "entities": entities, "queued": false });
 }
 
+function toggleCamouflaging(entities)
+{
+    Engine.PostNetworkCommand({ "type": "camouflage", "entities": entities, "queued": false });
+}
+
 function unload(garrisonHolder, entities)
 {
     if (Engine.HotkeyIsPressed("session.unloadtype"))

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

@@ -86 +86 @@
         Engine.GetGUIObjectByName("healthSection").hidden = true;
     }
 
-    // TODO: Stamina
-    var player = Engine.GetPlayerID();
+    // Stamina
+    let player = Engine.GetPlayerID();
     if (entState.stamina && (entState.player == player || g_DevSettings.controlAll))
+    {
+        let unitStaminaBar = Engine.GetGUIObjectByName("staminaBar");
+        let staminaSize = unitStaminaBar.size;
+        staminaSize.rright = 100*Math.max(0, Math.min(1, entState.stamina.stamina / entState.stamina.maxStamina));
+        unitStaminaBar.size = staminaSize;
+
+        Engine.GetGUIObjectByName("staminaStats").caption = sprintf(translate("%(stamina)s / %(maxStamina)s"), {
+            stamina: Math.ceil(entState.stamina.stamina),
+            maxStamina: entState.stamina.maxStamina
+        });
         Engine.GetGUIObjectByName("staminaSection").hidden = false;
+    }
     else
         Engine.GetGUIObjectByName("staminaSection").hidden = true;
 
@@ -250 +261 @@
     else
         Engine.GetGUIObjectByName("attackAndArmorStats").tooltip = armorString;
 
+    // Camouflaging
+    if (entState.stealth && entState.player == player)
+    {
+        let camouflaging = Engine.GetGUIObjectByName("camouflaging");
+        camouflaging.hidden = false;
+        camouflaging.sprite = "stretched:session/icons/camouflage" + 
+            (entState.stealth.activated ? "d" : "_" + (entState.stealth.requested ? "on" : "off")) + ".png";
+        camouflaging.tooltip = "[font=\"sans-bold-13\"]" + translate("Camouflage:") + " [/font]" + 
+            (entState.stealth.requested ? translate("On") : translate("Off")) + "\n" +
+            translate("Default hotkey for toggling camouflage is Space");
+        if (entState.stealth.requested && !entState.stealth.activated)
+            camouflaging.tooltip += "\n[font=\"sans-bold-13\"]" + translate("You must be close to a tree!") + "[/font]";
+    }
+    else
+        Engine.GetGUIObjectByName("camouflaging").hidden = true;
+
     // Icon Tooltip
     var iconTooltip = "";
 
@@ -291 +318 @@
     var averageHealth = 0;
     var maxHealth = 0;
 
+    let averageStamina = 0;
+    let maxStamina = 0;
+
     for (var i = 0; i < selection.length; i++)
     {
         var entState = GetEntityState(selection[i])
@@ -301 +331 @@
                 averageHealth += entState.hitpoints;
                 maxHealth += entState.maxHitpoints;
             }
+            if (entState.stamina)
+            {
+                averageStamina += entState.stamina.stamina;
+                maxStamina += entState.stamina.maxStamina;
+            }
         }
     }
 
@@ -321 +356 @@
     {
         Engine.GetGUIObjectByName("healthMultiple").hidden = true;
     }
-    
-    // TODO: Stamina
-    // Engine.GetGUIObjectByName("staminaBarMultiple");
 
+    if (averageStamina > 0)
+    {
+        let unitStaminaBar = Engine.GetGUIObjectByName("staminaBarMultiple");
+        let staminaSize = unitStaminaBar.size;  
+        staminaSize.rtop = 100-100*Math.max(0, Math.min(1, averageStamina / maxStamina));
+        unitStaminaBar.size = staminaSize;
+
+        let staminaLabel = "[font=\"sans-bold-13\"]" + translate("Stamina:") + "[/font]"
+        let stamina = sprintf(translate("%(label)s %(current)s / %(max)s"), { label: staminaLabel, current: averageStamina, max: maxStamina });
+        let staminaMultiple = Engine.GetGUIObjectByName("staminaMultiple");
+        staminaMultiple.tooltip = stamina;
+        staminaMultiple.hidden = false;
+    }
+    else
+    {
+        Engine.GetGUIObjectByName("staminaMultiple").hidden = true;
+    }
+
     Engine.GetGUIObjectByName("numberOfUnits").caption = selection.length;
 
     // Unhide Details Area

binaries/data/mods/public/gui/session/selection_panels_middle/single_details_area.xml

@@ -53 +53 @@
             <translatableAttribute id="tooltip">Attack and Armor</translatableAttribute>
         </object>
 
+        <!-- Camouflaging -->
+        <object size="120 -2 156 34" name="camouflaging" type="image" sprite="stretched:session/icons/camouflage_off.png" tooltip_style="sessionToolTip">
+            <translatableAttribute id="tooltip">Camouflaging</translatableAttribute>
+        </object>
+
         <!-- Resource carrying icon/counter -->
         <!-- Used also for number of gatherers/builders -->
         <object size="100%-98 -2 100%-28 34" type="text" name="resourceCarryingText" style="CarryingTextRight"/>

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

@@ -225 +225 @@
         "rallyPoint": null,
         "resourceCarrying": null,
         "rotation": null,
+        "stamina": null,
+        "stealth": null,
         "trader": null,
         "unitAI": null,
         "visibility": null,
@@ -395 +397 @@
         };
     }
 
+    var cmpStamina = Engine.QueryInterface(ent, IID_Stamina);
+    if (cmpStamina)
+    {
+        ret.stamina = {
+            "stamina": cmpStamina.GetStamina(),
+            "maxStamina": cmpStamina.GetMaxStamina(),
+        };
+    }
+
+    var cmpStealth = Engine.QueryInterface(ent, IID_Stealth);
+    if (cmpStealth)
+    {
+        ret.stealth = {
+            "requested": cmpStealth.IsRequested(),
+            "activated": cmpStealth.IsActivated(),
+        };
+    }
+
     var cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
     ret.visibility = cmpRangeManager.GetLosVisibility(ent, player);
 

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

@@ -1 +1 @@
 Engine.RegisterInterface("Stamina");
+
+// Message of the form { "from": 100, "to", 90 },
+// sent whenever stamina changes.
+Engine.RegisterMessageType("StaminaChanged");

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

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

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

@@ -1 +1 @@
 function Stamina() {}
 
 Stamina.prototype.Schema =
-    "<element name='Max' a:help='Maximum stamina (msecs of running)'>" +
-        "<data type='positiveInteger'/>" +
-    "</element>";
+    "<element name='Max' a:help='Maximum stamina'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>" +
+    "<element name='RegenRate' a:help='Stamina regeneration rate per second.'>" +
+        "<ref name='nonNegativeDecimal'/>" +
+    "</element>" +
+    "<optional>" +
+        "<element name='Initial' a:help='Initial stamina. Default if unspecified is equal to 0'>" +
+            "<ref name='nonNegativeDecimal'/>" +
+        "</element>" +
+    "</optional>";
 
-/*
- * TODO: this all needs to be designed and implemented
- */
+Stamina.prototype.Init = function()
+{
+    this.maxStamina = +this.template.Max;
+    this.regenRate = +this.template.RegenRate;
 
+    this.stamina = +(this.template.Initial || 0);
+
+    this.CheckRegenTimer();
+};
+
+Stamina.prototype.GetStamina = function()
+{
+    return this.stamina;
+};
+
+Stamina.prototype.GetMaxStamina = function()
+{
+    return this.maxStamina;
+};
+
+Stamina.prototype.CheckRegenTimer = function()
+{
+    if ((this.stamina == this.maxStamina && this.regenRate > 0) || (this.stamina == 0 && this.regenRate < 0))
+    {
+        // We don't need to regenerate stamina
+        if (this.regenTimer)
+        {
+            var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+            cmpTimer.CancelTimer(this.regenTimer);
+            this.regenTimer = undefined;
+        }
+        return;
+    }
+
+    // We need to regenerate, enable a timer if one doesn't exist
+    if (this.regenTimer)
+        return;
+
+    var cmpTimer = Engine.QueryInterface(SYSTEM_ENTITY, IID_Timer);
+    this.regenTimer = cmpTimer.SetInterval(this.entity, IID_Stamina, "UpdateStamina", 1000, 1000, null);
+};
+
+Stamina.prototype.ToggleStaminaConsumer = function(enabled, costRate)
+{
+    if (costRate >= 0)
+    {
+        warn("Activated stamina consumer with wrong cost");
+        return;
+    }
+
+    if (enabled)
+    {
+        if (this.regenRate > 0)
+            this.regenRate = 0;
+        this.regenRate += costRate;
+    }
+    else
+    {
+        this.regenRate -= costRate;
+        if (this.regenRate >= 0)
+            this.regenRate = +this.template.RegenRate;
+    }
+    this.CheckRegenTimer();
+};
+
+Stamina.prototype.UpdateStamina = function()
+{
+    if (this.regenRate == 0)
+        return;
+
+    let oldStamina = this.stamina;
+    this.stamina += this.regenRate;
+    if (this.stamina > this.maxStamina)
+        this.stamina = this.maxStamina;
+
+    Engine.PostMessage(this.entity, MT_StaminaChanged, { "from": oldStamina, "to": this.stamina });
+};
+
+Stamina.prototype.OnStaminaChanged = function(msg)
+{
+    this.CheckRegenTimer();
+};
+
 Engine.RegisterComponentType(IID_Stamina, "Stamina", Stamina);

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

@@ +1 @@
+function Stealth() {}
+
+Stealth.prototype.Schema =  
+    "<empty/>";
+
+Stealth.prototype.Init = function() 
+{
+    this.requested = false; // Whether the button is pushed
+    this.activated = false; // Whether we are actually camouflaged
+    this.staminaCostRate = -5.0;
+};
+
+Stealth.prototype.IsActivated = function() 
+{
+    return this.activated;
+};
+
+Stealth.prototype.IsRequested = function() 
+{
+    return this.requested;
+};
+
+Stealth.prototype.Request = function(enabled)
+{
+    this.requested = enabled;
+    if (enabled)
+    {
+        if (!this.IsTreeNear())
+            return;
+    }
+    this.Toggle(enabled);
+};
+
+/**
+ * We assume here that a tree is near.
+ */
+Stealth.prototype.Toggle = function(enabled)
+{
+    if ((enabled && this.activated) || (!enabled && !this.activated))
+        return;
+
+    let cmpStamina = Engine.QueryInterface(this.entity, IID_Stamina);
+    if (!cmpStamina)
+        return;
+
+    if (enabled && cmpStamina.stamina == 0)
+        return;
+
+    let cmpVisibility = Engine.QueryInterface(this.entity, IID_Visibility);
+    if (cmpVisibility)
+        cmpVisibility.SetActivated(enabled);
+
+    cmpStamina.ToggleStaminaConsumer(enabled, this.staminaCostRate);
+    this.activated = enabled;   
+};
+
+Stealth.prototype.IsTreeNear = function()
+{
+    let cmpRangeManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
+    let filter = function(id)
+    {
+        let cmpIdentity = Engine.QueryInterface(id, IID_Identity);
+        return cmpIdentity.GetGenericName() == "Tree";
+    }
+
+    let dist = 5;
+    let nearEnts = cmpRangeManager.ExecuteQuery(this.entity, 0, dist, [0], IID_ResourceSupply).filter(filter);
+
+    return nearEnts.length > 0;     
+};
+
+Stealth.prototype.OnPositionChanged = function(msg)
+{
+    if (msg.entity != this.entity)
+        return;
+
+    if (this.requested)
+        this.Toggle(this.IsTreeNear());
+};
+
+Stealth.prototype.OnStaminaChanged = function(msg)
+{
+    // When we are out of stamina, stop camouflaging and regenerate
+    if (msg.to == 0)
+    {
+        this.Request(false);
+    }
+};
+
+Engine.RegisterComponentType(IID_Stealth, "Stealth", Stealth);

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

@@ -67 +67 @@
         return VIS_HIDDEN;
     }
 
+    let cmpStealth = Engine.QueryInterface(this.entity, IID_Stealth);
+    if (cmpStealth) // No need to check the state, if the scriptedVisibility flag is set then Stealth is activated
+    {
+        let cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
+        if (!cmpOwnership)
+            return VIS_VISIBLE;
+
+        let cmpPlayerManager = Engine.QueryInterface(SYSTEM_ENTITY, IID_PlayerManager);
+        if (player >= cmpPlayerManager.GetNumPlayers())
+            return VIS_HIDDEN;
+        let cmpPlayer = Engine.QueryInterface(cmpPlayerManager.GetPlayerByID(cmpOwnership.GetOwner()), IID_Player);
+        if (cmpPlayer && cmpPlayer.IsMutualAlly(player))
+            return VIS_VISIBLE;
+
+        return VIS_HIDDEN;
+    }
+
     return VIS_VISIBLE;
 };
 

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

@@ -432 +432 @@
         });
     },
 
+    "camouflage": function(player, cmd, data)
+    {
+        for (let ent of data.entities)
+        {
+            let cmpOwnership = Engine.QueryInterface(ent, IID_Ownership);
+            if (!cmpOwnership || cmpOwnership.GetOwner() != player)
+                continue;
+            let cmpStealth = Engine.QueryInterface(ent, IID_Stealth);
+            if (cmpStealth)
+                cmpStealth.Request(!cmpStealth.IsRequested());
+        }
+    },
+
     "unload": function(player, cmd, data)
     {
         // Verify that the building can be controlled by the player or is mutualAlly

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

@@ -88 +88 @@
   </Sound>
   <Stamina>
     <Max>2000</Max>
+    <RegenRate>20</RegenRate>
+    <Initial>1000</Initial>
   </Stamina>
   <StatusBars>
     <HeightOffset>6.5</HeightOffset>

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

@@ -58 +58 @@
   </Sound>
   <Stamina>
     <Max>2500</Max>
+    <RegenRate>20</RegenRate>
+    <Initial>1000</Initial>
   </Stamina>
   <StatusBars>
     <HeightOffset>6.5</HeightOffset>

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

@@ -57 +57 @@
   </Sound>
   <Stamina>
     <Max>2500</Max>
+    <RegenRate>20</RegenRate>
+    <Initial>1000</Initial>
   </Stamina>
   <StatusBars>
     <HeightOffset>6.5</HeightOffset>

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

@@ -45 +45 @@
   </Sound>
   <Stamina>
     <Max>1500</Max>
+    <RegenRate>20</RegenRate>
   </Stamina>
   <UnitMotion>
     <WalkSpeed>8.5</WalkSpeed>

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

@@ -46 +46 @@
   </Sound>
   <Stamina>
     <Max>2500</Max>
+    <RegenRate>20</RegenRate>
+    <Initial>1000</Initial>
   </Stamina>
   <StatusBars>
     <HeightOffset>6.5</HeightOffset>

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

@@ -33 +33 @@
     <wood>10</wood>
     <metal>10</metal>
   </Loot>
-  <Stamina>
-    <Max>1200</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>8.5</WalkSpeed>
     <Run>

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

@@ -114 +114 @@
   </Sound>
   <Stamina>
     <Max>1000</Max>
+    <RegenRate>15</RegenRate>
   </Stamina>
   <UnitMotion>
     <WalkSpeed>9</WalkSpeed>

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

@@ -94 +94 @@
   </Sound>
   <Stamina>
     <Max>500</Max>
+    <RegenRate>5</RegenRate>
   </Stamina>
   <UnitAI>
     <AlertReactiveLevel>1</AlertReactiveLevel>

binaries/data/mods/public/simulation/templates/units/athen_infantry_marine_archer_a.xml

@@ -23 +23 @@
   <ResourceGatherer>
     <BaseSpeed>0.75</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>700</Max>
-  </Stamina>
   <VisualActor>
     <Actor>units/macedonians/infantry_archer_a.xml</Actor>
   </VisualActor>

binaries/data/mods/public/simulation/templates/units/athen_infantry_marine_archer_e.xml

@@ -21 +21 @@
   <ResourceGatherer>
     <BaseSpeed>0.5</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>690</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>8</WalkSpeed>
     <Run>

binaries/data/mods/public/simulation/templates/units/cart_infantry_archer_a.xml

@@ -23 +23 @@
   <ResourceGatherer>
     <BaseSpeed>0.75</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>700</Max>
-  </Stamina>
   <VisualActor>
     <Actor>units/carthaginians/infantry_archer_a.xml</Actor>
   </VisualActor>

binaries/data/mods/public/simulation/templates/units/cart_infantry_archer_e.xml

@@ -21 +21 @@
   <ResourceGatherer>
     <BaseSpeed>0.5</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>690</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>8</WalkSpeed>
     <Run>

binaries/data/mods/public/simulation/templates/units/iber_infantry_swordsman_b.xml

@@ -15 +15 @@
   <Promotion>
     <Entity>units/iber_infantry_swordsman_a</Entity>
   </Promotion>
+  <Stealth/>
   <VisualActor>
     <Actor>units/iberians/infantry_swordsman_b.xml</Actor>
   </VisualActor>

binaries/data/mods/public/simulation/templates/units/mace_infantry_archer_a.xml

@@ -23 +23 @@
   <ResourceGatherer>
     <BaseSpeed>0.75</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>700</Max>
-  </Stamina>
   <VisualActor>
     <Actor>units/macedonians/infantry_archer_a.xml</Actor>
   </VisualActor>

binaries/data/mods/public/simulation/templates/units/mace_infantry_archer_e.xml

@@ -21 +21 @@
   <ResourceGatherer>
     <BaseSpeed>0.5</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>690</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>8</WalkSpeed>
     <Run>

binaries/data/mods/public/simulation/templates/units/ptol_infantry_archer_a.xml

@@ -23 +23 @@
   <ResourceGatherer>
     <BaseSpeed>0.75</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>700</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>11</WalkSpeed>
     <Run>

binaries/data/mods/public/simulation/templates/units/ptol_infantry_archer_e.xml

@@ -21 +21 @@
   <ResourceGatherer>
     <BaseSpeed>0.5</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>690</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>10.5</WalkSpeed>
     <Run>

binaries/data/mods/public/simulation/templates/units/sele_infantry_archer_merc_a.xml

@@ -23 +23 @@
   <ResourceGatherer>
     <BaseSpeed>0.75</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>700</Max>
-  </Stamina>
   <VisualActor>
     <Actor>units/macedonians/infantry_archer_a.xml</Actor>
   </VisualActor>

binaries/data/mods/public/simulation/templates/units/sele_infantry_archer_merc_e.xml

@@ -21 +21 @@
   <ResourceGatherer>
     <BaseSpeed>0.5</BaseSpeed>
   </ResourceGatherer>
-  <Stamina>
-    <Max>690</Max>
-  </Stamina>
   <UnitMotion>
     <WalkSpeed>8</WalkSpeed>
     <Run>

source/simulation2/components/CCmpRangeManager.cpp

@@ -1425 +1425 @@
         EntityMap<EntityData>::iterator it = m_EntityData.find(ent);
         if (it != m_EntityData.end())
             it->second.scriptedVisibility = status ? 1 : 0;
+        RequestVisibilityUpdate(ent);
     }
 
     ELosVisibility ComputeLosVisibility(CEntityHandle ent, player_id_t player)