Ticket #2357: idle_worker_blink_v13.patch

binaries/data/mods/public/gui/common/colorFades.js

@@ -217 +217 @@
     return false;
 }
 
-//[END] of hero fade functions
- No newline at end of file
+//[END] of hero fade functions
+//[START] idle workers icon
+
+function colorFade_IdleWorker(data)
+{
+    var rgb = data.rgb;
+    // init color
+    if (data.tickCounter == 0)
+    {
+        rgb.r = 255;
+        rgb.g = 255;
+        rgb.b = 255;
+    }
+    // hide it every tick
+    if (data.tickCounter % 2 == 0)
+        rgb.o = 0;
+    else
+        rgb.o = 100;
+}
+
+//[END] of idle workers icon functions
+ No newline at end of file

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

@@ -2084 +2084 @@
     lastIdleType = undefined;
 }
 
-function findIdleUnit(classes)
+// selectionLimit [optional]: positive number greater than zero or false, if all should be selected
+function findIdleUnit(classes, selectionLimit)
 {
     var append = Engine.HotkeyIsPressed("selection.add");
-    var selectall = Engine.HotkeyIsPressed("selection.offscreen");
+    var selectall = Engine.HotkeyIsPressed("selection.offscreen") || selectionLimit === false;
+    if (!selectionLimit || selectionLimit <= 0)
+        selectionLimit = 1;
 
     // Reset the last idle unit, etc., if the selection type has changed.
     var type = classes.join();
@@ -2101 +2104 @@
 
     for (var i = 0; i < classes.length; ++i)
     {
-        var data = { idleClass: classes[currIdleClass], prevUnit: lastIdleUnit, limit: 1 };
+        var data = { idleClass: classes[currIdleClass], prevUnit: lastIdleUnit, limit: selectionLimit };
         if (append)
             data.excludeUnits = g_Selection.toList();
 

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

@@ -56 +56 @@
 // always through the list of all ongoing attacks...
 var g_previousHeroHitPoints = undefined;
 
+// cache idle worker button class names
+var g_idleWorkerClasses = undefined;
+
 function GetSimState()
 {
     if (!g_SimState)
@@ -148 +151 @@
     {
         g_Players = getPlayerData(null);
     }
+    
+    // cache worker class data
+    g_idleWorkerClasses = Engine.GuiInterfaceCall("GetIdleWorkerClasses");
 
+    // set function to button
+    for (var n = 1; n <= 3; n++)
+    {
+        var idleWorkerButton = Engine.GetGUIObjectByName("idleWorkerButton[" + n + "]");
+        if (idleWorkerButton)
+        {
+            idleWorkerButton.onpress = function() { findIdleUnit(g_idleWorkerClasses); };
+            idleWorkerButton.onpressright = function() { findIdleUnit(g_idleWorkerClasses, false); };
+        }
+    }
+
     // Cache civ data
     g_CivData = loadCivData();
     g_CivData["gaia"] = { "Code": "gaia", "Name": "Gaia" };
@@ -490 +507 @@
     updatePlayerDisplay();
     updateSelectionDetails();
     updateResearchDisplay();
+    updateIdleWorkerButton();
     updateBuildingPlacementPreview();
     updateTimeElapsedCounter();
     updateTimeNotifications();  
@@ -502 +520 @@
 }
 
 /**
++ * updates the idle worker button
++ */
+function updateIdleWorkerButton()
+{
+    var simState = GetSimState();
+    var idleUnitsCounter = simState.players[Engine.GetPlayerID()].idleWorkerButtonCount;
+    // set color fade and label
+    if (idleUnitsCounter > 0)
+    {
+        startColorFade("idleWorkerColorOverlay", 750, 0, colorFade_IdleWorker, "session/minimap-idle-colorMask.png", false);
+        var label = Engine.GetGUIObjectByName("idleWorkerLabel")
+        label.caption = idleUnitsCounter; 
+        label.hidden = false;
+    }
+    else
+    {
+        stopColorFade("idleWorkerColorOverlay");
+        var label = Engine.GetGUIObjectByName("idleWorkerLabel");
+        label.hidden = true;
+    }
+}
+
+/**
 * updates a status bar on the GUI
 * nameOfBar: name of the bar
 * points: points to show
@@ -595 +636 @@
     {   
         g_previousHeroHitPoints = heroState.hitpoints;
         // trigger the animation
-        startColorFade("heroHitOverlay", 100, 0, colorFade_attackUnit, true, smoothColorFadeRestart_attackUnit);
+        startColorFade("heroHitOverlay", 100, 0, colorFade_attackUnit, undefined, true, smoothColorFadeRestart_attackUnit);
         return;
     }
 }

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

@@ -949 +949 @@
 
         <!-- Idle Worker Button -->
         <object size="100%-36 100%-36 100%-5 100%-5">
-            <!-- TODO: should highlight the button if there's non-zero idle workers -->
             <object name="idle-overlay" size="-85 -85 100% 100%" type="image" sprite="stretched:session/minimap-idle.png" ghost="true"/>
             <!-- Since we don't support non-rectangular buttons, we approximate the area using 3 rectangles TODO: Make this cleaner -->
-            <object type="button"
+            <object type="button" name="idleWorkerButton[1]"
                 tooltip_style="sessionToolTip"
-                tooltip="Find idle worker"
+                tooltip="Click to find an idle worker, right-click to select all idle workers."
                 hotkey="selection.idleworker"
-            >
-                <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
-            </object>
-            <object type="button"
+            />
+            <object type="button" name="idleWorkerButton[2]"
                 tooltip_style="sessionToolTip"
-                tooltip="Find idle worker"
+                tooltip="Click to find an idle worker, right-click to select all idle workers."
                 size="15 -15 100% 0"
-            >
-                <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
-            </object>
-            <object type="button"
+            />
+            <object type="button" name="idleWorkerButton[3]"
                 tooltip_style="sessionToolTip"
-                tooltip="Find idle worker"
+                tooltip="Click to find an idle worker, right-click to select all idle workers."
                 size="-15 15 0 100%"
-            >
-                <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
-            </object>
+            />
+            <object name="idleWorkerColorOverlay" type="image" size="-85 -85 100% 100%" ghost="true"/>
+            <object name="idleWorkerLabel" type="text" style="groupIconsText" size="0 0 100% 100%" ghost="true"/>
         </object>
     </object>
 

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

@@ -89 +89 @@
             "team": cmpPlayer.GetTeam(),
             "teamsLocked": cmpPlayer.GetLockTeams(),
             "cheatsEnabled": cmpPlayer.GetCheatsEnabled(),
+            "idleWorkerButtonCount": cmpPlayer.GetIdleWorkerButtonCount(),
             "phase": phase,
             "isAlly": allies,
             "isMutualAlly": mutualAllies,
@@ -727 +728 @@
 };
 
 // Returns the battle state of the player.
+GuiInterface.prototype.GetIdleWorkerClasses = function(player)
+{
+    // try to get the data
+    var cmpPlayer = QueryPlayerIDInterface(player, IID_Player);
+    if (!cmpPlayer)
+        return [];
+    else
+        return cmpPlayer.GetIdleWorkerButtonClassesList();
+};
+
+// Returns the battle state of the player.
 GuiInterface.prototype.GetBattleState = function(player)
 {
     var cmpBattleDetection = QueryPlayerIDInterface(player, IID_BattleDetection);
@@ -1976 +1988 @@
     "SetWallPlacementPreview": 1,
     "GetFoundationSnapData": 1,
     "PlaySound": 1,
+    "GetIdleWorkerClasses" :1,
     "FindIdleUnits": 1,
     "GetTradingRouteGain": 1,
     "GetTradingDetails": 1,

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

@@ -1 +1 @@
 function Player() {}
 
 Player.prototype.Schema =
-    "<a:component type='system'/><empty/>";
-
+    "<element name='IdleWorkerButtonClasses' a:help='Classes of entities which are used for the idle worker button.'>" +
+        "<attribute name='datatype'>" +
+            "<value>tokens</value>" +
+        "</attribute>" +
+        "<text/>" +
+    "</element>";
+    
 Player.prototype.Init = function()
 {
     this.playerID = undefined;
@@ -36 +41 @@
     this.cheatsEnabled = false;
     this.cheatTimeMultiplier = 1;
     this.heroes = [];
+    this.idleWorkerButtonCount = 0;
+    this.idleWorkerButtonClasses = this.template.IdleWorkerButtonClasses._string ? this.template.IdleWorkerButtonClasses._string.split(/\s+/) : []; // classes used for the work idle button
     Engine.QueryInterface(SYSTEM_ENTITY, IID_EndGameManager).CheckConquestCriticalEntities();
 };
 
+/**
+ * Returns an array of unit classes which are used for the idle worker button
+ */
+Player.prototype.GetIdleWorkerButtonClassesList = function()
+{
+    return this.idleWorkerButtonClasses;
+};
+
 Player.prototype.SetPlayerID = function(id)
 {
     this.playerID = id;
@@ -559 +574 @@
             if (index >= 0)
                 this.heroes.splice(index, 1);
         }
+        // check, if new idle worker is gone
+        var cmpUnitAI = Engine.QueryInterface(msg.entity, IID_UnitAI);
+        if (cmpUnitAI)
+            if (cmpUnitAI.IsIdle() && cmpUnitAI.IsUsedForIdleWorkerButton())
+                this.DecreaseWorkerButtonCount();
     }
     if (msg.to == this.playerID)
     {
@@ -570 +590 @@
 
         if (cmpIdentity && cmpIdentity.HasClass("Hero"))
             this.heroes.push(msg.entity);
+            
+        // check, if new idle worker is there
+        var cmpUnitAI = Engine.QueryInterface(msg.entity, IID_UnitAI);
+        if (cmpUnitAI)
+            if (cmpUnitAI.IsIdle() && cmpUnitAI.IsUsedForIdleWorkerButton())
+                this.IncreaseWorkerButtonCount();
     }
 };
 
