factorio-scenario-ExpCluster/exp_legacy/module/modules/gui/tool.lua

--[[-- Gui Module - Tool
    @gui Tool
    @alias tool_container
]]

local ExpUtil = require("modules/exp_util")
local Gui = require("modules/exp_gui")
local Roles = require("modules.exp_legacy.expcore.roles") --- @dep expcore.roles
local Event = require("modules/exp_legacy/utils/event") --- @dep utils.event
local Selection = require("modules/exp_legacy/modules/control/selection") --- @dep modules.control.selection
local addon_train = require("modules/exp_scenario/commands/trains")
local addon_research = require("modules/exp_scenario/commands/research")

local tool_container

local SelectionArtyArea = "ExpCommand_Artillery"
local SelectionWaterfillArea = "ExpCommand_Waterfill"

local style = {
    label = {
        width = 160
    },
    button = {
        width = 80
    }
}

--- Arty label
-- @element tool_gui_arty_l
local tool_gui_arty_l = Gui.element("tool_gui_arty_l")
    :draw{
        type = "label",
        name = Gui.property_from_name,
        caption = { "tool.artillery" },
        tooltip = { "tool.artillery-tooltip" },
        style = "heading_2_label"
    }:style(
        style.label
    )

--- Arty button
-- @element tool_gui_arty_b
local tool_gui_arty_b = Gui.element("tool_gui_arty_b")
    :draw{
        type = "button",
        name = Gui.property_from_name,
        caption = { "tool.apply" }
    }:style(
        style.button
    ):on_click(function(def, player, element)
        if Selection.is_selecting(player, SelectionArtyArea) then
            Selection.stop(player)
            player.print{ "exp-commands_artillery.exit" }

        else
            Selection.start(player, SelectionArtyArea)
            player.print{ "exp-commands_artillery.enter" }
        end
    end)

--- Waterfill label
-- @element tool_gui_waterfill_l
local tool_gui_waterfill_l = Gui.element("tool_gui_waterfill_l")
    :draw{
        type = "label",
        name = Gui.property_from_name,
        caption = { "tool.waterfill" },
        tooltip = { "tool.waterfill-tooltip" },
        style = "heading_2_label"
    }:style(
        style.label
    )

--- Waterfill button
-- @element tool_gui_waterfill_b
local tool_gui_waterfill_b = Gui.element("tool_gui_waterfill_b")
    :draw{
        type = "button",
        name = Gui.property_from_name,
        caption = { "tool.apply" }
    }:style(
        style.button
    ):on_click(function(def, player, element)
        if Selection.is_selecting(player, SelectionWaterfillArea) then
            Selection.stop(player)
            return player.print{ "exp-commands_waterfill.exit" }
        else
            local item_count_cliff = player.get_item_count("cliff-explosives")
            local item_count_craft = math.min(math.floor(player.get_item_count("explosives") / 10), player.get_item_count("barrel"), player.get_item_count("grenade"))
            local item_count_total = item_count_cliff + item_count_craft
            if item_count_total == 0 then
                return player.print{ "exp-commands_waterfill.requires-explosives" }
            else
                Selection.start(player, SelectionWaterfillArea)
                return player.print{ "exp-commands_waterfill.enter" }
            end
        end
    end)

--- Train label
-- @element tool_gui_train_l
local tool_gui_train_l = Gui.element("tool_gui_train_l")
    :draw{
        type = "label",
        name = Gui.property_from_name,
        caption = { "tool.train" },
        tooltip = { "tool.train-tooltip" },
        style = "heading_2_label"
    }:style(
        style.label
    )

--- Train button
-- @element tool_gui_train_b
local tool_gui_train_b = Gui.element("tool_gui_train_b")
    :draw{
        type = "button",
        name = Gui.property_from_name,
        caption = { "tool.apply" }
    }:style(
        style.button
    ):on_click(function(def, player, element)
        addon_train.manual(player)
    end)

--- Research label
-- @element tool_gui_research_l
local tool_gui_research_l = Gui.element("tool_gui_research_l")
    :draw{
        type = "label",
        name = Gui.property_from_name,
        caption = { "tool.research" },
        tooltip = { "tool.research-tooltip" },
        style = "heading_2_label"
    }:style(
        style.label
    )

