Ticket #2162: 2162 - Rebased.patch

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

@@ -107 +107 @@
     return this.groups[templateName];
 };
 
+/**
+ * @return true if the group has at least one member
+ */
+EntityGroups.prototype.hasMembers = function()
+{
+    return Object.keys(this.groups).length != 0;
+};
+
 EntityGroups.prototype.getTotalCount = function()
 {
     var totalCount = 0;
@@ -463 +471 @@
 function EntityGroupsContainer()
 {
     this.groups = [];
+    this.info = [];
+    // Inits groups from 0 to 9
     for (var i = 0; i < 10; ++i)
+    {
         this.groups[i] = new EntityGroups();
+        var data = {}; // hitpoints, maxGroupHitPoints, numberOfUnits, initialNumberOfUnits, deathCycle, dirty, attack
+        this.info[i] = data;
+    }
 }
 
-EntityGroupsContainer.prototype.addEntities = function(groupName, ents)
+/**
+ * Adds entities to the group
+ * @param groupID: id of the group
+ * @param ents: array of entity IDs
+ */
+EntityGroupsContainer.prototype.addEntities = function(groupID, ents)
 {
     for each (var ent in ents)
-        for each (var group in this.groups)
+        for (let gID in this.groups)
+        {
+            let group = this.groups[gID];
             if (ent in group.ents)
+            {
                 group.removeEnt(ent);
-
-    this.groups[groupName].add(ents);
+                 // Fade and icon should not be triggered if a unit comes to another group.
+                this.removeEnt(gID, ent);
+                break;
+            }
+        }
+    // Add entities to group
+    this.groups[groupID].add(ents);
+    this.updateAdditionalData(groupID, ents, true);
 };
 
+/**
+ * Removes a entity from the info data
+ * @param groupID: id of the group
+ * @param ents: array of entity IDs
+ */
+EntityGroupsContainer.prototype.removeEnt = function(groupID, ent)
+{
+    if (!this.hasMembers(groupID))
+        return;
+    var entState = GetEntityState(+ent);
+    if (!entState)
+        return;
+
+    // update the data like this unit would never be in this group
+    var data = this.info[groupID];
+    data.hitpoints -= entState.hitpoints;
+    data.maxGroupHitPoints -= entState.maxHitpoints;
+    data.numberOfUnits--;
+    data.initialNumberOfUnits--;
+    data.dirty = true;
+}
+
+/**
+ * Updates the additional info of a group; can be called for init or update but should only be called, if needed.
+ * @param groupID: id of the group
+ * @param ents: array of entity IDs
+ * @param init: true, if init
+ */ 
+EntityGroupsContainer.prototype.updateAdditionalData = function(groupID, ents, init)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    if (init)
+    {
+        let data = {};
+        data.dirty = true; // True, if GUI should be updated
+        data.attack = false; // True, if GUI should start color attack animation
+        data.hitpoints = 0;
+        data.maxGroupHitPoints = 0;
+        data.numberOfUnits = ents.length;
+        data.initialNumberOfUnits = data.numberOfUnits;
+        data.deathCycle = 0; // Used for death icon
+
+        // Update the additional info
+        if (data.numberOfUnits > 0)
+            this.info[groupID] = data;
+        else
+            this.info[groupID] = {};
+    }
+
+    // update the values needed for the GUI
+    this.updateHealth(groupID);
+    this.updateMaxHealth(groupID);
+    this.updateMembers(groupID);
+}
+
+/**
+ * updates the current health points of a group
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.updateHealth = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    var data = this.info[groupID];
+    var hitpoints = 0;
+    // Calculate health
+    for (let ent in this.groups[groupID].ents)
+    {
+        let entState = GetEntityState(+ent);
+        hitpoints += entState.hitpoints;
+    }
+
+    // check, if attack is running.
+    if (hitpoints < data.hitpoints)
+        data.attack = true;
+    // update prev points
+    if (hitpoints != data.hitpoints)
+    {
+        data.hitpoints = hitpoints;
+        data.dirty = true;
+    }
+}
+
+/**
+ * Updates the member count of the group
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.updateMembers = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    var data = this.info[groupID];
+    var numberOfUnits = this.groups[groupID].getTotalCount();
+    if (numberOfUnits < data.numberOfUnits)
+    {
+        // Update unit count
+        data.numberOfUnits = numberOfUnits;
+        data.deathCycle = 1; // Show death symbol
+        // Update max health of the group
+        this.updateMaxHealth(groupID);
+        data.dirty = true;
+    }
+}
+
+/**
+ * Updates the max health a group can have
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.updateMaxHealth = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    var data = this.info[groupID];
+    data.maxGroupHitPoints = 0;
+    for (let ent in this.groups[groupID].ents)
+    {
+        let entState = GetEntityState(+ent);
+        data.maxGroupHitPoints += entState.maxHitpoints;
+    }
+}
+
+/**
+ * Updates the death cycle icon
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.updateDeathCycle = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    var data = this.info[groupID]; 
+    if (data.deathCycle > 0)
+        data.deathCycle++;
+    if (data.deathCycle >= g_groupDeathShowIconTicks)
+        data.dirty = true;
+}
+
 EntityGroupsContainer.prototype.update = function()
 {
     this.checkRenamedEntities();
-    for each (var group in this.groups)
+    for (let groupID in this.groups)
     {
+        // Nothing to do, if no members are there
+        if (!this.hasMembers(groupID))
+            continue;
+
+        let group = this.groups[groupID];
         for (var ent in group.ents)
         {
             var entState = GetEntityState(+ent);
@@ -489 +664 @@
             if (!entState)
                 group.removeEnt(ent);
         }
+        // update the values needed for the GUI
+        this.updateHealth(groupID);
+        this.updateMembers(groupID);
+        this.updateDeathCycle(groupID);
     }
 };
 
@@ -505 +684 @@
         for each (var renamedEntity in renamedEntities)
             renamedLookup[renamedEntity.entity] = renamedEntity.newentity;
 
-        for each (var group in this.groups)
+        for (let groupID in this.groups)
         {
+            let group = this.groups[groupID];
             for each (var renamedEntity in renamedEntities)
             {
                 // Reconstruct the group if at least one entity has been renamed.
@@ -513 +693 @@
                 if (renamedEntity.entity in group.ents)
                 {
                     group.rebuildGroup(renamedLookup);
+                    this.updateAdditionalData(groupID, Object.keys(group.ents), false);
                     break;
                 }
             }
@@ -520 +701 @@
     }
 };
 
+/**
+ * Resets the initialNumberOfUnits
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.resetMemberStatus = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+         
+    var data = this.info[groupID];
+    data.initialNumberOfUnits = data.numberOfUnits;
+    data.dirty = true;
+}
+
+/**
+ * Checks if a group with that ID has members
+ * @param groupID: id of the group
+ */ 
+EntityGroupsContainer.prototype.hasMembers = function(groupID)
+{
+    return this.groups[groupID].hasMembers();
+}
+
+/**
+ * Gets the dirty state for the GUI
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.isDirty = function(groupID)
+{
+    return this.hasMembers(groupID) && this.info[groupID].dirty;
+}
+
+/**
+ * Sets the dirty state to false after the GUI redrawed the stuff
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.resetDirty = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    this.info[groupID].dirty = false;
+}
+
+/**
+ * Gets the attack state for the GUI
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.isAttacked = function(groupID)
+{
+    return this.hasMembers(groupID) && this.info[groupID].attack;
+}
+
+/**
+ * Sets the attack state to false after the color fade was started
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.resetAttack = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    this.info[groupID].attack = false;
+}
+
+/**
+ * Sets the death cycle back to zero (off)
+ * @param groupID: id of the group
+ */
+EntityGroupsContainer.prototype.resetDeathCycle = function(groupID)
+{
+    if (!this.hasMembers(groupID))
+        return;
+
+    this.info[groupID].deathCycle = 0;
+}
+
 var g_Groups = new EntityGroupsContainer();

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

