Factorio Runtime Docs

Class LuaPermissionGroups

All permission groups.

Members

create_group(name?)  → LuaPermissionGroup?

Creates a new permission group.

Creates a new permission group.

get_group(group)  → LuaPermissionGroup?

Gets the permission group with the given name or group ID.

Gets the permission group with the given name or group ID.

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

groups [R] :: array[LuaPermissionGroup]

All of the permission groups.

All of the permission groups.

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

create_group(name?)  → LuaPermissionGroup?

Creates a new permission group.

Parameters

name :: string?

Return values

→ LuaPermissionGroup?

nil if the calling player doesn't have permission to make groups.


get_group(group)  → LuaPermissionGroup?

Gets the permission group with the given name or group ID.

Parameters

group :: string or uint

Return values

→ LuaPermissionGroup?

nil if there is no matching group.


help()  → string

All methods and properties that this object supports.

Attributes

groups :: array[LuaPermissionGroup] Read

All of the permission groups.


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

>|