Factorio API Docs

1.1.57 <>

Class LuaPermissionGroup

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

add_player(player)
boolean

Adds the given player to this group.


remove_player(player)
boolean

Removes the given player from this group.


allows_action(action)
boolean

Whether this group allows the given action.


set_allows_action(action, allow_action)
boolean

Sets whether this group allows the performance the given action.


boolean

Destroys this group.


help()
string

All methods and properties that this object supports.


:: string
[RW]

The name of this group.


:: array[LuaPlayer]
[R]

The players in this group.


:: uint
[R]

The group ID


:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Methods

add_player(player) → boolean

Adds the given player to this group.

Parameters

Return values

:: boolean

Whether the player was added.


remove_player(player) → boolean

Removes the given player from this group.

Parameters

Return values

:: boolean

Whether the player was removed.


allows_action(action) → boolean

Whether this group allows the given action.

Parameters

action

The action in question.

Return values

:: boolean

set_allows_action(action, allow_action) → boolean

Sets whether this group allows the performance the given action.

Parameters

action

The action in question.


allow_action
:: boolean

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.


help() → string

All methods and properties that this object supports.

Return values

:: string

Attributes

name :: string [Read/Write]

The name of this group.

Note

Setting the name to nil or an empty string sets the name to the default value.


players :: array[LuaPlayer] [Read]

The players in this group.


group_id :: uint [Read]

The group ID


valid :: boolean [Read]

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 :: string [Read]

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.

|<

Classes

Events

Concepts

Defines

Builtin types

>|