@@ -61 +61 @@
 // always through the list of all ongoing attacks...
 var g_previousHeroHitPoints = undefined;
 
+// Simulation ticks until the deathIcon of a group is removed.
+var g_groupDeathShowIconTicks = 60;
+
 function GetSimState()
 {
     if (!g_SimState)
@@ -183 +186 @@
     gameSpeed.selected = gameSpeedIdx != -1 ? gameSpeedIdx : g_GameSpeeds.Default;
     gameSpeed.onSelectionChange = function() { changeGameSpeed(+this.list_data[this.selected]); };
     initMenuPosition(); // set initial position
+    initLayoutGroupButtons(); // Init group buttons
 
     // Populate player selection dropdown
     var playerNames = [];
@@ -227 +231 @@
     //setTimeout(function() { reportPerformance(60); }, 60000);
 }
 
+/** Inits the layout of the group buttons (adds spacers, labels and events to buttons)
+ */
+function initLayoutGroupButtons()
+{
+    var guiName = "Group";
+    for (let i = 0; i < 10; ++i)
+    {
+        // add label
+        let label = Engine.GetGUIObjectByName("unit"+guiName+"Label["+i+"]").caption = i;
+
+        // add button events and hide it
+        let button = Engine.GetGUIObjectByName("unit"+guiName+"Button["+i+"]");
+        button.onpress = (function(i) { return function() { performGroup((Engine.HotkeyIsPressed("selection.add") ? "add" : "select"), i); } })(i);
+        button.ondoublepress = (function(i) { return function() { performGroup("snap", i); } })(i);
+        button.onpressright = (function(i) { return function() { performGroup("breakUp", i); } })(i);
+        button.hidden = true;
+        setPanelObjectPosition(button, i, 1);
+        // get the members status bar and add a event
+        let memberButton = Engine.GetGUIObjectByName("unit"+guiName+"MembersButton["+i+"]");
+        memberButton.onpress = (function(i) { return function() { g_Groups.resetMemberStatus(i); } })(i);
+    }
+}
+
 function selectViewPlayer(playerID)
 {
     Engine.SetPlayerID(playerID);
@@ -373 +400 @@
     var data = {};
     data.playerAssignments = g_PlayerAssignments;
     data.groups = g_Groups.groups;
+    data.additionalGroupInfo = g_Groups.info;
     // TODO: any other gui state?
     return data;
 }
