LuaPermissionGroup
A permission group that defines what players in this group are allowed to do.
LuaPermissionGroup
Adds the given player to this group.
Removes the given player from this group.
Whether this group allows the given action.
Sets whether this group allows the performance the given action.
The class name of this object.
Adds the given player to this group.
Whether this group allows the given action.
The class name of this object.
Removes the given player from this group.
Sets whether this group allows the performance the given action.
add_player(player)
→
boolean
Adds the given player to this group.
Whether the player was added.
remove_player(player)
→
boolean
Removes the given player from this group.
Whether the player was removed.
allows_action(action)
→
boolean
Whether this group allows the given action.
The action in question.
set_allows_action(action,
allow_action)
→
boolean
destroy()
→
boolean
help()
→
string
All methods and properties that this object supports.
name
:: string
[Read/Write]
The name of this group.
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.