ChatboxCommand
Defined in: src/events/ChatboxCommand.ts:6
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.
Extends
Section titled “Extends”Properties
Section titled “Properties”args:
string
[]
Defined in: src/events/ChatboxCommand.ts:15
Array of space-separated string arguments after the command.
command
Section titled “command”command:
string
Defined in: src/events/ChatboxCommand.ts:12
The name of the command (the word immediately following the backslash/caret/pipe, excluding the backslash/caret/pipe).
event:
string
Defined in: src/events/BaseEvent.ts:5
Inherited from
Section titled “Inherited from”id:
number
Defined in: src/events/BaseEvent.ts:4
Inherited from
Section titled “Inherited from”ok:
boolean
Defined in: src/packets/Data.ts:2
Inherited from
Section titled “Inherited from”ownerOnly
Section titled “ownerOnly”ownerOnly:
boolean
Defined in: src/events/ChatboxCommand.ts:18
true
if the command is an owner-only command (^command
).
time:
Date
Defined in: src/events/BaseEvent.ts:6
Inherited from
Section titled “Inherited from”type:
string
Defined in: src/packets/Data.ts:3
Inherited from
Section titled “Inherited from”user:
User
Defined in: src/events/ChatboxCommand.ts:8
The in-game player who ran the command.