Ticket #1492: hotkeys.patch

binaries/data/config/default.cfg

@@ -115 +115 @@
 hotkey.screenshot = F2                      ; Take PNG screenshot
 hotkey.bigscreenshot = "Shift+F2"           ; Take large BMP screenshot
 hotkey.togglefullscreen = "Alt+Return"      ; Toggle fullscreen/windowed mode
-hotkey.screenshot.watermark = "K"           ; Toggle product/company watermark for official screenshots
+hotkey.screenshot.watermark = "R"           ; Toggle product/company watermark for official screenshots
 hotkey.wireframe = "Alt+W"                  ; Toggle wireframe mode
 hotkey.silhouettes = "Alt+S"                ; Toggle unit silhouettes
 
 ; > CAMERA SETTINGS
-hotkey.camera.reset = "H"                                 ; Reset camera rotation to default.
+hotkey.camera.reset = "X"                                 ; Reset camera rotation to default.
 hotkey.camera.follow = "F"                                ; Follow the first unit in the selection
 hotkey.camera.zoom.in = Plus, Equals, NumPlus             ; Zoom camera in (continuous control)
 hotkey.camera.zoom.out = Minus, NumMinus                  ; Zoom camera out (continuous control)
@@ -189 +189 @@
 hotkey.selection.group.save.9 = "Ctrl+9"
 hotkey.selection.group.add.9 = "Shift+9"
 
+hotkey.selection.group.action.0 = H
+hotkey.selection.group.action.1 = J
+hotkey.selection.group.action.2 = K
+hotkey.selection.group.action.3 = L
+hotkey.selection.group.action.4 = Semicolon
+hotkey.selection.group.action.5 = SingleQuote
+hotkey.selection.group.action.6 = BackSlash
+hotkey.selection.group.action.7 = "Shift+H"
+hotkey.selection.group.action.8 = "Shift+J"
+hotkey.selection.group.action.9 = "Shift+K"
+hotkey.selection.group.action.10 = "Shift+L"
+hotkey.selection.group.action.11 = Colon
+hotkey.selection.group.action.12 = DoubleQuote
+
 ; > SESSION CONTROLS
 hotkey.session.kill = Delete                ; Destroy selected units
 hotkey.session.garrison = Ctrl              ; Modifier to garrison when clicking on building

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

@@ -15 +15 @@
 const ACTION_NONE = 0;
 const ACTION_GARRISON = 1;
 const ACTION_BUILD = 2;
+const ACTION_TRAIN = 4;
+const ACTION_UNGARRISON = 8;
+const ACTION_FORMATION = 16;
+const ACTION_STANCE = 32;
+const ACTION_BARTER = 64;
+const ACTION_TRADER =128;
 var preSelectedAction = ACTION_NONE;
+var _optionsOfpreSelected = [];
 
 const INPUT_NORMAL = 0;
 const INPUT_SELECTING = 1;
@@ -748 +755 @@
                 var queued = Engine.HotkeyIsPressed("session.queue");
                 if (tryPlaceBuilding(queued))
                 {
-                    if (queued)
+                    if (queued) {
                         inputState = INPUT_BUILDING_PLACEMENT;
-                    else
+                    } else {
                         inputState = INPUT_NORMAL;
+                        _optionsOfpreSelected = [];
+                    }
                 }
                 else
                 {
@@ -767 +776 @@
                 // Cancel building
                 placementSupport.Reset();
                 inputState = INPUT_NORMAL;
+                _optionsOfpreSelected = [];
                 return true;
             }
             break;
@@ -1039 +1049 @@
                     break;
                 preSelectedAction = ACTION_NONE;
                 inputState = INPUT_NORMAL;
+                _optionsOfpreSelected = [];
                 return doAction(action, ev);
             }
             else if (ev.button == SDL_BUTTON_RIGHT && preSelectedAction != ACTION_NONE)
             {
                 preSelectedAction = ACTION_NONE;
                 inputState = INPUT_NORMAL;
+                _optionsOfpreSelected = [];
                 break;
             }
             // else
+        case "hotkeydown":
+            if (!ev.hotkey)
+                break;
+
+            if (ev.hotkey.indexOf("selection.group.action.") == 0)
+            {
+                var sptr = ev.hotkey.split(".");
+                performGroup(sptr[2], sptr[3]);
+            }
+            break;
         default:
             // Slight hack: If selection is empty, reset the input state
             if (g_Selection.toList().length == 0)
             {
                 preSelectedAction = ACTION_NONE;
                 inputState = INPUT_NORMAL;
+                _optionsOfpreSelected = [];
                 break;
             }
         }
