Ticket #1802: hero_button.3.patch

Index: binaries/data/mods/public/gui/common/global.xml

===================================================================

--- binaries/data/mods/public/gui/common/global.xml (revision 13276)

+++ binaries/data/mods/public/gui/common/global.xml (working copy)

@@ -26,7 +26,7 @@

            sprite="colour: 0 0 0 200"

            font="mono-stroke-10"

            textcolor="white"

-           size="5 35 80 55"

+           size="100%-80 70 100%-10 90"

            z="199"

        >

            <action on="Tick"><![CDATA[

Index: binaries/data/mods/public/gui/session/session.js

===================================================================

--- binaries/data/mods/public/gui/session/session.js    (revision 13276)

+++ binaries/data/mods/public/gui/session/session.js    (working copy)

@@ -369,6 +369,7 @@

    if (g_ShowAllStatusBars)

        recalculateStatusBarDisplay();



+   updateHero(simState);

    updateGroups();

    updateDebug(simState);

    updatePlayerDisplay(simState);

@@ -383,6 +384,48 @@

        global.music.setState(global.music.states[battleState]);

 }



+function updateHero(simState)

+{

+   var playerState = simState.players[Engine.GetPlayerID()];

+

+   if (playerState.heroes.length > 0)

+   {

+       var heroImage = getGUIObjectByName("unitHeroImage");

+       var heroState = Engine.GuiInterfaceCall("GetEntityState", playerState.heroes[0]);

+       var template = GetTemplateData(heroState.template);

+       heroImage.sprite = "stretched:session/portraits/" + template.icon;

+

+       var heroButton = getGUIObjectByName("unitHeroButton");

+       heroButton.onpress = (function(e) { return function() { g_Selection.reset(); g_Selection.addList([e]); } })(playerState.heroes[0]);

+       heroButton.ondoublepress = (function(e) { return function() { selectAndMoveTo(e) }; })(playerState.heroes[0]);

+       heroButton.hidden = false;

+       

+       // Setup tooltip

+

+       var name = "[font=\"serif-bold-16\"]" + template.name.specific + "[/font] ";

+       var health = "[font=\"serif-bold-13\"]Health:[/font] " + heroState.hitpoints + "/" + heroState.maxHitpoints;

+       

+       var type = "";

+       if (heroState.attack)

+           type = heroState.attack.type + " ";

+       var attack = "[font=\"serif-bold-13\"]" + type + "Attack:[/font] " + damageTypeDetails(heroState.attack);

+       // Show max attack range if ranged attack, also convert to tiles (4m per tile)

+       if (heroState.attack && heroState.attack.type == "Ranged")

+           attack += ", [font=\"serif-bold-13\"]Range:[/font] " + Math.round(heroState.attack.maxRange/4);

+

+       var armor = "[font=\"serif-bold-13\"]Armor:[/font] " + damageTypeDetails(heroState.armour);

+       var extra = template.tooltip;

+       

+       heroButton.tooltip = name + "\n" + health + "\n" + attack + "\n" + armor + "\n" + extra;

+   }

+   else

+   {   

+       var heroButton = getGUIObjectByName("unitHeroButton");

+       heroButton.hidden = true;

+   }

+

+};

+

 function updateGroups()

 {

    var guiName = "Group";

Index: binaries/data/mods/public/gui/session/session.xml

===================================================================

--- binaries/data/mods/public/gui/session/session.xml   (revision 13327)

+++ binaries/data/mods/public/gui/session/session.xml   (working copy)

@@ -132,11 +218,16 @@

        <action on="Press">addTrainingByPosition(6);</action>
    </object>

-       <!-- Find idle warrior - TODO: Potentially move this to own UI button? -->
+   <!-- Find idle warrior - TODO: Potentially move this to own UI button? -->
    <object hotkey="selection.idlewarrior">
        <action on="Press">findIdleUnit(["Hero", "Champion", "CitizenSoldier", "Siege", "Warship"]);</action>
    </object>

+   <!-- Cycle through living heroes. -->
+   <object hotkey="selection.hero">
+       <action on="Press">cycleHeroes();</action>
+   </object>
+
    <!-- ================================  ================================ -->
    <!-- Developer / Debug items -->
    <!-- ================================  ================================ -->
@@ -666,6 +757,20 @@
    </object>

    <!-- ================================  ================================ -->
+   <!-- Hero Selection -->
+   <!-- ================================  ================================ -->
+   <object
+       name="unitHeroPanel"
+       size="0% 5% 0%+50 5%+50"
+   >
+       <object name="unitHeroButton" size="0 0 50 50" type="button" hidden="false" style="iconButton" 
+           tooltip_style="sessionToolTip" tooltip="Attack and Armor">
+           <object name="unitHeroImage" size="5 5 100%-5 100%-5" type="image" ghost="true"/>
+       </object>
+
+   </object>   
+   
+   <!-- ================================  ================================ -->
    <!-- Unit Selection Groups -->
    <!-- ================================  ================================ -->
    <objectIndex: binaries/data/mods/public/simulation/components/GuiInterface.js
===================================================================
--- binaries/data/mods/public/simulation/components/GuiInterface.js (revision 13276)
+++ binaries/data/mods/public/simulation/components/GuiInterface.js (working copy)
@@ -79,6 +79,7 @@
            "popCount": cmpPlayer.GetPopulationCount(),
            "popLimit": cmpPlayer.GetPopulationLimit(),
            "popMax": cmpPlayer.GetMaxPopulation(),
+           "heroes": cmpPlayer.GetHeroes(),
            "resourceCounts": cmpPlayer.GetResourceCounts(),
            "trainingBlocked": cmpPlayer.IsTrainingBlocked(),
            "state": cmpPlayer.GetState(),
Index: binaries/data/mods/public/simulation/components/Player.js
===================================================================
--- binaries/data/mods/public/simulation/components/Player.js   (revision 13276)
+++ binaries/data/mods/public/simulation/components/Player.js   (working copy)
@@ -19,7 +19,7 @@
        "metal": 300,
        "stone": 300
    };
-
+   
    this.team = -1; // team number of the player, players on the same team will always have ally diplomatic status - also this is useful for team emblems, scoring, etc.
    this.teamsLocked = false;
    this.state = "active"; // game state - one of "active", "defeated", "won"
@@ -32,6 +32,7 @@
    this.isAI = false;
    this.cheatsEnabled = true;
    this.cheatTimeMultiplier = 1;
+   this.heroes = [];
 };

 Player.prototype.SetPlayerID = function(id)
