Ticket #3736: idleworker_V2.1.patch

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

@@ -7 +7 @@
 >
     <!-- Idle Worker Button -->
     <object size="100%-80 100%-80 100%-5 100%-5">
-        <!-- TODO: We should disable this button if there are no idle workers. -->
         <object type="button"
             tooltip_style="sessionToolTip"
             hotkey="selection.idleworker"
         >
             <translatableAttribute id="tooltip">Find idle worker</translatableAttribute>
-            <action on="Press">findIdleUnit(["Female", "Trader", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
-            <action on="MouseEnter">Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle-highlight.png";</action>
-            <action on="MouseLeave">Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle.png";</action>
-            <action on="MouseLeftPress">Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle.png";</action>
-            <action on="MouseLeftRelease">Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle-highlight.png";</action>
+            <action on="Press">if (hasIdleWorker()) findIdleUnit(["Female", "Trader", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
+            <action on="MouseEnter">if (hasIdleWorker()) Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle-highlight.png";</action>
+            <action on="MouseLeave">if (hasIdleWorker()) Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle.png";</action>
+            <action on="MouseLeftPress">if (hasIdleWorker()) Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle.png";</action>
+            <action on="MouseLeftRelease">if (hasIdleWorker()) Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/minimap-idle-highlight.png";</action>
         </object>
     </object>
     <!-- Minimap -->

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

@@ -529 +529 @@
         Engine.SetSimRate(speed);
 }
 
+function hasIdleWorker()
+{
+    let possibleIdleClasses = ["Female", "Trader", "FishingBoat", "CitizenSoldier", "Healer"];
+
+    for (let i = 0; i < possibleIdleClasses.length; ++i)
+    {
+        let data = {
+            "idleClass": possibleIdleClasses[i],
+            "prevUnit": undefined,
+            "limit": 1,
+            "excludeUnits": []
+        };
+
+        let idleUnits = Engine.GuiInterfaceCall("FindIdleUnits", data);
+        
+        // check for any idle workers
+        if (idleUnits.length > 0)
+            return true;
+    }
+
+    // no idle workers available
+    return false;
+}
+
+function updateIdleWorkerButton()
+{
+    let newImage = "";
+    let cntImage = Engine.GetGUIObjectByName("idleOverlay").sprite;
+
+    let idleImage = "minimap-idle.png";
+    let highlightedImage = "minimap-idle-highlight.png";
+    let idleDisabledImage = "minimap-idle-disabled.png";
+
+    // determine right button image
+    if (hasIdleWorker())
+        newImage = (cntImage == "stretched:session/" + highlightedImage) ? highlightedImage : idleImage;
+    else
+        newImage = idleDisabledImage;
+
+    // update gui button
+    Engine.GetGUIObjectByName("idleOverlay").sprite = "stretched:session/" + newImage;
+}
+
 /**
  * Recomputes GUI state that depends on simulation state or selection state. Called directly every simulation
  * update (see session.xml), or from onTick when the selection has changed.
@@ -562 +605 @@
     updateSelectionDetails();
     updateBuildingPlacementPreview();
     updateTimeNotifications();
+    updateIdleWorkerButton();
 
     if (!g_IsObserver)
         updateResearchDisplay();