Permissions: groups

Server Part of Permissions.

Groups

Groups come from config/permissions.lua. Read them with GetGroupDefinition.

AddGroup

UgCore.Permissions.AddGroup(target, group, by?) -> ok, errorCode

MUST run in a thread. Adds the target to the group and applies it right away. Adding a member again does nothing and returns true.

string

required

A group from config/permissions.lua.

string

Who added it. Up to 64 characters.

RemoveGroup

UgCore.Permissions.RemoveGroup(target, group) -> ok, removed, errorCode

MUST run in a thread. removed is false when the target was not a member. Also deletes stored memberships of groups no longer in the config.

GetGroups

UgCore.Permissions.GetGroups(target) -> string[]

The target’s groups, highest weight first. Inherited groups are not listed.

IsInGroup

UgCore.Permissions.IsInGroup(target, group) -> boolean

True for direct members and through inheritance: a founder that inherits admin is also in admin.

GetWeight

UgCore.Permissions.GetWeight(target) -> integer

The highest weight of the target’s groups. 0 without groups.

CanTarget

UgCore.Permissions.CanTarget(actor, target) -> boolean

True when actor has a strictly higher weight than target. Source 0, the server console, outranks everyone and is outranked by no one.

UgCore.Commands.Register('kick', {
    permission = 'my-admin.kick',
    args = { { name = 'target', type = 'player' } },
}, function(source, args)
    if not UgCore.Permissions.CanTarget(source, args.target) then
        return
    end

    UgCore.Players.Kick(args.target)
end)

GetGroupDefinition

UgCore.Permissions.GetGroupDefinition(group) -> { label, weight, inherits?, permissions }?

A copy of the group from the config. nil for unknown groups.

IsInGroup, GetGroups, GetWeight and CanTarget only know memberships managed by UgCore, not add_principal lines in server.cfg.

Overview

Core

Networking and security

Players and characters

Economy and items

Roles and world

Tools

Permissions: groups

Groups

AddGroup

RemoveGroup

GetGroups

IsInGroup

GetWeight

CanTarget

GetGroupDefinition

​Groups

​AddGroup

​RemoveGroup

​GetGroups

​IsInGroup

​GetWeight

​CanTarget

​GetGroupDefinition

Groups

AddGroup

RemoveGroup

GetGroups

IsInGroup

GetWeight

CanTarget

GetGroupDefinition