factorio-scenario-ExpCluster/exp_legacy/module/modules/commands/roles.lua

--[[-- Commands Module - Roles
    - Adds a commands that allow interaction with the role system
    @commands Roles
]]

local ExpUtil = require("modules/exp_util")
local Commands = require("modules.exp_legacy.expcore.commands") --- @dep expcore.commands
local Roles = require("modules.exp_legacy.expcore.roles") --- @dep expcore.roles
local Colours = require("modules/exp_util/include/color")
local format_player_name, format_color = ExpUtil.format_player_name_locale, ExpUtil.format_rich_text_color

--- Assigns a role to a player
-- @command assign-role
-- @tparam LuaPlayer player the player to assign the role to
-- @tparam string role the name of the role to assign to the player, supports auto complete after enter
Commands.new_command("assign-role", { "expcom-roles.description-assign-role" }, "Assigns a role to a player")
    :add_param("player", false, "player-role")
    :add_param("role", false, "role")
    :set_flag("admin-only")
    :add_alias("rpromote", "assign", "role", "add-role")
    :register(function(player, action_player, role)
        local player_highest = Roles.get_player_highest_role(player)

        if player_highest.index < role.index then
            Roles.assign_player(action_player, role, player.name)
        else
            return Commands.error{ "expcom-roles.higher-role" }
        end
    end)

--- Unassigns a role from a player
-- @command unassign-role
-- @tparam LuaPlayer player the player to unassign the role from
-- @tparam string role the name of the role to unassign from the player, supports auto complete after enter
Commands.new_command("unassign-role", { "expcom-roles.description-unassign-role" }, "Unassigns a role from a player")
    :add_param("player", false, "player-role")
    :add_param("role", false, "role")
    :set_flag("admin-only")
    :add_alias("rdemote", "unassign", "rerole", "remove-role")
    :register(function(player, action_player, role)
        local player_highest = Roles.get_player_highest_role(player)

        if player_highest.index < role.index then
            Roles.unassign_player(action_player, role, player.name)
        else
            return Commands.error{ "expcom-roles.higher-role" }
        end
    end)

--- Lists all roles in they correct order
-- @command list-roles
-- @tparam[opt=all] LuaPlayer player list only the roles which this player has
Commands.new_command("list-roles", { "expcom-roles.description-list-roles" }, "Lists all roles in they correct order")
    :add_param("player", true, "player")
    :add_alias("lsroles", "roles")
    :register(function(_, player)
        local roles = Roles.config.order
        local message = { "expcom-roles.list" }

        if player then
            roles = Roles.get_player_roles(player)
        end

        for index, role in pairs(roles) do
            role = Roles.get_role_from_any(role)
            local colour = role.custom_color or Colours.white
            local role_name = format_color(role.name, colour)
            if index == 1 then
                message = { "expcom-roles.list", role_name }
                if player then
                    local player_name_colour = format_player_name(player)
                    message = { "expcom-roles.list-player", player_name_colour, role_name }
                end
            else
                message = { "expcom-roles.list-element", message, role_name }
            end
        end

        return Commands.success(message)
    end)