@@ -392 +420 @@
     {
         g_Groups.groups[groupNumber].groups = data.groups[groupNumber].groups;
         g_Groups.groups[groupNumber].ents = data.groups[groupNumber].ents;
+        g_Groups.info[groupNumber] = data.additionalGroupInfo[groupNumber];
+        g_Groups.info[groupNumber].dirty = true;
     }
     updateGroups();
 }
@@ -580 +610 @@
 */
 function updateGUIStatusBar(nameOfBar, points, maxPoints, direction) 
 {
+    // Check if values are valid
+    if (!(points && maxPoints))
+        return;
+
     // check, if optional direction parameter is valid.
     if (!direction || !(direction >= 0 && direction < 4))
         direction = 0;
@@ -593 +627 @@
     var value = 100*Math.max(0, Math.min(1, points / maxPoints));
     
     // inverse bar
-    if(direction == 2 || direction == 3) 
+    if (direction == 2 || direction == 3)
         value = 100 - value;
 
-    if(direction == 0)
+    if (direction == 0)
         healthSize.rright = value;
-    else if(direction == 1)
+    else if (direction == 1)
         healthSize.rbottom = value;
-    else if(direction == 2)
+    else if (direction == 2)
         healthSize.rleft = value;
-    else if(direction == 3)
+    else if (direction == 3)
         healthSize.rtop = value;
     
     // update bar
@@ -609 +643 @@
     statusBar.size = healthSize;
 }
 
+/**
+ * Changes the visibility of a status bar
+ * @param nameOfBar: name of the bar
+ * @param hide: true, if bar should be hidden
+ */
+function changeVisibilityStatusBar(nameOfBar, hide)
+{
+    // Get the bar and update it
+    var statusBar = Engine.GetGUIObjectByName(nameOfBar);
+    if (!statusBar)
+        return;
 
+    statusBar.hidden = hide;
+}
+
 function updateHero()
 {
     var playerState = GetSimState().players[Engine.GetPlayerID()];
@@ -665 +713 @@
     g_previousHeroHitPoints = heroState.hitpoints;
 }
 
