CustomCommand Interface

Caution

This interface is still in pre-release. Its signature may change or it may be removed in future releases.

Define the custom command, including name, permissions, and parameters.

Properties

cheatsRequired?: boolean;

Cheats must be enabled to run this command. Defaults to true.

Type: boolean

description: string;

Command description as seen on the command line.

Type: string

mandatoryParameters?: CustomCommandParameter[];

List of mandatory command parameters.

name: string;

The name of the command. A namespace is required.

Type: string

optionalParameters?: CustomCommandParameter[];

List of optional command parameters.

permissionLevel: CommandPermissionLevel;

The permission level required to execute the command.