Rampant/libs/UnitGroupUtils.lua

if unitGroupUtilsG then
    return unitGroupUtilsG
end
local unitGroupUtils = {}

-- imports

local mapUtils = require("MapUtils")
local constants = require("Constants")
local chunkPropertyUtils = require("ChunkPropertyUtils")
local chunkUtils = require("ChunkUtils")
local movementUtils = require("MovementUtils")

-- constants

local TEN_DEATH_PHEROMONE_GENERATOR_AMOUNT = constants.TEN_DEATH_PHEROMONE_GENERATOR_AMOUNT

local DIVISOR_DEATH_TRAIL_TABLE = constants.DIVISOR_DEATH_TRAIL_TABLE
local SQUAD_QUEUE_SIZE = constants.SQUAD_QUEUE_SIZE

local DEFINES_GROUP_STATE_ATTACKING_TARGET = defines.group_state.attacking_target
local DEFINES_GROUP_STATE_ATTACKING_DISTRACTION = defines.group_state.attacking_distraction

local SQUAD_RETREATING = constants.SQUAD_RETREATING
local SQUAD_GUARDING = constants.SQUAD_GUARDING

local NO_RETREAT_SQUAD_SIZE_BONUS_MAX = constants.NO_RETREAT_SQUAD_SIZE_BONUS_MAX

local AI_MAX_BITER_GROUP_SIZE = constants.AI_MAX_BITER_GROUP_SIZE
local AI_SQUAD_MERGE_THRESHOLD = constants.AI_SQUAD_MERGE_THRESHOLD

-- imported functions

local tRemove = table.remove

local mRandom = math.random

local findMovementPosition = movementUtils.findMovementPosition
local removeSquadFromChunk = chunkPropertyUtils.removeSquadFromChunk
local addDeathGenerator = chunkPropertyUtils.addDeathGenerator
local getDeathGenerator = chunkPropertyUtils.getDeathGenerator

local next = next
local table_size = table_size

local mLog = math.log10

local mMin = math.min

local getSquadsOnChunk = chunkPropertyUtils.getSquadsOnChunk

local getNeighborChunks = mapUtils.getNeighborChunks

-- module code

function unitGroupUtils.findNearbyRetreatingSquad(map, chunk)

    local squads = getSquadsOnChunk(map, chunk)
    for i=1,#squads do
        local squad = squads[i]
        local unitGroup = squad.group
        if unitGroup and unitGroup.valid and (squad.status == SQUAD_RETREATING) then
            return squad
        end
    end

    local neighbors = getNeighborChunks(map, chunk.x, chunk.y)

    for i=1,#neighbors do
        local neighbor = neighbors[i]
        if neighbor ~= -1 then
            squads = getSquadsOnChunk(map, neighbor)
            for squadIndex=1,#squads do
                local squad = squads[squadIndex]
                local unitGroup = squad.group
                if unitGroup and unitGroup.valid and (squad.status == SQUAD_RETREATING) then
                    return squad
                end
            end
        end
    end
    return nil
end

function unitGroupUtils.findNearbySquad(map, chunk)

    local squads = getSquadsOnChunk(map, chunk)
    for i=1,#squads do
        local squad = squads[i]
        local unitGroup = squad.group
        if unitGroup and unitGroup.valid then
            return squad
        end
    end

    local neighbors = getNeighborChunks(map, chunk.x, chunk.y)

    for i=1,#neighbors do
        local neighbor = neighbors[i]
        if neighbor ~= -1 then
            squads = getSquadsOnChunk(map, neighbor)
            for squadIndex=1,#squads do
                local squad = squads[squadIndex]
                local unitGroup = squad.group
                if unitGroup and unitGroup.valid then
                    return squad
                end
            end
        end
    end

    return nil
end

function unitGroupUtils.createSquad(position, surface, group, settlers)
    local unitGroup = group or surface.create_unit_group({position=position})

    local squad = {
        group = unitGroup,
        status = SQUAD_GUARDING,
        rabid = false,
        frenzy = false,
        settlers = settlers or false,
        kamikaze = false,
        frenzyPosition = {x = 0,
                          y = 0},
        maxDistance = 0,
        groupNumber = unitGroup.group_number,
        originPosition = {x = 0,
                          y = 0},
        chunk = -1
    }

    if position then
        squad.originPosition.x = position.x
        squad.originPosition.y = position.y
    elseif group then
        squad.originPosition.x = group.position.x
        squad.originPosition.y = group.position.y
    end

    return squad
end