-
+/** Update groups on the GUI.
+ */
 function updateGroups()
 {
     var guiName = "Group";
     g_Groups.update();
-    for (var i = 0; i < 10; i++)
+    for (let i = 0; i < 10; ++i)
     {
-        var button = Engine.GetGUIObjectByName("unit"+guiName+"Button["+i+"]");
-        var label = Engine.GetGUIObjectByName("unit"+guiName+"Label["+i+"]").caption = i;
-        if (g_Groups.groups[i].getTotalCount() == 0)
+        let button = Engine.GetGUIObjectByName("unit"+guiName+"Button["+i+"]");
+        // check, if group has members
+        if (!g_Groups.hasMembers(i))
+        {
             button.hidden = true;
+            stopColorFade("unitGroupHitOverlay["+i+"]");
+            let deathIcon = Engine.GetGUIObjectByName("unitGroupIconDeath["+ i +"]");
+            deathIcon.hidden = true;
+            continue; // nothing to do, if group has no members
+        }
         else
-            button.hidden = false;
-        button.onpress = (function(i) { return function() { performGroup((Engine.HotkeyIsPressed("selection.add") ? "add" : "select"), i); } })(i);
-        button.ondoublepress = (function(i) { return function() { performGroup("snap", i); } })(i);
-        button.onpressright = (function(i) { return function() { performGroup("breakUp", i); } })(i);
-        setPanelObjectPosition(button, i, 1);
+            button.hidden = false; // make button visible
+
+        // check, if status bars must be redrawn
+        if (!g_Groups.isDirty(i))
+        continue;
+
+        // update the status bars
+        let data = g_Groups.info[i];
+        updateGUIStatusBar("unitGroupHealthBar["+ i +"]", data.hitpoints, data.maxGroupHitPoints);
+
+        if(data.initialNumberOfUnits == 1)
+            changeVisibilityStatusBar("unitGroupMembersButton["+ i +"]", true);
+        else
+        {
+            changeVisibilityStatusBar("unitGroupMembersButton["+ i +"]", false);
+            updateGUIStatusBar("unitGroupMembersBar["+ i +"]", data.numberOfUnits, data.initialNumberOfUnits, 3);
+        }
+
+        // check, if the attack should be started
+        if (g_Groups.isAttacked(i))
+        {
+            startColorFade("unitGroupHitOverlay["+i+"]", 100, 10000, colorFade_attackUnit, true, smoothColorFadeRestart_attackUnit);
+            g_Groups.resetAttack(i);
+        }
+
+        // check, if the death symbol should be triggered
+        if (data.deathCycle > 0)
+        {
+            let deathIcon = Engine.GetGUIObjectByName("unitGroupIconDeath["+ i +"]");
+            // show the symbol
+            if (data.deathCycle >= g_groupDeathShowIconTicks)
+            {
+                deathIcon.hidden = true;
+                g_Groups.resetDeathCycle(i);
+            }
+            else if (data.deathCycle >= 1)
+                deathIcon.hidden = false;
+        }
+
+        // reset the dirty state after the updates are complete
+        g_Groups.resetDirty(i);
     }
 }
 

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

@@ -7 +7 @@
         <object name="unitGroupButton[n]" size="0 0 36 36" type="button" hidden="false" style="iconButton" tooltip_style="sessionToolTipBottomBold">
             <translatableAttribute id="tooltip">Click to select grouped units, double-click to focus the grouped units and right-click to disband the group.</translatableAttribute>
             <object name="unitGroupIcon[n]" size="3 3 33 33" type="image" sprite="groupsIcon" ghost="true"/>
+            <object name="unitGroupHitOverlay[n]" hidden="true" type="image" ghost="true" size="3 3 33 33"/>
             <object name="unitGroupLabel[n]" type="text" style="largeCenteredOutlinedText" ghost="true"/>
+            <object name="unitGroupIconDeath[n]" size="21 3 35 17" type="image" sprite="killIcon" hidden="true" ghost="true"/>
+            <!-- Group Health bar -->
+            <object size="2 37 34 40" name="unitGroupHealthSection[n]">
+                <object size="0 0 100% 4" name="unitGroupHealth[n]" ghost="true" type="image">
+                <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="unitGroupHealthBar[n]"/>
+                    <object type="image" sprite="statsBarShaderHorizontal" ghost="true"/>
+                </object>
+            </object>
+            <!-- Group Health bar -->
+            <object size="37 2 40 34" name="unitGroupMembersButton[n]" type="button" tooltip_style="sessionToolTipBottomBold"
+                tooltip="Click to reset unit counter bar.">
+                <object size="0 0 4 100%" name="unitGroupMembers[n]" ghost="true" type="image">
+                <object type="image" sprite="barBorder" ghost="true" size="-1 -1 100%+1 100%+1"/>
+                <object type="image" sprite="groupSizeBackground" ghost="true"/>
+                    <object type="image" sprite="groupSizeForeground" ghost="true" name="unitGroupMembersBar[n]"/> 
+                <object type="image" sprite="statsBarShaderVertical" ghost="true"/>
+                </object>
+            </object>
         </object>
     </repeat>
 </object>

binaries/data/mods/public/gui/session/sprites.xml

@@ -9 +9 @@
         />
     </sprite>
 
+    <sprite name="killIcon">
+        <image
+            texture="session/icons/kill.png"
+            size="0 0 100% 100%"
+        />
+    </sprite>
+
+    <sprite name="groupSizeForeground">
+        <image backcolor="255 184 0 255"/>
+    </sprite>
+
+    <sprite name="groupSizeBackground">
+        <image backcolor="184 184 184 255"/>
+    </sprite>
+
     <!-- ================================  ================================ -->
     <!-- Menu -->
     <!-- ================================  ================================ -->