--- Research button
-- @element tool_gui_research_b
local tool_gui_research_b = Gui.element("tool_gui_research_b")
    :draw{
        type = "button",
        name = Gui.property_from_name,
        caption = { "tool.apply" }
    }:style(
        style.button
    ):on_click(function(def, player, element)
        local enabled = addon_research.set_auto_research()

        if enabled then
            addon_research.res_queue(player.force --[[ @as LuaForce ]], true)
        end

        local player_name = ExpUtil.format_player_name_locale(player)
        game.print{ "exp-commands_research.auto-research", player_name, enabled }
    end)

--- Spawn label
-- @element tool_gui_spawn_l
local tool_gui_spawn_l = Gui.element("tool_gui_spawn_l")
    :draw{
        type = "label",
        name = Gui.property_from_name,
        caption = { "tool.spawn" },
        tooltip = { "tool.spawn-tooltip" },
        style = "heading_2_label"
    }:style(
        style.label
    )

--- Spawn button
-- @element tool_gui_spawn_b
local tool_gui_spawn_b = Gui.element("tool_gui_spawn_b")
    :draw{
        type = "button",
        name = Gui.property_from_name,
        caption = { "tool.apply" }
    }:style(
        style.button
    ):on_click(function(def, player, element)
        if not player.character
        or player.character.health <= 0
        or not ExpUtil.teleport_player(player, game.surfaces.nauvis, { 0, 0 }, "dismount") then
            return player.print{ "exp-commands_teleport.unavailable" }
        end
    end)

local function tool_perm(player, container)
    container = container or Gui.get_left_element(tool_container, player)
    local disp = container.frame.tool_st.disp.table
    local allowed

    allowed = Roles.player_allowed(player, "command/artillery")
    disp[tool_gui_arty_l.name].visible = allowed
    disp[tool_gui_arty_b.name].visible = allowed

    allowed = Roles.player_allowed(player, "command/waterfill")
    disp[tool_gui_waterfill_l.name].visible = allowed
    disp[tool_gui_waterfill_b.name].visible = allowed

    allowed = Roles.player_allowed(player, "command/set-trains-to-automatic")
    disp[tool_gui_train_l.name].visible = allowed
    disp[tool_gui_train_b.name].visible = allowed

    allowed = Roles.player_allowed(player, "command/set-auto-research")
    disp[tool_gui_research_l.name].visible = allowed
    disp[tool_gui_research_b.name].visible = allowed

    allowed = Roles.player_allowed(player, "command/spawn")
    disp[tool_gui_spawn_l.name].visible = allowed
    disp[tool_gui_spawn_b.name].visible = allowed
end

--- A vertical flow containing all the tool
-- @element tool_set
local tool_set = Gui.element("tool_set")
    :draw(function(_, parent, name)
        local tool_set = parent.add{ type = "flow", direction = "vertical", name = name }
        local disp = Gui.elements.scroll_table(tool_set, 240, 2, "disp")

        tool_gui_arty_l(disp)
        tool_gui_arty_b(disp)

        tool_gui_waterfill_l(disp)
        tool_gui_waterfill_b(disp)

        tool_gui_train_l(disp)
        tool_gui_train_b(disp)

        tool_gui_research_l(disp)
        tool_gui_research_b(disp)

        tool_gui_spawn_l(disp)
        tool_gui_spawn_b(disp)

        return tool_set
    end)

--- The main container for the tool gui
-- @element tool_container
tool_container = Gui.element("tool_container")
    :draw(function(def, parent)
        local player = Gui.get_player(parent)
        local container = Gui.elements.container(parent, 240)

        tool_set(container, "tool_st")

        tool_perm(player, container.parent)

        return container.parent
    end)

--- Add the element to the left flow with a toolbar button
Gui.add_left_element(tool_container, false)
Gui.toolbar.create_button{
    name = "tool_toggle",
    left_element = tool_container,
    sprite = "item/repair-pack",
    tooltip = { "tool.main-tooltip" },
    visible = function(player, element)
        return Roles.player_allowed(player, "gui/tool")
    end
}

Event.add(Roles.events.on_role_assigned, function(event)
    tool_perm(game.players[event.player_index])
end)

Event.add(Roles.events.on_role_unassigned, function(event)
    tool_perm(game.players[event.player_index])
end)