@@ -1086 +1109 @@
                     g_Selection.reset();
                     resetEntitySearch();
                     inputState = INPUT_NORMAL;
+                    _optionsOfpreSelected = [];
                     return true;
                 }
 
@@ -1161 +1185 @@
                 }
 
                 inputState = INPUT_NORMAL;
+                _optionsOfpreSelected = [];
                 return true;
             }
             break;
@@ -1223 +1248 @@
                 // Cancel building
                 placementSupport.Reset();
                 inputState = INPUT_NORMAL;
+                preSelectedAction = ACTION_NONE;
+                 _optionsOfpreSelected = [];
                 return true;
             }
             break;
@@ -1577 +1604 @@
     }
 }
 
+// This returns a list of actions. Caller still has to check Technology availability
+function getActionForSelection(player, selection)
+{
+    var ret = [];
+
+    for each (var ent in selection)
+    {
+        var state = GetEntityState(ent);
+        if (!state || (state.player != player && !g_DevSettings.controlAll))
+            continue;
+
+        switch (preSelectedAction)
+        {
+        case ACTION_GARRISON:
+            if (state.buildEntities || (hasClass(state, "Unit") && !hasClass(state, "Animal") && !state.garrisonHolder))
+                ret.push(ent);
+            break;
+        case ACTION_BUILD:
+            if (state.buildEntities && state.buildEntities.length)
+                return state.buildEntities;
+            break;
+        case ACTION_TRAIN:
+            if (state.production && state.production.entities.length)
+                return state.production.entities;
+            break;
+        case ACTION_UNGARRISON:
+            if (state.garrisonHolder && state.garrisonHolder.entities && state.garrisonHolder.entities.length)
+                ret.push(ent);
+            break;
+        case ACTION_FORMATION:
+        case ACTION_STANCE:
+            if (!hasClass(state, "Unit") || hasClass(state, "Animal") || state.garrisonHolder)
+                break;
+
+            if (preSelectedAction == ACTION_FORMATION) {
+                return Engine.GuiInterfaceCall("GetAvailableFormations");
+            } else { // FIXME:
+                return ["violent", "aggressive", "passive", "defensive", "standground"];
+            }
+            break;
+        case ACTION_BARTER:
+            if (state.barterMarket)
+                ret.push(ent);
+            break;
+        case ACTION_TRADER:
+            if (state.trader)
+                ret.push([ent, state]);
+            break;
+        default:
+            return ret; //shouldn't happen
+        }
+    }
+    return ret;
+}
+
 // Performs the specified group
 function performGroup(action, nr)
 {
@@ -1604 +1686 @@
         g_Groups.addEntities(nr, selection);
         updateGroups();
         break;
+    case "action":
+        if (!_optionsOfpreSelected.length) {
+            // action hotkey (first pass): With current selection, check possible
+            // ACTION_XXX's and set preSelectedAction when applicable
+            preSelectedAction = (1 << nr);
+
+            var selection = g_Selection.toList();
+            var player = Engine.GetPlayerID();
+
+            var actions = getActionForSelection(player, selection);
+            if (!actions || !actions.length) {
+                preSelectedAction = ACTION_NONE;
+                _optionsOfpreSelected = [];
+                break;
+            }
+
+            if (preSelectedAction == ACTION_BARTER)
+                setupUnitBarterPanel(state);
+            else if (preSelectedAction == ACTION_TRADER)
+                setupUnitTradingPanel(state, selection);
+
+            inputState = INPUT_PRESELECTEDACTION;
+            _optionsOfpreSelected = actions;
+        }
+        else
+        {
+            // 2nd action hotkey. Do preselectedAction[nr]
+            // The result depends on the action.
+
+            var lst = _optionsOfpreSelected;
+            if (!lst) // shouldn't happen
+                break;
+
+            if (preSelectedAction & (ACTION_UNGARRISON | ACTION_GARRISON))
+            {
+                if (preSelectedAction & ACTION_GARRISON)
+                    ++nr;
+                if (nr > lst.length)
+                    nr = lst.length;
+            } else if (preSelectedAction != (ACTION_BUILD|ACTION_TRAIN)) {
+                if (nr >= lst.length)
+                    break;
+                lst = lst[nr];
+            }
+
+            switch (preSelectedAction)
+            {
+            case ACTION_BUILD:
+                var tmpl = GetTemplateData(lst);
+                if (tmpl.requiredTechnology && !Engine.GuiInterfaceCall("IsTechnologyResearched", tmpl.requiredTechnology))
+                    break;
+
+                startBuildingPlacement(lst);
+                inputState = INPUT_BUILDING_PLACEMENT;
+                preSelectedAction = ACTION_NONE;
+                return;
+            case ACTION_TRAIN:
+                var tmpl = GetTemplateData(lst);
+                if (!tmpl.requiredTechnology || Engine.GuiInterfaceCall("IsTechnologyResearched", tmpl.requiredTechnology)) {
+                    var ents = g_Selection.toList();
+                    addTrainingToQueue(ents, lst);
+                }
+                break;
+            case ACTION_GARRISON: // we garison nr+1 count
+                g_Selection.reset();
+                lst.splice(nr, lst.length - nr)
+                g_Selection.addList(lst);
+                break;
+            case ACTION_UNGARRISON:
+                if (lst.length != 1 || nr == 0) {
+                    var state = GetEntityState(lst);
+                    var gents = state.garrisonHolder.entities
+                    unloadAll(lst[nr]);
+                    // TODO: follow when ungarrisoning all
+                    //var gents = g_Selection.toList();
+        //          Engine.CameraFollow(gents[0]);
+                } else {
+                    lst = lst[0];
+                    var state = GetEntityState(lst);
+                    var gents = state.garrisonHolder.entities;
+                    // FIXME unload nr times, requires some update.
+                    unload(lst, gents);
+                }
+                break;
+            case ACTION_FORMATION:
+                ents = g_Selection.toList();
+                var formationOk = Engine.GuiInterfaceCall("CanMoveEntsIntoFormation", {
+                    "ents": g_Selection.toList(),
+                    "formationName": lst
+                });
+                if (formationOk)
+                    performFormation(ents, lst);
+                break
+            case ACTION_STANCE:
+                ents = g_Selection.toList();
+                performStance(ents, lst);
+                break;
+            case ACTION_BARTER: //TODO
+                break;
+            case ACTION_TRADER: //TODO
+                break;
+            }
+            inputState = INPUT_NORMAL;
+            _optionsOfpreSelected = [];
+        }
     }
 }
 

