factorio-scenario-ExpCluster/modules/addons/scorched-earth.lua

--- When a player walks around the tiles under them will degrade over time, the same is true when entites are built
-- @addon Scorched-Earth

local Event = require 'utils.event' --- @dep utils.event
local Game = require 'utils.game' --- @dep utils.game
local Global = require 'utils.global' --- @dep utils.global
local print_grid_value, clear_flying_text = ext_require('expcore.common','print_grid_value','clear_flying_text') --- @dep expcore.common
local config = require 'config.scorched_earth' --- @dep config.scorched_earth

-- Loops over the config and finds the wile which has the highest value for strength
local max_strength = 0
for _,strength in pairs(config.strengths) do
    if strength > max_strength then
        max_strength = strength
    end
end

-- Used for debugging the degrade chances
local debug_players = {}
Global.register(debug_players, function(tbl)
    debug_players = tbl
end)

-- Will degrade a tile down to the next tile when called
local function degrade(surface,position)
    local tile = surface.get_tile(position)
    local tile_name = tile.name
    local degrade_tile_name = config.degrade_order[tile_name]
    if not degrade_tile_name then return end
    surface.set_tiles{{name=degrade_tile_name,position=position}}
end

-- Same as degrade but will degrade all tiles that are under an entity
local function degrade_entity(entity)
    local surface = entity.surface
    local position = entity.position
    local tiles = {}
    if not config.entities[entity.name] then return end
    local box = entity.prototype.collision_box
    local lt = box.left_top
    local rb = box.right_bottom
    for x = lt.x, rb.x do -- x loop
        local px = position.x+x
        for y = lt.y, rb.y do -- y loop
            local p = {x=px,y=position.y+y}
            local tile = surface.get_tile(p)
            local tile_name = tile.name
            local degrade_tile_name = config.degrade_order[tile_name]
            if not degrade_tile_name then return end
            table.insert(tiles,{name=degrade_tile_name,position=p})
        end
    end
    surface.set_tiles(tiles)
end

-- Turns the strength of a tile into a probability (0 = impossible, 1 = certain)
local function get_probability(strength)
    local v1 = strength/max_strength
    local dif = 1 - v1
    local v2 = dif/2
    return (1-v1+v2)/config.weakness_value
end

-- Gets the mean of the strengths around a tile to give the strength at that position
local function get_tile_strength(surface,position)
    local tile = surface.get_tile(position)
    local tile_name = tile.name
    local strength = config.strengths[tile_name]
    if not strength then return end
    for x = -1,1 do -- x loop
        local px = position.x + x
        for y = -1,1 do -- y loop
            local check_tile = surface.get_tile{x=px,y=position.y+y}
            local check_tile_name = check_tile.name
            local check_strength = config.strengths[check_tile_name] or 0
            strength = strength + check_strength
        end
    end
    return strength/9
end

-- Same as get_tile_strength but returns to a in game text rather than as a value
local function debug_get_tile_strength(surface,position)
    for x = -3,3 do -- x loop
        local px = position.x+x
        for y = -3,3 do -- y loop
            local p = {x=px,y=position.y+y}
            local strength = get_tile_strength(surface,p) or 0
            local tile = surface.get_tile(p)
            print_grid_value(get_probability(strength)*config.weakness_value, surface, tile.position)
        end
    end
end

-- When the player changes position the tile will have a chance to downgrade, debug check is here
Event.add(defines.events.on_player_changed_position, function(event)
    local player = Game.get_player_by_index(event.player_index)
    local surface = player.surface
    local position = player.position
    local strength = get_tile_strength(surface,position)
    if not strength then return end
    if get_probability(strength) > math.random() then
        degrade(surface,position)
    end
    if debug_players[player.name] then
        debug_get_tile_strength(surface,position)
    end
end)

-- When an entity is build there is a much higher chance that the tiles will degrade
Event.add(defines.events.on_built_entity, function(event)
    local entity = event.created_entity
    local surface = entity.surface
    local position = entity.position
    local strength = get_tile_strength(surface,position)
    if not strength then return end
    if get_probability(strength)*config.weakness_value > math.random() then
        degrade_entity(entity)
    end
end)

-- Same as above but with robots
Event.add(defines.events.on_robot_built_entity, function(event)
    local entity = event.created_entity
    local surface = entity.surface
    local position = entity.position
    local strength = get_tile_strength(surface,position)
    if not strength then return end
    if get_probability(strength)*config.weakness_value > math.random() then
        degrade_entity(entity)
    end
end)

-- Used as a way to access the global table
return function(player_name,state)
    local player = Game.get_player_from_any(player_name)
    clear_flying_text(player.surface)
    debug_players[player_name] = state
end