@@ -109,6 +110,11 @@
    return Math.round(ApplyTechModificationsToPlayer("Player/MaxPopulation", this.maxPop, this.entity));
 };

+Player.prototype.GetHeroes = function()
+{
+   return this.heroes;
+};
+
 Player.prototype.IsTrainingBlocked = function()
 {
    return this.trainingBlocked;
@@ -446,10 +452,11 @@
 Player.prototype.OnGlobalOwnershipChanged = function(msg)
 {
    var isConquestCritical = false;
+   var cmpIdentity = Engine.QueryInterface(msg.entity, IID_Identity);
+   
    // Load class list only if we're going to need it
    if (msg.from == this.playerID || msg.to == this.playerID)
    {
-       var cmpIdentity = Engine.QueryInterface(msg.entity, IID_Identity);
        if (cmpIdentity)
        {
            isConquestCritical = cmpIdentity.HasClass("ConquestCritical");
@@ -465,6 +472,21 @@
            this.popUsed -= cost.GetPopCost();
            this.popBonuses -= cost.GetPopBonus();
        }
+       
+       if (cmpIdentity && cmpIdentity.HasClass("Hero"))
+       {
+           //Remove from Heroes list
+           var index = this.heroes.indexOf(msg.entity);
+           if (index >= 0)
+           {
+               this.heroes.splice(index, 1);
+           }
+           else
+           {
+               // Why is not the Hero in the list?
+           }
+       }
+       
    }
    if (msg.to == this.playerID)
    {
@@ -476,6 +498,11 @@
            this.popUsed += cost.GetPopCost();
            this.popBonuses += cost.GetPopBonus();
        }
+       
+       if (cmpIdentity && cmpIdentity.HasClass("Hero"))
+       {
+           this.heroes.push(msg.entity);
+       }
    }
 };

Index: binaries/data/mods/public/gui/session/input.js
===================================================================
--- binaries/data/mods/public/gui/session/input.js  (revision 13327)
+++ binaries/data/mods/public/gui/session/input.js  (working copy)
@@ -1982,6 +2009,37 @@
    resetIdleUnit();
 }

+function cycleHeroes() {
+   var playerState = Engine.GuiInterfaceCall("GetSimulationState").players[Engine.GetPlayerID()];
+   if (playerState.heroes.length < 1)
+       return;
+   
+   var append = Engine.HotkeyIsPressed("selection.add"), selectall = Engine.HotkeyIsPressed("selection.offscreen"),
+       selection = g_Selection.toList(), currentIndex, newIndex = 0, newList = [];
+
+   if (selectall)
+       newList = playerState.heroes;
+   else if (append)
+   {
+       // Find the first hero not in the selection.
+       newIndex = playerState.heroes.indexOf(
+               Math.min.apply(Math, playerState.heroes.filter(function(hero) selection.indexOf(hero) == -1)));
+   }
+   else if (selection.length == 1 && (currentIndex = playerState.heroes.indexOf(selection[0])) > -1)
+   {
+       newIndex = Math.min(currentIndex + 1, playerState.heroes.length);
+       if (newIndex == playerState.heroes.length)
+           newIndex = 0;
+   }
+
+   if (!newList.length && newIndex > -1)
+       newList = [playerState.heroes[newIndex]];
+
+   if (!append)
+       g_Selection.reset();
+   g_Selection.addList(newList);
+}
+
 function stopUnits(entities)
 {
    Engine.PostNetworkCommand({ "type": "stop", "entities": entities, "queued": false });