binaries/data/config/default.cfg

@@ -151 +151 @@
 hotkey.selection.milonly = Alt              ; Add only military units to selection
 hotkey.selection.remove = Ctrl              ; Remove units from selection
 hotkey.selection.idleworker = Period        ; Select next idle worker
+hotkey.selection.structure = Y              ; Select structure
+hotkey.selection.civilcenter = U            ; Select towncenter
+hotkey.selection.dropsiteres = I            ; Select dropsite stone/wood/metal
+hotkey.selection.dropsitefood = O           ; Select dropsite food
+hotkey.selection.market = P                 ; Select market
 hotkey.selection.idlewarrior = Comma        ; Select next idle warrior
 hotkey.selection.offscreen = Alt            ; Include offscreen units in selection
 hotkey.selection.group.select.0 = 0

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

@@ -1084 +1084 @@
                 if (!ents.length)
                 {
                     g_Selection.reset();
-                    resetIdleUnit();
+                    resetEntitySearch();
                     inputState = INPUT_NORMAL;
                     return true;
                 }
@@ -1642 +1642 @@
 var lastEntity = 0;
 var currEntClass = 0;
 
-function resetIdleUnit()
+function resetEntitySearch()
 {
     lastEntity = 0;
     currEntClass = 0;
 }
 
-function findEntity(classes)
+function findEntity(classes, mode)
 {
     // Cycle through idling classes before giving up
     for (var i = 0; i <= classes.length; ++i)
     {
-        var data = { prevUnit: lastEntity, idleClass: classes[currEntClass] };
-        var newIdleUnit = Engine.GuiInterfaceCall("FindIdleUnit", data);
-
-        // Check if we have new valid entity
-        if (newIdleUnit && newIdleUnit != lastEntity)
+        var data = { prevEntity: lastEntity, entClass: classes[currEntClass], searchMode: mode};
+        var newEntity = Engine.GuiInterfaceCall("FindEntity", data);
+        if (newEntity && newEntity != lastEntity)
         {
-            lastEntity = newIdleUnit;
-            g_Selection.reset()
+            lastEntity = newEntity;
+            g_Selection.reset();
             g_Selection.addList([lastEntity]);
             Engine.CameraFollow(lastEntity);
-
             return;
         }
-
         lastEntity = 0;
         currEntClass = (currEntClass + 1) % classes.length;
     }
-
     // TODO: display a message or play a sound to indicate no more idle units, or something
     // Reset for next cycle
-    resetIdleUnit();
+    resetEntitySearch();
 }
 
 function unload(garrisonHolder, entities)

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

@@ -86 +86 @@
 
         <!-- Find idle warrior - TODO: Potentially move this to own UI button? -->
         <object hotkey="selection.idlewarrior">
-            <action on="Press">findEntity(["Hero", "Champion", "CitizenSoldier", "Siege", "Warship"]);</action>
+            <action on="Press">findEntity(["Hero", "Champion", "CitizenSoldier", "Siege", "Warship"], 1);</action>
+        </object>
+
+        <!-- Select civilcenter -->
+        <object hotkey="selection.civilcenter">
+            <action on="Press">findEntity(["CivCentre"], 0);</action>
+        </object>
+        <!-- Select market -->
+        <object hotkey="selection.market">
+            <action on="Press">findEntity(["BarterMarket", "Market", "NavalMarket"], 0);</action>
+        </object>
+        <!-- Select dropsitefood -->
+        <object hotkey="selection.dropsitefood">
+            <action on="Press">findEntity(["CivCentre", "DropsiteFood"], 0);</action>
+        </object>
+        <!-- Select dropsitewood -->
+        <object hotkey="selection.dropsiteres">
+            <action on="Press">findEntity(["CivCentre", "DropsiteWood", "DropsiteStone", "DropsiteMetal"], 0);</action>
+        </object>
+        <!-- Select structure -->
+        <object hotkey="selection.structure">
+            <action on="Press">findEntity(["Structure"], 0);</action>
         </object>
 
         <!-- ================================  ================================ -->
@@ -525 +546 @@
                     >
                         <!-- TODO: should highlight the button if there's non-zero idle workers -->
                         <object size="0 0 100% 100%" type="image" sprite="idleWorker" ghost="true" />
-                        <action on="Press">findEntity(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
+                        <action on="Press">findEntity(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"], 1);</action>
                     </object>
                 </object>
             </object>

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

@@ -1426 +1426 @@
     PlaySound(data.name, data.entity);
 };
 
-function isIdleUnit(ent, idleClass)
-{
-    var cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
-    var cmpIdentity = Engine.QueryInterface(ent, IID_Identity);
-    
-    // TODO: Do something with garrisoned idle units
-    return (cmpUnitAI && cmpIdentity && cmpUnitAI.IsIdle() && !cmpUnitAI.IsGarrisoned() && idleClass && cmpIdentity.HasClass(idleClass));
-}
-
-GuiInterface.prototype.FindIdleUnit = function(player, data)
+GuiInterface.prototype.FindEntity = function(player, data)
 {
     var rangeMan = Engine.QueryInterface(SYSTEM_ENTITY, IID_RangeManager);
     var playerEntities = rangeMan.GetEntitiesByPlayer(player);
@@ -1444 +1435 @@
     // so that we cycle around in a predictable order
     for each (var ent in playerEntities)
     {
-        if (ent > data.prevUnit && isIdleUnit(ent, data.idleClass))
-            return ent;
+        var cmpId = Engine.QueryInterface(ent, IID_Identity);
+        if (ent > data.prevEntity && cmpId && cmpId.HasClass(data.entClass)) {
+            if (data.searchMode == 0) {
+                return ent;
+            }  else if (data.searchMode == 1) { // Search idle villager/soldier
+                var cmpUnitAI = Engine.QueryInterface(ent, IID_UnitAI);
+                if (cmpUnitAI && cmpUnitAI.IsIdle() && !cmpUnitAI.IsGarrisoned())
+                    return ent;
+            }
+        }
     }
 
-    // No idle entities left in the class
+    // No entities left in the class
     return 0;
 };
 
@@ -1571 +1570 @@
     "SetWallPlacementPreview": 1,
     "GetFoundationSnapData": 1,
     "PlaySound": 1,
-    "FindIdleUnit": 1,
+    "FindEntity": 1,
     "GetTradingDetails": 1,
     "CanAttack": 1,
 

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

@@ -14 +14 @@
 
 const ACTION_NONE = 0;
 const ACTION_GARRISON = 1;
-const ACTION_REPAIR = 2;
+const ACTION_BUILD = 2;
 var preSelectedAction = ACTION_NONE;
 
 const INPUT_NORMAL = 0;
@@ -434 +434 @@
             else
                 return  {"type": "none", "cursor": "action-garrison-disabled", "target": undefined};
             break;
-        case ACTION_REPAIR:
+        case ACTION_BUILD:
             if (getActionInfo("repair", target).possible)
                 return {"type": "repair", "cursor": "action-repair", "target": target};
             else
@@ -1533 +1533 @@
                 break;
             case "repair":
                 inputState = INPUT_PRESELECTEDACTION;
-                preSelectedAction = ACTION_REPAIR;
+                preSelectedAction = ACTION_BUILD;
                 break;
             case "unload-all":
                 unloadAll(entity);
@@ -1578 +1578 @@
 }
 
 // Performs the specified group
