adding "Reverse move" hotkey

lua/SimCallbacks.lua

@@ -826,6 +826,38 @@ do
 
 end
 
+do
+
+    ---@param data { Enable: boolean, ShowMsg: boolean }
+    ---@param selection Unit[]
+    Callbacks.ForceReverseMove = function(data, selection)
+        -- verify selection
+        if not data.Units then
+            selection = SecureUnits(selection)
+        else
+            selection = SecureUnits(data.Units)
+        end
+
+        if (not selection) or TableEmpty(selection) then
+            return
+        end
+
+        for k, unit in selection do
+            if unit.Blueprint.Physics.MaxSpeedReverse and unit.Blueprint.Physics.MaxSpeedReverse > 0 then
+                unit:ForceReverseMove(data.Enable)
+            end
+        end
+
+        if data.ShowMsg then
+            if data.Enable == true then
+                print(string.format("Force reverse move ENABLED for %d units", table.getn(selection)))
+            else
+                print(string.format("Force reverse move DISABLED for %d units", table.getn(selection)))
+            end
+        end
+    end
+end
+
 --#endregion
 
 

lua/keymap/keyactions.lua

@@ -1653,7 +1653,15 @@ local keyActionsOrdersAdvanced = {
     ['shift_discharge'] = {
         action = 'UI_Lua import("/lua/keymap/misckeyactions.lua").DischargeShields()',
         category = 'ordersAdvanced',
-    }
+    },
+    ['reverse_move'] = {
+        action = 'UI_Lua import("/lua/keymap/misckeyactions.lua").StartReverseMoveCommandMode()',
+        category = 'ordersAdvanced',
+    },
+    ['shift_reverse_move'] = {
+        action = 'UI_Lua import("/lua/keymap/misckeyactions.lua").StartReverseMoveCommandMode()',
+        category = 'ordersAdvanced',
+    },
 }
 
 local keyActionsOrdersQueueBased = {

lua/keymap/keydescriptions.lua

@@ -559,6 +559,8 @@ keyDescriptions = {
     ['shift_load_transports_clear'] = '<LOC key_desc_shift_load_transports_clear>Load into transports. Applies immediately',
     ['copy_orders'] = '<LOC key_desc_copy_orders>Copy orders of the unit the mouse is on top of',
     ['shift_copy_orders'] = '<LOC key_desc_shift_copy_orders>Copy orders of the unit the mouse is on top of',
+    ['reverse_move'] = '<LOC key_desc_reverse_move>Reverse move',
+    ['shift_reverse_move'] = '<LOC key_desc_shift_reverse_move>Reverse move',
 
     ['select_surface_bombers'] = '<LOC key_desc_0407>Select all Bombers (Normal)',
     ['select_torpedo_bombers'] = '<LOC key_desc_0408>Select all Bombers (Torpedo)',

lua/keymap/misckeyactions.lua

@@ -3,6 +3,7 @@
 local Prefs = import("/lua/user/prefs.lua")
 local SelectionUtils = import("/lua/ui/game/selection.lua")
 local SetIgnoreSelection = import("/lua/ui/game/gamemain.lua").SetIgnoreSelection
+local StartCommandMode = import("/lua/ui/game/commandmode.lua").StartCommandMode
 
 local lockZoomEnable = false
 function lockZoom()
@@ -557,6 +558,10 @@ AIPlatoonSimpleStructureBehavior = function()
     SimCallback({ Func = 'AIPlatoonSimpleStructureBehavior', Args = {} }, true)
 end
 
+function StartReverseMoveCommandMode()
+    StartCommandMode("order", {name = "RULEUCC_Move", isReverseMove = true})
+end
+
 StoreCameraPosition = function()
     local camera = GetCamera('WorldCamera')
     local settings = camera:SaveSettings()

lua/skins/skins.lua

@@ -201,6 +201,7 @@ skins = {
             RULEUCC_Teleport = {'/textures/ui/common/game/cursors/transport.dds', 15, 15},
             RULEUCC_Script = {'/textures/ui/common/game/cursors/attack.dds', 15, 15},
             RULEUCC_Invalid = {'/textures/ui/common/game/cursors/attack-invalid.dds', 15, 15},
+            RULEUCC_ReverseMove = {'/textures/ui/common/game/cursors/reverse_move-.dds', 15, 15, 12, 12},
             COORDINATED_ATTACK = {'/textures/ui/common/game/cursors/attack_coordinated.dds', 15, 15},
             MESSAGE = {'/textures/ui/common/game/cursors/message-.dds', 15, 15, 11, 12},
             BUILD = {'/textures/ui/common/game/cursors/selectable-.dds', 2, 2, 7, 12},

lua/ui/controls/worldview.lua

@@ -201,6 +201,9 @@ local orderToCursorCallback = {
     RULEUCC_Script = 'OnCursorScript',
     RULEUCC_Invalid = 'OnCursorInvalid',
     RULEUCC_CallTransport = 'OnCursorCallTransport',
+
+    -- A fake RULEUCC for cursor rendering. Actual CM in commandmode.lua is still RULEUCC_Move
+    RULEUCC_ReverseMove = 'OnCursorReverseMove',   
 
     -- misc
     CommandHighlight = 'OnCursorCommandHover',
@@ -392,6 +395,10 @@ WorldView = ClassUI(moho.UIWorldView, Control, WorldViewShapeComponent, WorldVie
                 if order == 'RULEUCC_Attack' then
                     order = 'RULEUCC_AttackGround'
                 end
+
+                if command_data.isReverseMove then
+                    order = 'RULEUCC_ReverseMove'
+                end
             -- 2. then command highlighting
             elseif self:HasHighlightCommand() then
                 order = 'CommandHighlight'
@@ -526,6 +533,21 @@ WorldView = ClassUI(moho.UIWorldView, Control, WorldViewShapeComponent, WorldVie
             self:EnableIgnoreMode(false)
         end
     end,
+
+    --- Called when the order `RULEUCC_ReverseMove` is being applied
+    ---@param self WorldView
+    ---@param identifier 'RULEUCC_ReverseMove'
+    ---@param enabled boolean
+    ---@param changed boolean
+    OnCursorReverseMove = function(self, identifier, enabled, changed)
+        if enabled then
+            if changed then
+                local cursor = self.Cursor
+                cursor[1], cursor[2], cursor[3], cursor[4], cursor[5] = UIUtil.GetCursor(identifier)
+                self:ApplyCursor()
+            end
+        end
+    end,
 
     --- Called when the order `RULEUCC_Guard` is being applied
     ---@param self WorldView

lua/ui/game/commandmode.lua

@@ -139,6 +139,9 @@ local issuedOneCommand = false
 local startBehaviors = {}
 local endBehaviors = {}
 
+local reverseMoveCMIsActive = false
+local ReverseMoveEnabledUnits = {}
+
 --- Callback triggers when command mode starts
 ---@param behavior fun(mode?: CommandMode, data?: CommandModeData)
 ---@param identifier? string
@@ -181,6 +184,10 @@ function StartCommandMode(newCommandMode, data)
     if commandMode then
         EndCommandMode(true)
     end
+
+    if data.isReverseMove then
+        reverseMoveCMIsActive = true
+    end
 
     -- update our local state
     commandMode = newCommandMode
@@ -198,7 +205,9 @@ function EndCommandMode(isCancel)
     if ignoreSelection then
         return
     end
-
+
+    reverseMoveCMIsActive = false
+
     -- in case we want to end the command mode, without knowing it has already ended or not
     if modeData then
         -- add information to modeData for end behavior
@@ -644,6 +653,62 @@ local function OnStopIssued(command)
     EnhancementQueueFile.clearEnhancements(command.Units)
 end
 
+local function EnableReverseMove(command)
+    local EnableReverseMoveFor = {}
+
+    for _,unit in command.Units do
+        local bp = unit:GetBlueprint()
+        if bp.Physics.MaxSpeedReverse and bp.Physics.MaxSpeedReverse > 0 then
+            local commandQueue = unit:GetCommandQueue()
+            local queueLength = TableGetN(commandQueue)
+            local entityID = unit:GetEntityId()
+
+            -- make reverse move a single command without being able to queue it or combine with other commands
+            -- this is the easiest way to avoid making some complex tracking system for the queue that
+            -- contains different orders including reverse move.
+            if queueLength > 1 then
+                for k, cmd in commandQueue do
+                    if k ~= queueLength then
+                        DeleteCommand(cmd.ID)
+                    end
+                end
+            end
+
+            ReverseMoveEnabledUnits[entityID] = unit
+            TableInsert(EnableReverseMoveFor, entityID)
+        end
+    end
+
+    local cb = { Func = 'ForceReverseMove', Args = { Enable = true, ShowMsg = false, Units = EnableReverseMoveFor } }
+    SimCallback(cb, false)
+end
+
+-- If there are any units on the map with ReverseMove enabled (ReverseMoveEnabledUnits is not empty)
+-- then we have to check if these units are in the command.Units list every time OnCommandIssued is triggered (without reverseMoveCMIsActive)
+-- and if yes - disable reverse move for them via SimCallback.
+local function DisableReverseMove(command)
+    -- remove dead units
+    for k, u in ReverseMoveEnabledUnits do
+        if u:IsDead() then
+            ReverseMoveEnabledUnits[k] = nil
+        end
+    end
+
+    local disableReverseMoveFor = {}
+    for _,unit in command.Units do
+        local id = unit:GetEntityId()
+        if ReverseMoveEnabledUnits[id] then
+            TableInsert(disableReverseMoveFor, id)
+            ReverseMoveEnabledUnits[id] = nil
+        end
+    end
+
+    if not TableEmpty(disableReverseMoveFor) then
+        local cb = { Func = 'ForceReverseMove', Args = { Enable = false, ShowMsg = false, Units = disableReverseMoveFor} }
+        SimCallback(cb, false)
+    end
+end
+
 -- Callbacks for different command types, nil values for reference to functions that don't exist yet
 local OnCommandIssuedCallback = {
     None = nil,
@@ -691,6 +756,12 @@ function OnCommandIssued(command)
         issuedOneCommand = true
     end
 
+    if reverseMoveCMIsActive then
+        EnableReverseMove(command)
+    elseif not TableEmpty(ReverseMoveEnabledUnits) then
+        DisableReverseMove(command)
+    end
+
     -- If our callback returns true or we don't have a command type, we skip the rest of our logic
     if (OnCommandIssuedCallback[command.CommandType] and OnCommandIssuedCallback[command.CommandType](command))
     or command.CommandType == 'None' then