Finalize basic implementation of a structure manager (FAForever#4970)

* Initial draft of structure manager

* Finalize draft for basic ai structure behavior

* Upgrade builders for extractors are working

* Finalize basic structure manager

lua/SimCallbacks.lua

@@ -864,5 +864,5 @@ Callbacks.GridPresenceDebugDisable = import("/lua/ai/gridpresence.lua").DisableD
 Callbacks.AIBrainEconomyDebugEnable = import("/lua/aibrains/components/economy.lua").EnableDebugging
 Callbacks.AIBrainEconomyDebugDisable = import("/lua/aibrains/components/economy.lua").DisableDebugging
 
-Callbacks.AIPlatoonSiloTacticalBehavior = import("/lua/aibrains/platoons/platoon-silo.lua").DebugAssignToUnits
 Callbacks.AIPlatoonSimpleRaidBehavior = import("/lua/aibrains/platoons/platoon-simple-raid.lua").DebugAssignToUnits
+Callbacks.AIPlatoonSimpleStructureBehavior = import("/lua/aibrains/platoons/platoon-simple-structure.lua").DebugAssignToUnits

lua/aibrains/managers/base-manager.lua

@@ -105,7 +105,7 @@ AIBase = ClassSimple {
     ---@param manager AIBuilderManager
     AddBuilderGroup = function(self, builderGroupTemplate, manager)
         if Debug then
-            SPEW("Loading builder group template: " .. builderGroupTemplate.BuilderGroupName)
+            SPEW("Loading builder group template: " .. builderGroupTemplate.BuilderGroupName .. " for " .. manager.ManagerName)
         end
 
         local builderTemplates = builderGroupTemplate.BuilderTemplates

lua/aibrains/managers/builder-manager.lua

@@ -32,6 +32,8 @@ end
 ---@field Trash TrashBag                            # Trashbag of this manager
 AIBuilderManager = ClassSimple {
 
+    ManagerName = "BuilderManager",
+
     ---@param self AIBuilderManager
     ---@param brain AIBrain
     Create = function(self, brain, base, locationType)
@@ -113,16 +115,20 @@ AIBuilderManager = ClassSimple {
 
     --- Retrieves the highest builder that is valid with the given parameters
     ---@param self AIBuilderManager
-    ---@param builderType BuilderType
     ---@param platoon AIPlatoon
     ---@param unit Unit
     ---@return AIBuilder?
-    GetHighestBuilder = function(self, builderType, platoon, unit)
-        local builderData = self.BuilderData[builderType]
+    GetHighestBuilder = function(self, platoon, unit, unitType)
+        local builderData = self.BuilderData[unitType]
         if not builderData then
-            error('*BUILDERMANAGER ERROR: Invalid builder type - ' .. builderType)
+            return nil
         end
 
+        -- used to quickly reject builders
+        local unitTech = unit.Blueprint.TechCategory
+        local unitLayer = unit.Blueprint.LayerCategory
+        local unitFaction = unit.Blueprint.FactionCategory
+
         local tick = GetGameTick()
         local brain = self.Brain
         local base = self.Base
@@ -134,6 +140,25 @@ AIBuilderManager = ClassSimple {
         local builders = builderData.Builders
         for k in builders do
             local builder = builders[k] --[[@as AIBuilder]]
+            local builderTemplate = builder.Template
+
+            -- check tech requirement
+            local builderTech = builderTemplate.BuilderTech
+            if builderTech and builderTech != unitTech then
+                continue
+            end
+
+            -- check layer requirement
+            local builderLayer = builderTemplate.BuilderLayer
+            if builderLayer and builderLayer != unitLayer then
+                continue
+            end
+
+            -- check faction requirement
+            local builderFaction = builderTemplate.BuilderFaction
+            if builderFaction and builderFaction != unitFaction then
+                continue
+            end
 
             -- builders with no priority are ignored
             local priority = builder.Priority

lua/aibrains/managers/engineer-manager.lua

@@ -5,7 +5,7 @@
 --****************************************************************************
 
 local AIBuilderManager = import("/lua/aibrains/managers/builder-manager.lua").AIBuilderManager
-local AIPlatoonEngineer = import("/lua/aibrains/platoons/platoon-engineer.lua").AIPlatoonEngineer
+-- local AIPlatoonEngineer = import("/lua/aibrains/platoons/platoon-engineer.lua").AIPlatoonEngineer
 
 local TableGetSize = table.getsize
 
@@ -34,6 +34,8 @@ local WeakValues = { __mode = 'v' }
 ---@field EngineerCount AIEngineerManagerCount      # Recomputed every 10 ticks
 AIEngineerManager = Class(AIBuilderManager) {
 
+    ManagerName = "EngineerManager",
+
     ---@param self AIEngineerManager
     ---@param brain AIBrain
     ---@param base AIBase
@@ -258,29 +260,6 @@ AIEngineerManager = Class(AIBuilderManager) {
     --------------------------------------------------------------------------------------------
     -- engineer manager interface
 
-    ---@param self AIEngineerManager
-    ---@param unit Unit
-    AssignPlatoon = function(self, unit)
-        -- switch any existing behavior to the blank state
-        local aiPlatoon = unit.AIPlatoonReference
-        if aiPlatoon then
-            aiPlatoon:ChangeState('Blank')
-        end
-
-        -- create the platoon, switch metatables and assign the unit
-        local platoon = self.Brain:MakePlatoon('Engineer platoon', '') --[[@as AIPlatoonEngineer]]
-        setmetatable(platoon, AIPlatoonEngineer)
-        self.Brain:AssignUnitsToPlatoon(platoon, {unit}, 'support', 'none')
-        unit.AIPlatoonReference = platoon
-
-        -- assign assets required for this platoon
-        platoon.Brain = self.Brain
-        platoon.Base = self.Base
-
-        -- enable the build behavior
-        platoon:ChangeState('AIBehaviorBuild')
-    end,
-
     ---@param self AIEngineerManager
     ---@param platoon AIPlatoonEngineer
     ---@param unit Unit

lua/aibrains/managers/factory-manager.lua

@@ -40,6 +40,8 @@ local MapFactionCategory = {
 ---@field FactoryBeingBuiltCount AIFactoryManagerCounts     # Recomputed every 10 ticks
 AIFactoryManager = Class(BuilderManager) {
 
+    ManagerName = "FactoryManager",
+
     ---@param self AIFactoryManager
     ---@param brain AIBrain
     ---@param base AIBase

lua/aibrains/managers/structure-manager.lua

@@ -27,6 +27,8 @@ local WeakValues = { __mode = 'v' }
 ---@field StructureBeingBuiltCount AIStructureManagerCounts     # Recomputed every 10 ticks
 AIStructureManager = Class(BuilderManager) {
 
+    ManagerName = "StructureManager",
+
     ---@param self AIStructureManager
     ---@param brain AIBrain
     ---@param base AIBase
@@ -80,7 +82,7 @@ AIStructureManager = Class(BuilderManager) {
                 engineerCount[tech] = count
                 total = total + count
             end
-    
+
             local StructureBeingBuilt = self.StructuresBeingBuilt
             local StructureBeingBuiltCount = self.StructureBeingBuiltCount
             for tech, _ in StructureBeingBuiltCount do
@@ -96,10 +98,6 @@ AIStructureManager = Class(BuilderManager) {
     -- unit events
 
     --- Called by a unit as it starts being built
-    --- 
-    --- `Time complexity: O(1)`
-    --- 
-    --- `Memory complexity: O(1)`
     ---@param self AIStructureManager
     ---@param unit Unit
     ---@param builder Unit
@@ -110,20 +108,10 @@ AIStructureManager = Class(BuilderManager) {
             local tech = blueprint.TechCategory
             local id = unit.EntityId
             self.StructuresBeingBuilt[tech][id] = unit
-
-            -- used by platoon functions to find the manager
-            local builderManagerData = unit.BuilderManagerData or { }
-            unit.BuilderManagerData = builderManagerData
-            builderManagerData.StructureManager = self
-            builderManagerData.LocationType = self.LocationType
         end
     end,
 
     --- Called by a unit as it is finished being built
-    --- 
-    --- `Time complexity: O(1)`
-    --- 
-    --- `Memory complexity: O(1)`
     ---@param self AIStructureManager
     ---@param unit Unit
     ---@param builder Unit
@@ -136,19 +124,19 @@ AIStructureManager = Class(BuilderManager) {
             self.StructuresBeingBuilt[tech][id] = nil
             self.Structures[tech][id] = unit
 
-            -- used by platoon functions to find the manager
-            local builderManagerData = unit.BuilderManagerData or { }
-            unit.BuilderManagerData = builderManagerData
-            builderManagerData.StructureManager = self
-            builderManagerData.LocationType = self.LocationType
+            -- create the platoon and start the behavior
+            local brain = self.Brain
+            local platoon = brain:MakePlatoon('', '') --[[@as AIPlatoonSimpleStructure]]
+            platoon.Brain = self.Brain
+            platoon.Base = self.Base
+
+            setmetatable(platoon, import("/lua/aibrains/platoons/platoon-simple-structure.lua").AIPlatoonSimpleStructure)
+            brain:AssignUnitsToPlatoon(platoon, {unit}, 'Unassigned', 'None')
+            ChangeState(platoon, platoon.Start)
         end
     end,
 
     --- Called by a unit as it is destroyed
-    --- 
-    --- `Time complexity: O(1)`
-    --- 
-    --- `Memory complexity: O(1)`
     ---@param self AIStructureManager
     ---@param unit Unit
     OnUnitDestroyed = function(self, unit)
@@ -166,62 +154,30 @@ AIStructureManager = Class(BuilderManager) {
     ---@param unit Unit
     ---@param built Unit
     OnUnitStartBuilding = function(self, unit, built)
-        local blueprint = unit.Blueprint
-        if blueprint.CategoriesHash['STRUCTURE'] then
-        end
     end,
 
     --- Called by a unit as it stops building
     ---@param self BuilderManager
     ---@param unit Unit
     ---@param built Unit
     OnUnitStopBuilding = function(self, unit, built)
-        local blueprint = unit.Blueprint
-        if blueprint.CategoriesHash['STRUCTURE'] then
-        end
     end,
 
     --------------------------------------------------------------------------------------------
     -- unit interface
 
-    --- Add a unit to, similar to calling `OnUnitStopBeingBuilt`
-    --- 
-    --- `Time complexity: O(1)`
-    --- 
-    --- `Memory complexity: O(1)`
+    --- Add a unit, similar to calling `OnUnitStopBeingBuilt`
     ---@param self AIStructureManager
     ---@param unit Unit
     AddUnit = function(self, unit)
-        local blueprint = unit.Blueprint
-        if blueprint.CategoriesHash['STRUCTURE'] then
-            local tech = blueprint.TechCategory
-            local id = unit.EntityId
-            self.StructuresBeingBuilt[tech][id] = nil
-            self.Structures[tech][id] = unit
-
-            -- used by platoon functions to find the manager
-            local builderManagerData = unit.BuilderManagerData or { }
-            unit.BuilderManagerData = builderManagerData
-            builderManagerData.StructureManager = self
-            builderManagerData.LocationType = self.LocationType
-        end
+        self:OnUnitStopBeingBuilt(unit, nil, unit.Layer)
     end,
 
     --- Remove a unit, similar to calling `OnUnitDestroyed`
-    --- 
-    --- `Complexity: O(1)`
-    --- 
-    --- `Memory complexity: O(1)`
     ---@param self AIStructureManager
     ---@param unit Unit
     RemoveUnit = function(self, unit)
-        local blueprint = unit.Blueprint
-        if blueprint.CategoriesHash['STRUCTURE'] then
-            local tech = blueprint.TechCategory
-            local id = unit.EntityId
-            self.StructuresBeingBuilt[tech][id] = nil
-            self.Structures[tech][id] = nil
-        end
+        self:OnUnitDestroyed(unit)
     end,
 }