Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Runtime Docs Version 2.0.77

# LuaPermissionGroup - Runtime Docs

## Class LuaPermissionGroup

A permission group that defines what players in this group are allowed to do.

## Members

add_player(player) | → boolean | Adds the given player to this group.
Adds the given player to this group.
remove_player(player) | → boolean | Removes the given player from this group.
Removes the given player from this group.
allows_action(action) | → boolean | Whether this group allows the given action.
Whether this group allows the given action.
set_allows_action(action, allow_action) | → boolean | Sets whether this group allows the performance the given action.
Sets whether this group allows the performance the given action.
destroy() | → boolean | Destroys this group.
Destroys this group.
name | :: RW string | The name of this group. [...]
The name of this group. [...]
players | :: R array[LuaPlayer] | The players in this group.
The players in this group.
group_id | :: R uint32 | The group ID
The group ID
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

## Methods

### add_player(player) → boolean

Adds the given player to this group.

#### Parameters

player | :: PlayerIdentification |

#### Return values

→ boolean | Whether the player was added.

### remove_player(player) → boolean

Removes the given player from this group.

#### Parameters

player | :: PlayerIdentification |

#### Return values

→ boolean | Whether the player was removed.

### allows_action(action) → boolean

Whether this group allows the given action.

#### Parameters

action | :: defines.input_action | The action in question.
The action in question.

### set_allows_action(action, allow_action) → boolean

Sets whether this group allows the performance the given action.

#### Parameters

action | :: defines.input_action | The action in question.
The action in question.
allow_action | :: boolean | Whether to allow the specified action.
Whether to allow the specified action.

#### Return values

→ boolean | Whether the value was successfully applied.

### destroy() → boolean

Destroys this group.

#### Return values

→ boolean | Whether the group was successfully destroyed.

## Attributes

### name :: Read|Write string

The name of this group. Setting the name to `nil` or an empty string sets the name to the default value.

### players :: Read array[LuaPlayer]

The players in this group.

### group_id :: Read uint32

The group ID

### valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

### object_name :: Read string

The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Class used in

- LuaPermissionGroups::create_group()
- LuaPermissionGroups::get_group()
- LuaPermissionGroups::groups
- LuaPlayer::permission_group
- RegistrationTarget
- on_permission_group_added
- on_permission_group_edited
- on_pre_permission_group_deleted