Core Module - Permission Groups - Permission group making for factorio so you never have to make one by hand again
---- Example Group (Allow All)
-- here we will create an admin group however we do not want them to use the map editor or mess with the permission groups
Permission_Groups.new_group('Admin') -- this defines a new group called "Admin"
:allow_all() -- this makes the default to allow any input action unless set other wise
:disallow{ -- here we disallow the input action we don't want them to use
'add_permission_group',
'delete_permission_group',
'import_permissions_string',
'map_editor_action',
'toggle_map_editor'
}
---- Example Group (Disallow All)
-- here we will create a group that cant do anything but talk in chat
Permission_Groups.new_group('Restricted') -- this defines a new group called "Restricted"
:disallow_all() -- this makes the default to disallow any input action unless set other wise
:allow('write_to_console') -- here we allow them to chat, {} can be used here if we had more than one action
utils.game |
utils.event |
expcore.sudo |
new_group(name) | Defines a new permission group that can have it actions set in the config |
get_group_by_name(name) | Returns the group with the given name, case sensitive |
get_group_from_player(player) | Returns the group that a player is in |
reload_permissions() | Reloads/creates all permission groups and sets them to they configured state |
lockdown_permissions(exempt) | Removes all permissions from every permission group except for "Default" and any passed as exempt |
set_player_group(player, group) | Sets a player's group to the one given, a player can only have one group at a time |
Permissions_Groups._prototype:set_action(action, state) | Sets the allow state of an action for this group, used internally but is safe to use else where |
Permissions_Groups._prototype:allow(actions) | Sets an action or actions to be allowed for this group even with disallow_all triggered, Do not use in runtime |
Permissions_Groups._prototype:disallow(actions) | Sets an action or actions to be disallowed for this group even with allow_all triggered, Do not use in runtime |
Permissions_Groups._prototype:allow_all() | Sets the default state for any actions not given to be allowed, useful with :disallow |
Permissions_Groups._prototype:disallow_all() | Sets the default state for any action not given to be disallowed, useful with :allow |
Permissions_Groups._prototype:is_allowed(action) | Returns if an input action is allowed for this group |
Permissions_Groups._prototype:get_raw() | Returns the LuaPermissionGroup that was created with this group object, used internally |
Permissions_Groups._prototype:create() | Creates or updates the permission group with the configured actions, used internally |
Permissions_Groups._prototype:add_player(player) | Adds a player to this group |
Permissions_Groups._prototype:remove_player(player) | Removes a player from this group |
Permissions_Groups._prototype:get_players([online]) | Returns all player that are in this group with the option to filter to online/offline only |
Permissions_Groups._prototype:print(message) | Prints a message to every player in this group |
Defines a new permission group that can have it actions set in the config
Parameters:Returns the group with the given name, case sensitive
Parameters:Returns the group that a player is in
Parameters:Reloads/creates all permission groups and sets them to they configured state
Removes all permissions from every permission group except for "Default" and any passed as exempt
Parameters:Sets a player's group to the one given, a player can only have one group at a time
Parameters:Sets the allow state of an action for this group, used internally but is safe to use else where
Parameters:Sets an action or actions to be allowed for this group even with disallow_all triggered, Do not use in runtime
Parameters:Sets an action or actions to be disallowed for this group even with allow_all triggered, Do not use in runtime
Parameters:Sets the default state for any actions not given to be allowed, useful with :disallow
Returns:Sets the default state for any action not given to be disallowed, useful with :allow
Returns:Returns if an input action is allowed for this group
Parameters:Returns the LuaPermissionGroup that was created with this group object, used internally
Returns:Creates or updates the permission group with the configured actions, used internally
Returns:Adds a player to this group
Parameters:Removes a player from this group
Parameters:Returns all player that are in this group with the option to filter to online/offline only
Parameters: