WorldviewCommandModeTableStreamline

changelog/snippets/other.6585.md

@@ -0,0 +1 @@
+(#6585) Minor streamlining to GetCommandModeCalls in controls/worldview.lua, and allow alt attack move pref to work properly.

lua/ui/controls/worldview.lua

@@ -32,6 +32,8 @@ local KeyCodeAlt = 18
 local KeyCodeCtrl = 17
 local KeyCodeShift = 16
 
+local commandModeTable = CommandMode.GetCommandMode()
+
 local unitsToWeaponsCached = { }
 
 ---@class Renderable : Destroyable
@@ -346,7 +348,7 @@ WorldView = ClassUI(moho.UIWorldView, Control) {
     OnUpdateCursor = function(self)
         -- gather all information
         local selection = GetSelectedUnits()
-        local command_mode, command_data = unpack(CommandMode.GetCommandMode())     -- is set when we issue orders manually, try to build something, etc
+        local command_mode, command_data = unpack(commandModeTable)     -- is set when we issue orders manually, try to build something, etc
         local orderViaMouse = self:GetRightMouseButtonOrder()                       -- is set when our mouse is over a hostile unit, reclaim, etc and not in command mode
         local holdAltToAttackMove = Prefs.GetFieldFromCurrentProfile('options').alt_to_force_attack_move
 
@@ -377,9 +379,6 @@ WorldView = ClassUI(moho.UIWorldView, Control) {
             -- 3. then whatever is below the mouse
             elseif orderViaMouse and orderViaMouse != 'RULEUCC_Move' then
                 order = orderViaMouse
-            -- 4. then if we hold alt, we'll show the attack cursor
-            elseif IsKeyDown(KeyCodeAlt) and selection then
-                order = 'RULEUCC_Attack'
             end
         end
 
@@ -556,8 +555,7 @@ WorldView = ClassUI(moho.UIWorldView, Control) {
 
         -- otherwise we only show it if we're in command mode
         else
-            local commandData = CommandMode.GetCommandMode()
-            local viaCommandMode = commandData[1] and commandData[1] == 'order' and commandData[2].name == 'RULEUCC_Attack'
+            local viaCommandMode = commandModeTable[1] and commandModeTable[1] == 'order' and commandModeTable[2].name == 'RULEUCC_Attack'
             if viaCommandMode then
                 local commandModeChange = (viaCommandMode != self.ViaCommandModeOld)
                 self:OnCursorDecals(identifier, enabled or commandModeChange, changed or commandModeChange, AttackDecalFunc)
@@ -635,7 +633,7 @@ WorldView = ClassUI(moho.UIWorldView, Control) {
                 local cursor = self.Cursor
                 cursor[1], cursor[2], cursor[3], cursor[4], cursor[5] = UIUtil.GetCursor(identifier)
                 self:ApplyCursor()
-                CommandMode.GetCommandMode()[2].reticle = TeleportReticle(self)
+                commandModeTable[2].reticle = TeleportReticle(self)
             end
         end
     end,
@@ -705,8 +703,7 @@ WorldView = ClassUI(moho.UIWorldView, Control) {
     OnCursorReclaim = function(self, identifier, enabled, changed)
 
         -- allows us to make easier distinctions for the status quo, note that this becomes invalid once we change
-        local commandData = CommandMode.GetCommandMode()
-        local viaCommandMode = commandData[1] and commandData[1] == 'order' and commandData[2].name == 'RULEUCC_Reclaim'
+        local viaCommandMode = commandModeTable[1] and commandModeTable[1] == 'order' and commandModeTable[2].name == 'RULEUCC_Reclaim'
         local viaRightMouseButton = self:GetRightMouseButtonOrder() == 'RULEUCC_Reclaim' -- always returns nil when in command mode
         local canIssueReclaimOrders = self:CanIssueReclaimOrders()
 

lua/ui/game/commandmode.lua

@@ -126,6 +126,9 @@ local issuedOneCommand = false
 local startBehaviors = {}
 local endBehaviors = {}
 
+-- allocate the table once for performance
+local commandModeTable = {commandMode, modeData}
+
 --- Callback triggers when command mode starts
 ---@param behavior fun(mode?: CommandMode, data?: CommandModeData)
 ---@param identifier? string
@@ -172,6 +175,8 @@ function StartCommandMode(newCommandMode, data)
     -- update our local state
     commandMode = newCommandMode
     modeData = data
+    commandModeTable[1] = commandMode
+    commandModeTable[2] = modeData
 
     -- do start behaviors
     for i, v in startBehaviors do
@@ -210,6 +215,8 @@ function EndCommandMode(isCancel)
     -- update our local state
     commandMode = false
     modeData = false
+    commandModeTable[1] = commandMode
+    commandModeTable[2] = modeData
     issuedOneCommand = false
 end
 
@@ -223,6 +230,8 @@ function CacheAndClearCommandMode()
     CacheCommandMode()
     commandMode = false
     modeData = false
+    commandModeTable[1] = commandMode
+    commandModeTable[2] = modeData
 end
 
 --- Restores the cached command mode
@@ -236,14 +245,9 @@ function RestoreCommandMode(ignorePreviousCommands)
     end
 end
 
--- allocate the table once for performance
-local commandModeTable = {}
-
---- Retrieves the current command mode information.
+--- Retrieves the commandModeTable. You typically only need to call this once, after which the table reference can be stored as a local.
 ---@return { [1]: CommandModeDataOrder, [2]: CommandModeData }
 function GetCommandMode()
-    commandModeTable[1] = commandMode
-    commandModeTable[2] = modeData
     return commandModeTable
 end