Move the scenario onto exp_roles and remove the legacy role system

Every call site of expcore.roles now uses exp_roles, and the legacy module, its config, and the glue which refreshed guis on role events are deleted. Where a file only renamed the require and the permission strings the change is mechanical; the rest: - Jail is now "give the Jail role" and unjail "take it away". The role has a higher priority than every other so holding it suppresses them, which is what stashing and restoring the roles was for. - The command role authority derives exp_scenario.command.<name> from the command name, and the role parsers use player_outranks rather than comparing indexes with their own root check. - The admin and spectator triggers, and the gui refresh on role changes, live in exp_scenario/control/roles.lua; the system commands trigger stays with the command authority. - The player list warn button is keyed on create_warning, the permission the command behind it already required, and report on create_report. Both were keyed on names no role held, so only root ever saw them. - The warps and tasks configs say exp_roles where they said expcore.roles. - The role tables the readme and player list read are replaced by get_player_names and get_roles. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-09-21 17:04:00 +00:00 · 2026-08-19 11:36:58 +00:00
parent eb715cc176
commit 7034f17b5d
53 changed files with 204 additions and 1776 deletions
@@ -3,7 +3,7 @@ Adds a config menu for setting autofill of placed entities
 ]]

 local Gui = require("modules/exp_gui")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.gui.autofill")
 local FlyingText = require("modules/exp_util/flying_text")

@@ -330,7 +330,7 @@ Gui.toolbar.create_button{
    sprite = config.icon,
    tooltip = { "exp-gui_autofill.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/autofill")
+        return Roles.player_has_permission(player, "exp_scenario.gui.autofill")
    end
 }

@@ -4,7 +4,7 @@ Adds a Gui which creates an selection planner to insert modules into buildings

 local Gui = require("modules/exp_gui")
 local AABB = require("modules/exp_util/aabb")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")

 local Selection = require("modules/exp_util/selection")
 local SelectArea = Selection.connect("ModuleArea")
@@ -259,7 +259,7 @@ Gui.toolbar.create_button{
    sprite = "item/productivity-module-3",
    tooltip = { "exp-gui_module-inserter.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/module")
+        return Roles.player_has_permission(player, "exp_scenario.gui.module")
    end
 }

@@ -3,7 +3,7 @@ Adds a gui that allows players to apply various bonuses
 ]]

 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/bonus")
 local vlayer = require("modules/exp_legacy/modules/control/vlayer")
 local format_number = require("util").format_number
@@ -68,7 +68,8 @@ do local _points_limit = {} --- @type table<number, number>
    --- @param player LuaPlayer
    --- @return number
    function Elements.bonus_used._calculate_points_limit(player)
-        local role_diff = Roles.get_role_by_name(config.points.role_name).index - Roles.get_player_highest_role(player).index
+        local role = assert(Roles.get_role(config.points.role_name), "Bonus points role does not exist")
+        local role_diff = role.index - Roles.get_player_highest_role(player).index
        local points_limit = math.floor(config.points.base * (1 + config.points.increase_percentage_per_role_level * role_diff))
        _points_limit[player.index] = points_limit
        return points_limit
@@ -458,19 +459,19 @@ Gui.toolbar.create_button{
    sprite = "item/exoskeleton-equipment",
    tooltip = { "exp-gui_player-bonus.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/bonus")
+        return Roles.player_has_permission(player, "exp_scenario.gui.bonus")
    end
 }

 --- Recalculate and apply the bonus for a player
 local function recalculate_bonus(event)
    local player = Gui.get_player(event)
-    if event.name == Roles.events.on_role_assigned or event.name == Roles.events.on_role_unassigned then
+    if event.name == Roles.events.on_player_roles_changed then
        -- If the player's roles changed then we will need to recalculate their limit
        Elements.bonus_used._clear_points_limit_cache(player)
        local bonus_cost = Elements.container.calculate_cost(player)
        local within_limit = Elements.bonus_used.refresh_player(player, bonus_cost)
-        if not within_limit or not Roles.player_allowed(player, "gui/bonus") then
+        if not within_limit or not Roles.player_has_permission(player, "exp_scenario.gui.bonus") then
            Elements.container.clear_player_bonus(player)
            return
        end
@@ -512,7 +513,7 @@ end
 --- Apply the periodic bonus to all players
 local function apply_periodic_bonus_online()
    for _, player in pairs(game.connected_players) do
-        if player.character and Roles.player_allowed(player, "gui/bonus") then
+        if player.character and Roles.player_has_permission(player, "exp_scenario.gui.bonus") then
            apply_personal_battery_recharge(player)
        end
    end
