The event received when a player runs a chatbox command (public backslash commands: \command, private owner-only caret/pipe commands: ^command) in-game. The command capability is required to receive command events.

Hierarchy

Properties

args: string[]

Array of space-separated string arguments after the command.

command: string

The name of the command (the word immediately following the backslash/caret/pipe, excluding the backslash/caret/pipe).

event: string
id: number
ok: boolean
ownerOnly: boolean

true if the command is an owner-only command (^command).

time: Date
type: string
user: User

The in-game player who ran the command.

Generated using TypeDoc