FACTO-286: Cleanup compression code, added cooldown, check group state

control.lua

@@ -131,7 +131,6 @@ local getDrainPylonPair = ChunkPropertyUtils.getDrainPylonPair
 
 local createDrainPylon = UnitUtils.createDrainPylon
 
-local compressSquad = Squad.compressSquad
 local decompressSquad = Squad.decompressSquad
 
 local isDrained = ChunkPropertyUtils.isDrained
@@ -459,7 +458,7 @@ local function onDeath(event)
             if group then
                 local squad = Universe.groupNumberToSquad[group.group_number]
                 if squad then
-                    decompressSquad(squad)
+                    decompressSquad(squad, tick)
                     if damageTypeName then
                         base = squad.base
                     end

libs/Constants.lua

@@ -209,6 +209,8 @@ constants.SQUAD_BUILDING = 6
 
 -- Squad Related
 
+constants.COMPRESSION_COOLDOWN = 600
+
 constants.MINIMUM_EXPANSION_DISTANCE = 10
 
 constants.RETREAT_GRAB_RADIUS = 24

libs/Squad.lua

@@ -49,6 +49,8 @@ local ENEMY_PHEROMONE = Constants.ENEMY_PHEROMONE
 local KAMIKAZE_PHEROMONE = Constants.KAMIKAZE_PHEROMONE
 local RESOURCE_PHEROMONE = Constants.RESOURCE_PHEROMONE
 
+local COMPRESSION_COOLDOWN = Constants.COMPRESSION_COOLDOWN
+
 local HALF_CHUNK_SIZE = Constants.HALF_CHUNK_SIZE
 
 local FIVE_DEATH_PHEROMONE_GENERATOR_AMOUNT = Constants.FIVE_DEATH_PHEROMONE_GENERATOR_AMOUNT
@@ -80,6 +82,10 @@ local AI_VENGENCE_SQUAD_COST = Constants.AI_VENGENCE_SQUAD_COST
 local AI_VENGENCE_SETTLER_COST = Constants.AI_VENGENCE_SETTLER_COST
 local CHUNK_ALL_DIRECTIONS = Constants.CHUNK_ALL_DIRECTIONS
 
+local ATTACKING_DISTRACTION = defines.group_state.attacking_distraction
+local ATTACKING_TARGET = defines.group_state.attacking_target
+local GATHERING = defines.group_state.gathering
+
 -- imported functions
 
 local setPositionInQuery = Utils.setPositionInQuery
@@ -297,20 +303,29 @@ local function addMovementPenalty(squad, chunk)
                   c = chunk })
 end
 
-function Squad.compressSquad(squad)
-    if not squad.canBeCompressed then
+local function compressSquad(squad, tick)
+    if squad.compressionSet
+        or (Universe.squadCompressionThreshold == -1)
+        or (squad.canBeCompressed >= tick)
+    then
         return
     end
 
-    local compressionSet = {}
     local group = squad.group