@@ -664 +690 @@
         cmpGUIInterface.PushNotification(notification);
 };
 
+Player.prototype.GetIdleWorkerButtonCount = function()
+{
+    return this.idleWorkerButtonCount;
+};
+
+Player.prototype.IncreaseWorkerButtonCount = function()
+{
+    this.idleWorkerButtonCount++;
+};
+
+Player.prototype.DecreaseWorkerButtonCount = function()
+{
+    this.idleWorkerButtonCount--;
+    if (this.idleWorkerButtonCount < 0)
+    {
+        this.idleWorkerButtonCount = 0;
+        error("Negative worker idle count for player '" + this.playerID + "'");
+    }
+};
+
 Engine.RegisterComponentType(IID_Player, "Player", Player);

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

@@ -169 +169 @@
     "GuardedAttacked": function(msg) {
         // ignore
     },
+    
+    "UnitIdleChanged": function(msg) {      
+        // do only if its not animal and is used for the idle worker button
+        if (!this.IsAnimal() && this.IsUsedForIdleWorkerButton())
+        {
+            var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player);
+            if (cmpPlayer)
+            {
+                if(msg.idle)
+                    cmpPlayer.IncreaseWorkerButtonCount();
+                else
+                    cmpPlayer.DecreaseWorkerButtonCount();
+            }
+        }
+    },
 
     // Formation handlers:
 
@@ -1401 +1416 @@
                 return false;
             },
 
-            "leave": function() {
+            "leave": function(msg) {
                 var rangeMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
                 if (this.losRangeQuery)
                     rangeMan.DisableActiveQuery(this.losRangeQuery);
@@ -1409 +1424 @@
                     rangeMan.DisableActiveQuery(this.losHealRangeQuery);
 
                 this.StopTimer();
-
-                if (this.isIdle)
+                // only change idle state, if next state is different from idle (happens in case of death of unit FormationIdle --> IndiviIdle)
+                if (this.isIdle && !(msg.nextState && msg.nextState.length > 0 && msg.nextState[msg.nextState.length-1].indexOf(".IDLE") != -1))
                 {
                     this.isIdle = false;
                     Engine.PostMessage(this.entity, MT_UnitIdleChanged, { "idle": this.isIdle });
@@ -3059 +3074 @@
     this.formationController = INVALID_ENTITY; // entity with IID_Formation that we belong to
     this.isGarrisoned = false;
     this.isIdle = false;
+    this.isUsedForIdleWorkerButton = undefined; // will be initialised, if IsUsedForIdleWorkerButton() is called the first time
     this.lastFormationTemplate = "";
     this.finishedOrder = false; // used to find if all formation members finished the order
     
@@ -3143 +3159 @@
     return Engine.QueryInterface(this.entity, IID_Heal);
 };
 
+UnitAI.prototype.IsUsedForIdleWorkerButton = function()
+{
+    // return cached value, if some is stored
+    if (this.isUsedForIdleWorkerButton !== undefined)
+        return this.isUsedForIdleWorkerButton;
+    
+    // calculate value
+    this.isUsedForIdleWorkerButton = false;
+    var cmpIdentity = Engine.QueryInterface(this.entity, IID_Identity);
+    if (!cmpIdentity)
+        return false;
+    var cmpPlayer = QueryOwnerInterface(this.entity, IID_Player);
+    if (!cmpPlayer)
+        return false;
+    // check idle class names   
+    for each(var className in cmpPlayer.GetIdleWorkerButtonClassesList())
+        if (cmpIdentity.HasClass(className)) {
+            this.isUsedForIdleWorkerButton = true;
+            break;
+        }
+    // return the value
+    return this.isUsedForIdleWorkerButton;
+};
+
 UnitAI.prototype.IsIdle = function()
 {
     return this.isIdle;
@@ -3791 +3831 @@
     UnitFsm.ProcessMessage(this, {"type": "PackFinished", "packed": msg.packed});
 };
 
+UnitAI.prototype.OnUnitIdleChanged = function(msg)
+{
+    var cmpOwnership = Engine.QueryInterface(this.entity, IID_Ownership);
+    if (!cmpOwnership)
+        return;
+    UnitFsm.ProcessMessage(this, {"type": "UnitIdleChanged", "idle": msg.idle, "player": cmpOwnership.GetOwner()});
+}
+
 //// Helper functions to be called by the FSM ////
 
 UnitAI.prototype.GetWalkSpeed = function()

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

@@ -359 +359 @@
         if (leave)
         {
             obj.fsmStateName = fromState[i];
-            if (leave.apply(obj))
+            if (leave.apply(obj, [{"nextState": toState}]))
             {
                 obj.FsmStateNameChanged(obj.fsmStateName);
                 return;
@@ -373 +373 @@
         if (enter)
         {
             obj.fsmStateName = toState[i];
-            if (enter.apply(obj))
+            if (enter.apply(obj, [{"previousState": fromState}]))
             {
                 obj.FsmStateNameChanged(obj.fsmStateName);
                 return;

binaries/data/mods/public/simulation/templates/special/player.xml

@@ -39 +39 @@
       </Pillar>
     </LimitChangers>
   </EntityLimits>
-  <Player/>
+  <Player>
+    <IdleWorkerButtonClasses datatype="tokens">Worker Trade FishingBoat</IdleWorkerButtonClasses>
+  </Player>
   <StatisticsTracker/>
   <TechnologyManager/>
 </Entity>