UgCore.Commands

Server Optional module. Proxied to ug-core.

Register

UgCore.Commands.Register(name, options, handler)

string

required

Lowercase. Registers /name.

UgCommandOptions

required

Hide fields

string

UgCommandArgument[]

Parsed and typed before the handler runs.

string

ACE the player MUST have.

{ max, per }

default:"{ max = 3, per = 2000 }"

Per player.

boolean

Requires a loaded player.

boolean

default:"true"

Allowed from the server console.

fun(source, args)

required

args is keyed by argument name. source is 0 for the console.

Argument types

Type	Value
`string`	One word, up to `max` characters (default 64).
`text`	The rest of the line, up to `max` characters (default 256). MUST be last.
`integer`	A whole number.
`number`	Any finite number.
`boolean`	`true`, `false`, `1` or `0`.
`player`	The source of a connected player.

Each argument has name, type, and optional optional, max and help. Optional arguments MUST be trailing.

Failures

ug-core shows nothing to players. A failure emits ug-core:Commands:Failed with (source, name, errorCode, argIndex), so a chat or notification resource can display it.

GetAll

UgCore.Commands.GetAll() -> UgCommandInfo[]

Commands sorted by name, with name, help, permission and args. Use it for chat suggestions, filtered by permission per player.

Example

UgCore.Commands.Register('givecash', {
    help = 'Give cash to a player',
    permission = 'ug.admin',
    args = {
        { name = 'target', type = 'player', help = 'Player id' },
        { name = 'amount', type = 'integer', help = 'Amount' },
    },
}, function(source, args)
    UgCore.Accounts.Add(args.target, 'cash', args.amount, 'admin:givecash')
end)

Overview

Core

Networking and security

Modules

Reference

UgCore.Commands

Register

Argument types

Failures

GetAll

Example

​Register

​Argument types

​Failures

​GetAll

​Example

Register

Argument types

Failures

GetAll

Example