@@ -524,8 +525,7 @@ return {
    elements = Elements,
    events = {
        [e.on_player_respawned] = recalculate_bonus,
-        [Roles.events.on_role_assigned] = recalculate_bonus,
-        [Roles.events.on_role_unassigned] = recalculate_bonus,
+        [Roles.events.on_player_roles_changed] = recalculate_bonus,
    },
    on_nth_tick = {
        [config.periodic_bonus_rate] = apply_periodic_bonus_online,
@@ -4,7 +4,7 @@ Adds a player list to show names and play time; also includes action buttons whi

 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/gui/player_list_actions")

 --- @class ExpGui_PlayerList.elements
@@ -203,7 +203,8 @@ function Elements.player_table.calculate_row_data()
    -- Flatten the roles into a single ordered list
    local count = 0
    local row_data = {}
-    for _, role_name in pairs(Roles.config.order) do
+    for _, role in ipairs(Roles.get_roles()) do
+        local role_name = role.name
        if players[role_name] then
            for _, player in pairs(players[role_name]) do
                count = count + 1
@@ -360,7 +361,7 @@ function Elements.action_bar.refresh(action_bar, player, selected_player)
        if buttons.auth and not buttons.auth(player, selected_player) then
            flow.visible = false
        else
-            flow.visible = Roles.player_allowed(player, action_name)
+            flow.visible = Roles.player_has_permission(player, action_name)
        end
    end
 end
@@ -492,7 +493,7 @@ Gui.toolbar.create_button{
    sprite = "entity/character",
    tooltip = { "exp-gui_player-list.main-tooltip" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/player-list")
+        return Roles.player_has_permission(player, "exp_scenario.gui.player_list")
    end
 }

@@ -534,8 +535,7 @@ return {
    events = {
        [e.on_player_joined_game] = redraw_player_list,
        [e.on_player_left_game] = on_player_left_game,
-        [Roles.events.on_role_assigned] = redraw_player_list,
-        [Roles.events.on_role_unassigned] = redraw_player_list,
+        [Roles.events.on_player_roles_changed] = redraw_player_list,
    },
    on_nth_tick = {
        [1800] = refresh_player_times,
@@ -5,7 +5,7 @@ Displays the player data for a player
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
 local ElementsExtra = require("modules/exp_scenario/gui/elements")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")

 require("modules/exp_legacy/modules/data/statistics")
 local PlayerData = require("modules/exp_legacy/expcore/player_data")
@@ -214,7 +214,7 @@ Gui.toolbar.create_button{
    tooltip = { "exp-gui_player-stats.tooltip-main" },
    left_element = Elements.container,
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/playerdata")
+        return Roles.player_has_permission(player, "exp_scenario.gui.playerdata")
    end
 }

@@ -3,7 +3,7 @@ Adds a Gui for displaying item production stats
 ]]

 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")

 --- @class ExpGui_ProductionStats.elements
 local Elements = {}
@@ -250,7 +250,7 @@ Gui.toolbar.create_button{
    sprite = "entity/assembling-machine-3",
    tooltip = { "exp-gui_production-stats.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/production")
+        return Roles.player_has_permission(player, "exp_scenario.gui.production")
    end
 }

@@ -4,7 +4,7 @@ Adds a few buttons for common actions

 local Gui = require("modules/exp_gui")
 local Commands = require("modules/exp_commands")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")

 local addon_artillery = require("modules/exp_scenario/commands/artillery")
 local addon_trains = require("modules/exp_scenario/commands/trains")
@@ -116,7 +116,7 @@ Gui.toolbar.create_button{
    sprite = "item/repair-pack",
    tooltip = { "exp-gui_quick-actions.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/tool")
+        return Roles.player_has_permission(player, "exp_scenario.gui.tool")
    end
 }

@@ -129,7 +129,6 @@ end
 return {
    elements = Elements,
    events = {
-        [Roles.events.on_role_assigned] = on_role_changed,
-        [Roles.events.on_role_unassigned] = on_role_changed,
+        [Roles.events.on_player_roles_changed] = on_role_changed,
    }
 }
@@ -4,7 +4,7 @@ Adds a main gui that contains important information about the server.

 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local Commands = require("modules/exp_commands")
 local PlayerData = require("modules.exp_legacy.expcore.player_data")
 local External = require("modules.exp_legacy.expcore.external")
@@ -392,14 +392,16 @@ define_tab(

        local done = {}

-        -- Fill groups from configured roles
-        for player_name, player_roles in pairs(Roles.config.players) do
-            for _, group in ipairs(groups) do
-                for _, role_name in ipairs(group.roles) do
-                    if table.contains(player_roles, role_name) then
+        -- Fill groups from the players who hold the roles, a player can be in more than one group
+        for _, group in ipairs(groups) do
+            local seen = {}
+            for _, role_name in ipairs(group.roles) do
+                local role = Roles.get_role(role_name)
+                for _, player_name in ipairs(role and role:get_player_names() or {}) do
+                    if not seen[player_name] then
+                        seen[player_name] = true
                        done[player_name] = true
                        group.players[#group.players + 1] = player_name
-                        break
                    end
                end
            end
@@ -463,7 +465,7 @@ local function render_data_category(opts)
    for name, child in pairs(opts.children) do
        local metadata = child.metadata

-        if not metadata.permission or Roles.player_allowed(opts.player, metadata.permission) then
+        if not metadata.permission or Roles.player_has_permission(opts.player, metadata.permission) then
            local value = child:get(opts.player_name)

            if value ~= nil or metadata.show_always then
@@ -663,7 +665,7 @@ Elements.toggle_button = Gui.toolbar.create_button{
        sprite = "virtual-signal/signal-info",
        tooltip = { "exp-gui_readme.main-tooltip" },
        visible = function(player)
-            return Roles.player_allowed(player, "gui/readme")
+            return Roles.player_has_permission(player, "exp_scenario.gui.readme")
        end,
    }
    :on_click(function(_, player)
@@ -4,7 +4,7 @@ Adds a gui for tracking research milestones

 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/research")

 local table_to_json = helpers.table_to_json
@@ -339,7 +339,7 @@ Gui.toolbar.create_button{
    sprite = "item/space-science-pack",
    tooltip = { "exp-gui_research-milestones.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/research")
+        return Roles.player_has_permission(player, "exp_scenario.gui.research")
    end
 }

@@ -4,7 +4,7 @@ Adds a rocket information gui which shows general stats, milestones and build pr

 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/gui/rockets")

 --- @class ExpGui_RocketInfo.elements
@@ -651,7 +651,7 @@ Gui.toolbar.create_button{
    sprite = "item/rocket-silo",
    tooltip = { "exp-gui_rocket-info.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/rocket-info")
+        return Roles.player_has_permission(player, "exp_scenario.gui.rocket_info")
    end
 }

@@ -5,7 +5,7 @@ Adds a science info gui that shows production usage and net for the different sc
 local ExpUtil = require("modules/exp_util")
 local Gui = require("modules/exp_gui")
 local Colors = require("modules/exp_util/include/color")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules/exp_legacy/config/gui/science")
 local _format_number = require("util").format_number

@@ -571,7 +571,7 @@ Gui.toolbar.create_button{
    sprite = "entity/lab",
    tooltip = { "exp-gui_science-production.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/science-info")
+        return Roles.player_has_permission(player, "exp_scenario.gui.science_info")
    end
 }

@@ -4,7 +4,7 @@ Adds cameras which can be used to view players and locations

 local Gui = require("modules/exp_gui")
 local ElementsExtra = require("modules/exp_scenario/gui/elements")
-local Roles = require("modules/exp_legacy/expcore/roles")
+local Roles = require("modules/exp_roles")

 --- @class ExpGui_Surveillance.elements
 local Elements = {}
@@ -234,7 +234,7 @@ Gui.toolbar.create_button{
    sprite = "entity/radar",
    tooltip = { "exp-gui_surveillance.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/surveillance")
+        return Roles.player_has_permission(player, "exp_scenario.gui.surveillance")
    end
 }:on_click(function(def, player, element, event)
    Elements.container(player.gui.screen)
@@ -3,7 +3,7 @@ Adds a task list to the game which players can add, remove and edit items on
 ]]

 local Gui = require("modules/exp_gui")
-local Roles = require("modules.exp_legacy.expcore.roles")
+local Roles = require("modules/exp_roles")
 local config = require("modules.exp_legacy.config.gui.tasks")

 local ExpUtil = require("modules/exp_util")
@@ -43,8 +43,8 @@ local function has_permission_create_task(player)
        return true
    elseif allow_add_task == "admin" then
        return player.admin
-    elseif allow_add_task == "expcore.roles" then
-        return Roles.player_allowed(player, config.expcore_roles_allow_add_task)
+    elseif allow_add_task == "exp_roles" then
+        return Roles.player_has_permission(player, config.exp_roles_allow_add_task)
    end

    return false
@@ -67,8 +67,8 @@ local function has_permission_edit_task(player, task)
        return true
    elseif allow_edit_task == "admin" then
        return player.admin
-    elseif allow_edit_task == "expcore.roles" then
-        return Roles.player_allowed(player, config.expcore_roles_allow_edit_task)
+    elseif allow_edit_task == "exp_roles" then
+        return Roles.player_has_permission(player, config.exp_roles_allow_edit_task)
    end

    return false
@@ -922,7 +922,7 @@ Gui.toolbar.create_button{
    sprite = "utility/not_enough_repair_packs_icon",
    tooltip = { "exp-gui_task-list.tooltip-main" },
    visible = function(player, element)
-        return Roles.player_allowed(player, "gui/task-list")
+        return Roles.player_has_permission(player, "exp_scenario.gui.task_list")
    end
 }

@@ -950,7 +950,6 @@ return {
    events = {
        [e.on_player_joined_game] = refresh_player_tasks,
        [e.on_player_changed_force] = refresh_player_tasks,
-        [Roles.events.on_role_assigned] = refresh_player_permissions,
-        [Roles.events.on_role_unassigned] = refresh_player_permissions,
+        [Roles.events.on_player_roles_changed] = refresh_player_permissions,
    }
 }