Files
factorio-scenario-ExpCluster/exp_scenario/module/commands/roles.lua
T
bbassieandClaude Fable 5 bea8d46c82 Address review on the role api
- Roles are objects and everything done to or with a role is a method on it:
  assign, unassign, has_player, has_permission, is_higher_than,
  is_lower_than, get_players, get_player_names, print. Assignment has one
  entry point, role:assign(player, options), with local_only as an option
  rather than a second function.
- Roles are looked up by clusterio id with get_role; get_role_by_name searches
  the list for the few places, such as configs, which only know a name. The
  name map and the ordered list are gone, get_roles sorts on demand and the
  index field is replaced by the comparison methods.
- Players are LuaPlayer objects only, with nil or index 0 for the server.
- get_higher_roles and get_lower_roles replace print_to_roles_higher and
  print_to_roles_lower, call sites loop over them with role:print.
- Permission groups are removed from roles again, exp_groups owns the mapping
  from roles to groups.
- Seeding is a SeedRolesRequest behind a button on the roles page rather than
  running on first start, and creates only the roles; the player assignments
  are dropped. The seed lists each permission once at the lowest role which
  has it and lets the parent chain carry it up.
- System commands unlock for core.admin rather than a permission of their own.
- Role metatables are registered with Storage.register_metatable so the
  methods survive save and load, which the role records in storage needed.
- The player list auth uses Roles.player_outranks directly, and the event
  carries role ids rather than names.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-19 15:52:50 +00:00

62 lines
2.6 KiB
Lua

--[[-- Commands - Roles
Adds a commands that allow interaction with the role system
]]
local Commands = require("modules/exp_commands")
local format_player_name = Commands.format_player_name_locale
local format_text = Commands.format_rich_text_color_locale
local Roles = require("modules/exp_roles")
local get_roles = Roles.get_roles
local get_player_roles = Roles.get_player_roles
--- Assigns a role to a player
Commands.new("assign-role", { "exp-commands_roles.description-assign" })
:argument("player", { "exp-commands_roles.arg-player-assign" }, Commands.types.lower_role_player)
:argument("role", { "exp-commands_roles.arg-role-assign" }, Commands.types.lower_role)
:add_aliases{ "assign" }
:add_flags{ "admin_only" }
:register(function(player, other_player, role)
--- @cast other_player LuaPlayer
--- @cast role ExpRoles.Role
role:assign(other_player, { by_player_name = player.name })
end)
--- Unassigns a role to a player
Commands.new("unassign-role", { "exp-commands_roles.description-unassign" })
:argument("player", { "exp-commands_roles.arg-player-unassign" }, Commands.types.lower_role_player)
:argument("role", { "exp-commands_roles.arg-role-unassign" }, Commands.types.lower_role)
:add_aliases{ "unassign" }
:add_flags{ "admin_only" }
:register(function(player, other_player, role)
--- @cast other_player LuaPlayer
--- @cast role ExpRoles.Role
role:unassign(other_player, { by_player_name = player.name })
end)
--- Lists all roles in they correct order
Commands.new("get-roles", { "exp-commands_roles.description-get" })
:optional("player", { "exp-commands_roles.arg-player-get" }, Commands.types.player)
:add_aliases{ "roles" }
:register(function(player, other_player)
--- @cast other_player LuaPlayer?
local roles = get_roles()
local roles_formatted = { "" } --- @type LocalisedString
local response = { "exp-commands_roles.list-roles", roles_formatted } --[[@as LocalisedString]]
if other_player then
roles = get_player_roles(other_player)
response[1] = "exp-commands_roles.list-player"
response[3] = format_player_name(other_player)
end
for index, role in ipairs(roles) do
local role_name = format_text(role.name, role.color or Commands.color.white)
roles_formatted[index + 1] = { "exp-commands_roles.list-element", role_name }
end
local last = #roles_formatted
roles_formatted[last] = assert(roles_formatted[last])[2]
return Commands.status.success(response)
end)