Interface CustomCommandBeta

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

interface CustomCommand {
    cheatsRequired?: boolean;
    description: string;
    mandatoryParameters?: CustomCommandParameter[];
    name: string;
    optionalParameters?: CustomCommandParameter[];
    permissionLevel: CommandPermissionLevel;
}

Properties

cheatsRequired? description mandatoryParameters? name optionalParameters? permissionLevel

Properties

Optional BetacheatsRequired

cheatsRequired?: boolean

Remarks

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

Betadescription

description: string

Remarks

Command description as seen on the command line.

Optional BetamandatoryParameters

mandatoryParameters?: CustomCommandParameter[]

Remarks

List of mandatory command parameters.

Betaname

name: string

Remarks

The name of the command. A namespace is required.

Optional BetaoptionalParameters

optionalParameters?: CustomCommandParameter[]

Remarks

List of optional command parameters.

BetapermissionLevel

permissionLevel: CommandPermissionLevel

Remarks

The permission level required to execute the command.

Settings

Member Visibility

On This Page

Properties