function unitGroupUtils.cleanSquads(natives, iterator)
    -- local profiler = game.create_profiler()
    local squads = natives.groupNumberToSquad
    local map = natives.map

    local k, squad = next(squads, iterator)
    local nextK
    -- for i=1,2 do
    if not k then
        if (table_size(squads) == 0) then
            -- this is needed as the next command remembers the max length a table has been
            natives.groupNumberToSquad = {}
        end
    else
        local group = squad.group
        if not group.valid then
            addDeathGenerator(map, squad.chunk, TEN_DEATH_PHEROMONE_GENERATOR_AMOUNT)            
            removeSquadFromChunk(map, squad)            
            if (map.regroupIterator == k) then
                map.regroupIterator = nil
            end
            if squad.settlers then
                natives.builderCount = natives.builderCount - 1
            else
                natives.squadCount = natives.squadCount - 1
            end
            nextK,squad = next(squads, k)
            squads[k] = nil
            k = nextK
            -- else
            --     game.print({"", "3b", profiler})
            --     profiler.restart()
            --     local members = group.members
            --     local memberCount = #members
            --     if (memberCount == 0) then
            --         game.print({"", "4a", profiler})
            --         profiler.restart()
            --         local deathGen = getDeathGenerator(map, squad.chunk)
            --         local penalties = squad.penalties
            --         for xc=1,mMin(#squad.penalties,5) do
            --             addDeathGenerator(map,
            --                               penalties[xc].c,
            --                               deathGen * DIVISOR_DEATH_TRAIL_TABLE[xc])
            --         end
            --         removeSquadFromChunk(map, squad)
            --         group.destroy()
            --         game.print({"", "4ea", profiler})
            --         profiler.restart()
            --     elseif (memberCount > AI_MAX_BITER_GROUP_SIZE) then
            --         game.print({"", "4b", profiler})
            --         profiler.restart()
            --         unitGroupUtils.recycleBiters(natives, members)
            --         removeSquadFromChunk(map, squad)
            --         group.destroy()
            --         game.print({"", "4eb", profiler})
            --         profiler.restart()
            --     end
            --     game.print({"", "3be", profiler})
        end
    end
    -- end
    map.squadIterator = k
end

function unitGroupUtils.membersToSquad(cmd, size, members, overwriteGroup)
    for i=1,size do
        local member = members[i]
        if member.valid and (overwriteGroup or (not overwriteGroup and not member.unit_group)) then
            member.set_command(cmd)
        end
    end
end

function unitGroupUtils.calculateKamikazeThreshold(memberCount, natives)
    local squadSizeBonus = mLog((memberCount / natives.attackWaveMaxSize) + 0.1) + 1
    return natives.kamikazeThreshold + (NO_RETREAT_SQUAD_SIZE_BONUS_MAX * squadSizeBonus)
end

function unitGroupUtils.recycleBiters(natives, biters)
    local unitCount = #biters
    for i=1,unitCount do
        biters[i].destroy()
    end
    natives.points = natives.points + (unitCount * natives.unitRefundAmount)
end

function unitGroupUtils.regroupSquads(natives, surface, iterator)
    local map = natives.map
    local squads = natives.groupNumberToSquad
    local cmd = map.formLocalCommand

    local k, squad = next(squads, iterator)
    if k then
        local group = squad.group
        if group and group.valid then
            cmd.command.group = group
            local groupState = group.state
            if (groupState ~= DEFINES_GROUP_STATE_ATTACKING_TARGET) and
                (groupState ~= DEFINES_GROUP_STATE_ATTACKING_DISTRACTION)
            then
                local status = squad.status
                local chunk = squad.chunk

                if (chunk ~= -1) then
                    local merging = false
                    for _,mergeSquad in pairs(getSquadsOnChunk(map, chunk)) do
                        if (mergeSquad ~= squad) then
                            local mergeGroup = mergeSquad.group
                            if mergeGroup and mergeGroup.valid and (mergeSquad.status == status) then
                                local mergeGroupState = mergeGroup.state
                                if (mergeGroupState ~= DEFINES_GROUP_STATE_ATTACKING_TARGET) and
                                    (mergeGroupState ~= DEFINES_GROUP_STATE_ATTACKING_DISTRACTION)
                                then
                                    merging = true
                                    mergeGroup.destroy()
                                end
                            end
                        end
                    end
                    if merging then
                        surface.set_multi_command(cmd)
                    end
                end
            end
        end
        k,squad = next(squads, k)
    end

    map.regroupIterator = k
end

unitGroupUtilsG = unitGroupUtils
return unitGroupUtils