LuaPermissionGroup

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

Attributes

name

• Read: string
• Write: string
• Optional: false

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>
• Write: unknown
• Optional: false

The players in this group.

group_id

• Read: uint32
• Write: unknown
• Optional: false

The group ID

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.

Methods

add_player

LuaPermissionGroup.add_player(player: PlayerIdentification) -> boolean

Call As

permissionGroup.add_player(player)

Call Convention

• takes_table: false
• table_optional: false

Adds the given player to this group.

Parameters

• player: PlayerIdentification

Returns

• boolean — Whether the player was added.

remove_player

LuaPermissionGroup.remove_player(player: PlayerIdentification) -> boolean

Call As

permissionGroup.remove_player(player)

Call Convention

• takes_table: false
• table_optional: false

Removes the given player from this group.

Parameters

• player: PlayerIdentification

Returns

• boolean — Whether the player was removed.

allows_action

LuaPermissionGroup.allows_action(action: defines.input_action) -> boolean

Call As

permissionGroup.allows_action(action)

Call Convention

• takes_table: false
• table_optional: false

Whether this group allows the given action.

Parameters

• action: defines.input_action — The action in question.

Returns

• boolean

set_allows_action

LuaPermissionGroup.set_allows_action(action: defines.input_action, allow_action: boolean) -> boolean

Call As

permissionGroup.set_allows_action(action, true)

Call Convention

• takes_table: false
• table_optional: false

Sets whether this group allows the performance the given action.

Parameters

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

Returns

• boolean — Whether the value was successfully applied.

destroy

LuaPermissionGroup.destroy() -> boolean

Call As

permissionGroup.destroy()

Call Convention

• takes_table: false
• table_optional: false

Destroys this group.

Returns

• boolean — Whether the group was successfully destroyed.