-function performGroup(action, groupId)
+function performGroup(action, nr)
 {
     switch (action)
     {
@@ -1587 +1587 @@
     case "add":
         var toSelect = [];
         g_Groups.update();
-        for (var ent in g_Groups.groups[groupId].ents)
+        for (var ent in g_Groups.groups[nr].ents)
             toSelect.push(+ent);
 
         if (action != "add")
@@ -1600 +1600 @@
         break;
     case "save":
         var selection = g_Selection.toList();
-        g_Groups.groups[groupId].reset();
-        g_Groups.addEntities(groupId, selection);
+        g_Groups.groups[nr].reset();
+        g_Groups.addEntities(nr, selection);
         updateGroups();
         break;
     }
@@ -1639 +1639 @@
     Engine.CameraFollow(0);
 }
 
-var lastIdleUnit = 0;
-var currIdleClass = 0;
+var lastEntity = 0;
+var currEntClass = 0;
 
 function resetIdleUnit()
 {
-    lastIdleUnit = 0;
-    currIdleClass = 0;
+    lastEntity = 0;
+    currEntClass = 0;
 }
 
-function findIdleUnit(classes)
+function findEntity(classes)
 {
     // Cycle through idling classes before giving up
     for (var i = 0; i <= classes.length; ++i)
     {
-        var data = { prevUnit: lastIdleUnit, idleClass: classes[currIdleClass] };
+        var data = { prevUnit: lastEntity, idleClass: classes[currEntClass] };
         var newIdleUnit = Engine.GuiInterfaceCall("FindIdleUnit", data);
 
         // Check if we have new valid entity
-        if (newIdleUnit && newIdleUnit != lastIdleUnit)
+        if (newIdleUnit && newIdleUnit != lastEntity)
         {
-            lastIdleUnit = newIdleUnit;
+            lastEntity = newIdleUnit;
             g_Selection.reset()
-            g_Selection.addList([lastIdleUnit]);
-            Engine.CameraFollow(lastIdleUnit);
+            g_Selection.addList([lastEntity]);
+            Engine.CameraFollow(lastEntity);
 
             return;
         }
 
-        lastIdleUnit = 0;
-        currIdleClass = (currIdleClass + 1) % classes.length;
+        lastEntity = 0;
+        currEntClass = (currEntClass + 1) % classes.length;
     }
 
     // TODO: display a message or play a sound to indicate no more idle units, or something

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

@@ -86 +86 @@
 
         <!-- 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>
+            <action on="Press">findEntity(["Hero", "Champion", "CitizenSoldier", "Siege", "Warship"]);</action>
         </object>
 
         <!-- ================================  ================================ -->
@@ -525 +525 @@
                     >
                         <!-- TODO: should highlight the button if there's non-zero idle workers -->
                         <object size="0 0 100% 100%" type="image" sprite="idleWorker" ghost="true" />
-                        <action on="Press">findIdleUnit(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
+                        <action on="Press">findEntity(["Female", "Trade", "FishingBoat", "CitizenSoldier", "Healer"]);</action>
                     </object>
                 </object>
             </object>