-    local members = group.members
-    if (Universe.squadCompressionThreshold == -1)
-        or (#members <= Universe.squadCompressionThreshold)
+    local groupState = group.state
+    if (groupState == ATTACKING_DISTRACTION)
+        or (groupState == ATTACKING_TARGET)
+        or (groupState == GATHERING)
+        or (squad.status == SQUAD_BUILDING)
     then
-        squad.canBeCompressed = false
         return
     end
+    local members = group.members
+    if (#members <= Universe.squadCompressionThreshold) then
+        return
+    end
+    local cmd = group.command
+    local compressionSet = {}
     local compressedTotal = 0
     local totalTypes = 0
     local entityToTag
@@ -339,10 +354,14 @@ function Squad.compressSquad(squad)
     query.target = entityToTag
     squad.compressionText = rendering.draw_text(query)
     squad.compressionSet = compressionSet
+    squad.compressedTotal = compressedTotal
     squad.canBeCompressed = false
+    if cmd then
+	group.set_command(cmd)
+    end
 end
 
-function Squad.decompressSquad(squad)
+function Squad.decompressSquad(squad, tick)
     if not squad.compressionSet then
         return
     end
@@ -350,6 +369,7 @@ function Squad.decompressSquad(squad)
     local group = squad.group
     local query = Queries.createEntityQuery
     local add_member = group.add_member
+    local cmd = group.command
     local create_entity = squad.map.surface.create_entity
     setPositionInQuery(
         query,
@@ -362,7 +382,11 @@ function Squad.decompressSquad(squad)
         end
     end
     rendering.destroy(squad.compressionText)
+    if cmd then
+        group.set_command(cmd)
+    end
     squad.compressionSet = nil
+    squad.canBeCompressed = tick + COMPRESSION_COOLDOWN
 end
 
 --[[
@@ -438,7 +462,7 @@ local function scoreNeighbors(map, chunk, neighborDirectionChunks, scoreFunction
     return SearchPath
 end
 
-local function settleMove(squad)
+local function settleMove(squad, tick)
     local group = squad.group
     local map = squad.map
 
@@ -480,7 +504,7 @@ local function settleMove(squad)
             )
         )
     then
-        Squad.decompressSquad(squad)
+        Squad.decompressSquad(squad, tick)
 
         position = findMovementPosition(surface, groupPosition) or groupPosition
 
@@ -557,6 +581,7 @@ local function settleMove(squad)
         cmd = Queries.settleCommand
         squad.status = SQUAD_BUILDING
         squad.commandTick = tick + BUILD_COMMAND_TIMEOUT
+        Squad.decompressSquad(squad, tick)
         if squad.kamikaze then
             cmd.distraction = DEFINES_DISTRACTION_NONE
         else
@@ -576,7 +601,7 @@ local function settleMove(squad)
     group.set_command(cmd)
 end
 
-local function attackMove(squad)
+local function attackMove(squad, tick)
     local group = squad.group
 
     local groupPosition = group.position
@@ -643,7 +668,7 @@ local function attackMove(squad)
     end
 
     if attack then
-        Squad.decompressSquad(squad)
+        Squad.decompressSquad(squad, tick)
         cmd = Queries.attackCommand
 
         if not squad.rabid then
@@ -674,7 +699,7 @@ local function buildMove(squad, tick)
 
     setPositionInCommand(Queries.settleCommand, position)
 
-    Squad.decompressSquad(squad)
+    Squad.decompressSquad(squad, tick)
 
     group.set_command(Queries.settleCommand)
 end
@@ -750,7 +775,7 @@ function Squad.squadDispatch(squad, tick)
         return
     end
 
-    compressSquad(squad)
+    compressSquad(squad, tick)
     local status = squad.status
     if (status == SQUAD_RAIDING) then
         squad.commandTick = tick + COMMAND_TIMEOUT
@@ -954,11 +979,16 @@ function Squad.retreatUnits(chunk, cause, map, tick, radius)
 end
 
 function Squad.createSquad(position, map, group, settlers, base)
-    local unitGroup = group or map.surface.create_unit_group({position=position})
+    local unitGroup = group
+    if not unitGroup then
+        local query = Queries.createUnitGroup
+        setPositionInQuery(query, position)
+        unitGroup = map.surface.create_unit_group(query)
+    end
 
     local squad = {
         group = unitGroup,
-        canBeCompressed = true,
+        canBeCompressed = 0,
         compressionSet = nil,
         compressionText = nil,
         status = SQUAD_GUARDING,

libs/Upgrade.lua

@@ -391,12 +391,15 @@ local function addCommandSet()
         {chunk=-1, direction=-1}
     }
     Universe.squadQueries.renderText = {
-            target = nil,
-            text = "",
-            target_offset = {0, -10},
-            color = {r=1,g=1,b=1,a=0.5},
-            surface = nil,
-            scale = 5
+        target = nil,
+        text = "",
+        target_offset = {0, -10},
+        color = {r=1,g=1,b=1,a=0.5},
+        surface = nil,
+        scale = 5
+    }
+    Universe.squadQueries.createUnitGroup = {
+        position = {0,0}
     }
 end
 
@@ -518,8 +521,6 @@ function Upgrade.addUniverseProperties()
         Universe.maxPoints = 0
         Universe.maxOverflowPoints = 0
 
-        addCommandSet()
-
         Universe.bases = {}
 
         Universe.processBaseAIIterator = nil
@@ -530,6 +531,10 @@ function Upgrade.addUniverseProperties()
         Universe.pendingUpgradesLength = 0
         Universe.settlePurpleCloud = {}
     end
+    if global.universePropertyVersion < 2 then
+        global.universePropertyVersion = 2
+        addCommandSet()
+    end
 end
 
 function Upgrade.attempt()
@@ -561,6 +566,10 @@ function Upgrade.attempt()
     end
     if global.gameVersion < 2 then
         global.gameVersion = 2
+        game.map_settings.max_failed_behavior_count = 999
+        for _, squad in pairs(Universe.groupNumberToSquad) do
+            squad.canBeCompressed = 0
+        end
 
         for _, map in pairs(Universe.maps) do
             for _, chunk in pairs(map.processQueue) do