config.lua

require("util")
require("on_init")
require("example_blueprints")

OB_CONF = {
    -- Can be changed with the in game GUI
    pole_name = "medium-electric-pole",
    transport_belts = {"transport-belt"},
    pipe_name = "pipe",
    miner_name = "electric-mining-drill",
    direction = defines.direction.east,
    advanced_window_open = false,
    dummy_spacing_entitiy = "wooden-chest",
    pole_options_selected = "intelligent",
    blueprint_data = example_blueprints.standard,
    blueprint_raw = example_blueprints.raw.standard,
    smart_belt_placement = true,
    enable_pipe_placement = true,
    enable_belt_collate = true,
    other_entity_settings = {},
    output_belt_count = 4, -- The number of belts of ore leaving the set-up.
    chest_name = "steel-chest",
    -- Can only be changed here (if in multiplayer make sure you all have the same config or you will desync).
    -- TODO: At least some of these should be in mod settings
    place_directly = false, -- Place entities directly or always use blueprints?
    -- BEGIN if placing directly:
    drain_inventory = true, -- When placing directly, should items be removed from the player's inventory?
    place_blueprint_on_out_of_inventory = true, -- If the player does not have that item place a blueprint instead?
    place_blueprint_on_collision = true, -- Place a blueprint if something blocks direct placement?
    -- END if placing directly
    check_for_ore = true, -- For each miner, check there is some of the correct ore underneath it.
    check_dirty_mining = true, -- For each miner, check if any other ores are present in its mining area.
    check_collision = true,
    run_over_multiple_ticks = true -- Place instantly or one at a time?
}

function get_config(player)
    local conf = table.combine(OB_CONF, global.OB_CONF_overrides[player.index])
    conf.transport_belts = table.clone(conf.transport_belts)
    local pole_prototype = game.entity_prototypes[conf.pole_name]
    conf.pole_width =
        math.ceil(
        math.max(
            pole_prototype.collision_box.right_bottom.x - pole_prototype.collision_box.left_top.y,
            pole_prototype.collision_box.right_bottom.x - pole_prototype.collision_box.left_top.y
        )
    )
    local miner_prototype = game.entity_prototypes[conf.miner_name]
    conf.miner_width =
        math.ceil(
        math.max(
            miner_prototype.collision_box.right_bottom.x - miner_prototype.collision_box.left_top.x,
            miner_prototype.collision_box.right_bottom.y - miner_prototype.collision_box.left_top.y
        )
    )
    return conf
end

function set_config(player, new_conf) -- Override the configuration file on a per save basis.
    if new_conf and type(new_conf) == "table" then
        global.OB_CONF_overrides[player.index] = table.combine(global.OB_CONF_overrides[player.index], new_conf)
    else
        game.print("DEBUG: Bad config set")
    end
end

function reset_config(player)
    global.OB_CONF_overrides[player.index] = {}
end

function reset_all()
    global.OB_CONF_overrides = {}
    global.AM_states = {}
    init_gui()
end

function set_config_global(new_conf)
    if new_conf and type(new_conf) == "table" then
        for k, player in pairs(game.players) do
            global.OB_CONF_overrides[player.index] = table.combine(global.OB_CONF_overrides[player.index], new_conf)
        end
    end
end

local function validate_config(partialConf, player)
    if partialConf.pole_name then
        if
            not game.entity_prototypes[partialConf.pole_name] or
                (not game.entity_prototypes[partialConf.pole_name].type == "electric-pole")
         then
            return false
        end
    end
    if partialConf.miner_name then
        if
            not game.entity_prototypes[partialConf.miner_name] or
                (not game.entity_prototypes[partialConf.miner_name].type == "mining-drill")
         then
            return false
        end
    elseif partialConf.blueprint_data then -- Migrate from 0.4 to 0.5+
        partialConf.miner_name = partialConf.blueprint_data.miner_name
    end
    if partialConf.transport_belts then
        for k, belt in pairs(partialConf.transport_belts) do
            if util.check_belt_entity(belt) then
                return false
            end
        end
    end
    if partialConf.pipe_name then
        local underground_pipe = pipe_to_underground(partialConf.pipe_name)
        if
            not game.entity_prototypes[partialConf.pipe_name] or
                (not game.entity_prototypes[partialConf.pipe_name].type == "pipe") or
                not game.entity_prototypes[underground_pipe] or
                not (game.entity_prototypes[underground_pipe].type == "pipe-to-ground")
         then
            return false
        end
    end
    if partialConf.dummy_spacing_entitiy and not game.entity_prototypes[partialConf.dummy_spacing_entitiy] then
        return false
    end
    if partialConf.blueprint_data then
        if not partialConf.blueprint_data.chests then -- Migrate from 0.3 to 0.4+
            partialConf.blueprint_data.chests =
                table.append_modify(
                util.strip_entities_of_type(partialConf.blueprint_data.other_entities, "container"),
                util.strip_entities_of_type(partialConf.blueprint_data.other_entities, "logistic-container")
            )
            if #partialConf.blueprint_data.chests > 0 then
                partialConf.chest_name = partialConf.blueprint_data.chests[1].name
            end
        end
        local err = validate_blueprint(partialConf.blueprint_data)
        if err then
            return false
        end
    end
    if partialConf.chest_name then
        if
            not game.entity_prototypes[partialConf.chest_name] or
                (game.entity_prototypes[partialConf.chest_name].type ~= "container" and
                    game.entity_prototypes[partialConf.chest_name].type ~= "logistic-container")
         then
            return false
        end
    end
    return true
end

function init_config()
    if global.OB_CONF_overrides then
        -- Check that all the entities in custom config still exist (a mod may have been removed).
        -- The entities in OB_CONF are assumed to exist (base is a dependency).
        for k, v in pairs(global.OB_CONF_overrides) do
            local player = game.players[k]
            if not validate_config(v, player) then
                global.OB_CONF_overrides[k] = {}
                player.print({"outpost-builder.bad-config"})
            end
        end
    else
        global.OB_CONF_overrides = {}
    end
end

remote.add_interface("OutpostBuilder", {reset = reset_all, config = set_config_global, validate = init_config})

table.insert(ON_INIT, init_config)