Ticket #3000: heropanel_split.patch

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

@@ -143 +143 @@
 var g_AdditionalHighlight = [];
 
 /**
- * Blink the hero selection if that entity has lost health since the last turn.
+ * List of heroes to display.
  */
-var g_PreviousHeroHitPoints;
+var g_Heroes = [];
 
 /**
  * Unit classes to be checked for the idle-worker-hotkey.
@@ -269 +269 @@
     gameSpeed.onSelectionChange = function() { changeGameSpeed(+this.list_data[this.selected]); };
     initMenuPosition();
 
+    for (let slot = 0, length = Engine.GetGUIObjectByName("unitHeroPanel").children.length; slot < length; ++slot)
+        initGUIHeroes(slot);
+
     // Populate player selection dropdown
     let playerNames = [translate("Observer")];
     let playerIDs = [-1];
@@ -320 +323 @@
             "session.fulltradeswap");
 }
 
+function initGUIHeroes(slot)
+{
+    let button = Engine.GetGUIObjectByName("unitHeroButton[" + slot + "]");
+    button.onPress = function()
+    {
+        let hero = g_Heroes.find(hero => hero.slot !== undefined && hero.slot == slot);
+        if (!hero)
+            return;
+        if (!Engine.HotkeyIsPressed("selection.add"))
+            g_Selection.reset();
+        g_Selection.addList([hero.ent]);
+    };
+
+    button.onDoublePress = function() {
+        let hero = g_Heroes.find(hero => hero.slot !== undefined && hero.slot == slot);
+        if (hero)
+            selectAndMoveTo(getEntityOrHolder(hero.ent));
+    };
+}
+
 function initializeMusic()
 {
     initMusic();
@@ -726 +749 @@
     if (g_ShowGuarding || g_ShowGuarded)
         updateAdditionalHighlight();
 
-    updateHero();
+    updateHeroes();
+    displayHeroes();
     updateGroups();
     updateDebug();
     updatePlayerDisplay();
@@ -802 +826 @@
 }
 
 
-function updateHero()
+function updateHeroes()
 {
-    let unitHeroPanel = Engine.GetGUIObjectByName("unitHeroPanel");
-    let heroButton = Engine.GetGUIObjectByName("unitHeroButton");
-
     let playerState = GetSimState().players[g_ViewedPlayer];
-    if (!playerState || playerState.heroes.length <= 0)
-    {
-        g_PreviousHeroHitPoints = undefined;
-        unitHeroPanel.hidden = true;
-        return;
-    }
+    let heroes = playerState ? playerState.heroes : [];
 
-    let heroImage = Engine.GetGUIObjectByName("unitHeroImage");
-    let heroState = GetExtendedEntityState(playerState.heroes[0]);
-    let template = GetTemplateData(heroState.template);
-    heroImage.sprite = "stretched:session/portraits/" + template.icon;
-    let hero = playerState.heroes[0];
+     g_Heroes =  g_Heroes.filter(hero => heroes.find(ent => ent == hero.ent));
 
-    heroButton.onpress = function()
+    for (let ent of heroes)
     {
-        if (!Engine.HotkeyIsPressed("selection.add"))
-            g_Selection.reset();
-        g_Selection.addList([hero]);
-    };
-    heroButton.ondoublepress = function() { selectAndMoveTo(getEntityOrHolder(hero)); };
-    unitHeroPanel.hidden = false;
+        let heroState = GetExtendedEntityState(ent);
+        let template = GetTemplateData(heroState.template);
+
+        let hero = g_Heroes.find(hero => ent == hero.ent);
+
+        if (!hero)
+        {
+            hero = {
+                "ent": ent,
+                "tooltip": undefined,
+                "sprite": "stretched:session/portraits/" + template.icon,
+                "maxHitpoints": undefined,
+                "currentHitpoints": heroState.hitpoints,
+                "previousHitpoints": undefined
+            };
+            g_Heroes.push(hero);
+        }
+
+        hero.tooltip = createHeroTooltip(heroState, template);
+        hero.previousHitpoints = hero.currentHitpoints;
+        hero.currentHitpoints = heroState.hitpoints;
+        hero.maxHitpoints = heroState.maxHitpoints;
+    }
+}
 
+function createHeroTooltip(heroState, template)
+{
     // Setup tooltip
-    let tooltip = "[font=\"sans-bold-16\"]" + template.name.specific + "[/font]";
-    let healthLabel = "[font=\"sans-bold-13\"]" + translate("Health:") + "[/font]";
-    tooltip += "\n" + sprintf(translate("%(label)s %(current)s / %(max)s"), { 
-        "label": healthLabel,
-        "current": Math.ceil(heroState.hitpoints),
-        "max": Math.ceil(heroState.maxHitpoints)
+    let tooltip = "[font=\"sans-bold-16\"]" + template.name.specific + "[/font]" + "\n"
+        + sprintf(translate("%(label)s %(current)s / %(max)s"), {
+            "label": "[font=\"sans-bold-13\"]" + translate("Health:") + "[/font]",
+            "current": Math.ceil(heroState.hitpoints),
+            "max": Math.ceil(heroState.maxHitpoints)
     });
     if (heroState.attack)
         tooltip += "\n" + getAttackTooltip(heroState);
@@ -844 +875 @@
     tooltip += "\n" + getArmorTooltip(heroState.armour);
     if (template.tooltip)
         tooltip += "\n" + template.tooltip;
+    return tooltip;
+}
 
-    heroButton.tooltip = tooltip;
+function displayHeroes()
+{
+    let buttons = Engine.GetGUIObjectByName("unitHeroPanel").children;
 
-    // update heros health bar
-    updateGUIStatusBar("heroHealthBar", heroState.hitpoints, heroState.maxHitpoints);
+    buttons.forEach((button, slot) =>
+        {
+            if (button.hidden || g_Heroes.find(hero => hero.slot !== undefined && hero.slot == slot))
+                return;
 
-    let heroHP = {
-        "hitpoints": heroState.hitpoints,
-        "player": g_ViewedPlayer
-    };
+            Engine.GetGUIObjectByName("unitHeroButton[" + slot + "]").hidden = true;
+            stopColorFade("heroHitOverlay[" + slot + "]");
 
-    if (!g_PreviousHeroHitPoints)
-        g_PreviousHeroHitPoints = heroHP;
+        });
 
-    // if the health of the hero changed since the last update, trigger the animation
-    if (g_PreviousHeroHitPoints.player == heroHP.player && g_PreviousHeroHitPoints.hitpoints > heroHP.hitpoints)
-        startColorFade("heroHitOverlay", 100, 0, colorFade_attackUnit, true, smoothColorFadeRestart_attackUnit);
+    for (let displayIndex = 0; displayIndex < Math.min(g_Heroes.length, buttons.length); ++displayIndex)
+    {
+        let hero = g_Heroes[displayIndex];
+        // Find the first unused slot if new, otherwise reuse previous.
+        let slot = hero.slot === undefined ?
+            buttons.findIndex(button => button.hidden) :
+            hero.slot;
+
+        let heroButton = Engine.GetGUIObjectByName("unitHeroButton[" + slot + "]");
+        heroButton.tooltip = hero.tooltip;
+        updateGUIStatusBar("heroHealthBar[" + slot + "]", hero.currentHitpoints, hero.maxHitpoints);
 
-    g_PreviousHeroHitPoints = heroHP;
+        if (hero.slot === undefined)
+        {
+            let heroImage = Engine.GetGUIObjectByName("unitHeroImage[" + slot + "]");
+            heroImage.sprite = hero.sprite;
+            heroButton.hidden = false;
+
+            hero.slot = slot;
+        }
+
+        // If the health of the hero changed since the last update, trigger the animation.
+        if (hero.previousHitpoints > hero.currentHitpoints)
+            startColorFade("heroHitOverlay[" + slot + "]", 100, 0,
+                    colorFade_attackUnit, true, smoothColorFadeRestart_attackUnit);
+
+        // The "slot" is which button, but it's the identity (name) of the button, not its position.
+        // Heroes stay in the same slot, but the position of the button may change.
+        // TODO: Instead of instant position changes, animate button movement.
+        setPanelObjectPosition(heroButton, displayIndex, buttons.length);
+
+    }
 }
 
 function updateGroups()

binaries/data/mods/public/gui/session/session_objects/hero_icon.xml

@@ -2 +2 @@
 <object
     name="unitHeroPanel"
     size="0 36 50 93"
-    hidden="true"
+    hidden="false"
 >
-    <object name="unitHeroButton" size="0 0 50 50" type="button" style="iconButton" 
-        tooltip_style="sessionToolTip">
-        <object name="unitHeroImage" size="5 5 100%-5 100%-5" type="image" ghost="true"/>
-        <object name="heroHitOverlay" hidden="true" type="image" ghost="true" size="5 5 100%-5 100%-5"/> 
-    </object>
-    <!-- Hero Health bar -->
-    <object size="3 100%-7 100%-3 100%-2" name="heroHealthSection" ghost="true">
-        <object size="0 0 100% 5" name="heroHealth" type="image" ghost="true">
-            <object type="image" sprite="barBorder" ghost="true" size="-1 -1 100%+1 100%+1"/>
-            <object type="image" sprite="healthBackground" ghost="true"/> 
-            <object type="image" sprite="healthForeground" ghost="true" name="heroHealthBar"/> 
-            <object type="image" sprite="statsBarShaderHorizontal" ghost="true"/>
+    <repeat count="10" var="n">
+        <object name="unitHeroButton[n]" size="0 0 50 50" type="button" hidden="true" style="iconButton" tooltip_style="sessionToolTip">
+            <object name="unitHeroImage[n]" size="5 5 100%-5 100%-5" type="image" ghost="true"/>
+            <object name="heroHitOverlay[n]" hidden="true" type="image" ghost="true" size="5 5 100%-5 100%-5"/>
+            <!-- Hero Health bar -->
+            <object size="3 100%-7 100%-3 100%-2" name="heroHealthSection[n]" ghost="true">
+                <object size="0 0 100% 5" name="heroHealth[n]" type="image" ghost="true">
+                    <object type="image" sprite="barBorder" ghost="true" size="-1 -1 100%+1 100%+1"/>
+                    <object type="image" sprite="healthBackground" ghost="true"/>
+                    <object type="image" sprite="healthForeground" ghost="true" name="heroHealthBar[n]"/>
+                    <object type="image" sprite="statsBarShaderHorizontal" ghost="true"/>
+                </object>
+            </object>
         </object>
-    </object>
+    </repeat>
 </object>