Fix command source not matching army index in AI games (#7038)

Author: lL1l1

changelog/snippets/fix.7038.md

@@ -0,0 +1 @@
+- (#7038) Fix various sim callbacks detecting the incorrect army as the source of the callback in games with AI or observers. This fixes the issue where paintings were displayed to the incorrect players in AI games.

engine/Sim.lua

@@ -600,9 +600,13 @@ end
 function GetArmyUnitCostTotal(army)
 end
 
---- Returns the currently active command source in the sim state. This number is the army index
---- of the army that sent the command.
----@return number
+--- Returns the currently active command source in the sim state. This is the index of the client
+--- that issued the command, which is from a list including players (human armies) and observers.
+--- The list is in the order of the lobby slots, with observers at the end.
+---
+--- Use `GetCurrentCommandSourceArmy` from `SimUtils.lua` to reliably get the army index of the 
+--- current command source.
+---@return integer
 function GetCurrentCommandSource()
 end
 

lua/SimCallbacks.lua

@@ -43,6 +43,8 @@ local IssueAggressiveMove = IssueAggressiveMove
 local IssueGuard = IssueGuard
 local IssueFerry = IssueFerry
 
+local GetCurrentCommandSourceArmy = SimUtils.GetCurrentCommandSourceArmy
+
 -- upvalue categories for performance
 local CategoriesTransportation = categories.TRANSPORTATION
 
@@ -64,7 +66,18 @@ function DoCallback(name, data, units)
 
     local timeTaken = GetSystemTimeSecondsOnlyForProfileUse() - start
     if (timeTaken > 0.005) then
-        SPEW(string.format("Time to process %s from %d: %f", name, timeTaken, GetCurrentCommandSource() or -2))
+        local commandSourceNickname
+        local commandSourceArmy = GetCurrentCommandSourceArmy()
+        if commandSourceArmy then
+            commandSourceNickname = tostring(ArmyBrains[commandSourceArmy].Nickname)
+        else
+            commandSourceNickname = string.format("Observer (source %d)", GetCurrentCommandSource())
+        end
+        SPEW(string.format("Time to process \"%s\" from %s: %f"
+            , name
+            , commandSourceNickname
+            , timeTaken
+        ))
     end
 end
 
@@ -640,7 +653,7 @@ do
         -- verify selection
         selection = SecureUnits(selection)
         if (not selection) or TableEmpty(selection) then
-            if (GetFocusArmy() == GetCurrentCommandSource()) then
+            if (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
                 print("Unable to interrupt path finding")
             end
 
@@ -650,7 +663,7 @@ do
         -- only apply this to engineers
         local engineers = EntityCategoryFilterDown(categories.ENGINEER + categories.COMMAND, selection)
         if table.empty(engineers) then
-            if (GetFocusArmy() == GetCurrentCommandSource()) then
+            if (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
                 print("Unable to interrupt path finding")
             end
 
@@ -663,7 +676,7 @@ do
         local commandSourceGuard = CommandSourceGuards[commandSource]
 
         if commandSourceGuard and commandSourceGuard + 5 >= gameTick then
-            if (GetFocusArmy() == GetCurrentCommandSource()) then
+            if (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
                 print("Unable to interrupt path finding")
             end
 
@@ -686,7 +699,7 @@ do
         -- verify selection
         selection = SecureUnits(selection)
         if (not selection) or TableEmpty(selection) then
-            if (GetFocusArmy() == GetCurrentCommandSource()) then
+            if (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
                 print("Unable to discharge")
             end
 
@@ -705,7 +718,7 @@ do
         end
 
         if table.empty(unitsWithShields) then
-            if (GetFocusArmy() == GetCurrentCommandSource()) then
+            if (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
                 print("Unable to discharge")
             end
 
@@ -718,7 +731,7 @@ do
         local commandSourceGuard = CommandSourceGuards[commandSource]
 
         if commandSourceGuard and commandSourceGuard + 5 >= gameTick then
-            if (GetFocusArmy() == GetCurrentCommandSource()) then
+            if (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
                 print("Unable to discharge")
             end
 
@@ -837,7 +850,7 @@ do
     ---@param data UIShareableBrushStrokeCallbackMessage
     local SyncPainting = function(data)
         -- used to determine the color of the painting
-        data.ShareablePainting.PeerName = GetArmyBrain(GetCurrentCommandSource()).Nickname
+        data.ShareablePainting.PeerName = GetArmyBrain(GetCurrentCommandSourceArmy()).Nickname
 
         Sync.SharePaintingBrushStroke = Sync.SharePaintingBrushStroke or {}
         table.insert(Sync.SharePaintingBrushStroke, data)
@@ -846,7 +859,7 @@ do
     ---@param data UIShareableBrushStrokeCallbackMessage
     Callbacks.SharePaintingBrushStroke = function(data)
         local focusArmy = GetFocusArmy()
-        local currentCommandSource = GetCurrentCommandSource()
+        local currentCommandSourceArmy = GetCurrentCommandSourceArmy()
 
         -- spectators are able to see all paintings. We take into account
         -- the original focus army because spectators can change focus army
@@ -856,7 +869,7 @@ do
         end
 
         -- allies are able to see each others paintings
-        if IsAlly(focusArmy, currentCommandSource) then
+        if IsAlly(focusArmy, currentCommandSourceArmy) then
             SyncPainting(data)
             return
         end
@@ -882,7 +895,6 @@ local function PassesAIAntiCheatCheck()
     return ScenarioInfo.GameHasAIs or PassesAntiCheatCheck()
 end
 
-
 local SpawnedMeshes = {}
 
 local function SpawnUnitMesh(id, x, y, z, pitch, yaw, roll)
@@ -1417,8 +1429,14 @@ end
 ---@param data CallbackModeratorEventData
 Callbacks.ModeratorEvent = function(data)
     -- show up in the game logs
-    local brain = GetArmyBrain(GetCurrentCommandSource())
-    SPEW(string.format("Moderator event for %s: %s", tostring(brain.Nickname), tostring(data.Message)))
+    local commandSourceNickname
+    local commandSourceArmy = GetCurrentCommandSourceArmy()
+    if commandSourceArmy then
+        commandSourceNickname = tostring(GetArmyBrain(commandSourceArmy).Nickname)
+    else
+        commandSourceNickname = string.format("Observer (source %d)", GetCurrentCommandSource())
+    end
+    SPEW(string.format("Moderator event for %s: %s", commandSourceNickname, tostring(data.Message)))
 end
 
 --#endregion

lua/SimUtils.lua

@@ -4,6 +4,7 @@
 
 -- upvalues for performance
 local ArmyBrains = ArmyBrains
+local GetCurrentCommandSource = GetCurrentCommandSource
 
 ------------------------------------------------------------------------------------------------------------------------
 --#region General Unit Transfer Scripts
@@ -1541,3 +1542,30 @@ function DrawBone(entity, bone, length)
     -- Z axis
     DrawLine(pos, pos + forward * length, '0000ff')
 end
+
+local CommandSourceToArmyMap
+--- Retrieves the army index corresponding to the given command source index.
+---@param source integer
+---@return integer
+function GetArmyOfCommandSource(source)
+    if not CommandSourceToArmyMap then
+        CommandSourceToArmyMap = {}
+        local commandSourceIndex = 1
+        for index, army in ArmyBrains do
+            if army.Human then
+                CommandSourceToArmyMap[commandSourceIndex] = index
+                commandSourceIndex = commandSourceIndex + 1
+            end
+        end
+    end
+
+    return CommandSourceToArmyMap[source]
+end
+
+--- Retrieves the army index corresponding to the current command source.
+---@return integer
+function GetCurrentCommandSourceArmy()
+    return GetArmyOfCommandSource(GetCurrentCommandSource())
+end
+
+

lua/sim/commands/area-reclaim-order.lua

@@ -31,6 +31,8 @@ local StringFormat = string.format
 
 local IssueReclaim = IssueReclaim
 
+local GetCurrentCommandSourceArmy = import("/lua/SimUtils.lua").GetCurrentCommandSourceArmy
+
 ---@type table<EntityId, boolean>
 local distances = { }
 
@@ -86,7 +88,7 @@ local function ReclaimAdjacentUnits (units, target, doPrint)
         end
     end
 
-    if doPrint and processed > 0 and (GetFocusArmy() == GetCurrentCommandSource()) then
+    if doPrint and processed > 0 and (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
         print(StringFormat("Reclaiming %d adjacent units", processed))
     end
 end
@@ -197,7 +199,7 @@ function AreaReclaimProps(units, ps, pe, width, doPrint)
         end
     end
 
-    if doPrint and (GetFocusArmy() == GetCurrentCommandSource()) then
+    if doPrint and (GetFocusArmy() == GetCurrentCommandSourceArmy()) then
         if processed > 0 then
             print(StringFormat("Reclaiming %d additional props", processed))
         end