Interface PrefixAccessibleCommandType

The type of command data with an accessType of named and a customPrefix.

interface PrefixAccessibleCommandType {
    accessType: "named";
    aliases?: (
        | RegExpAccessibleCommandTypeAlias
        | PrefixAccessibleCommandTypeAlias
        | NameAccessibleCommandTypeAlias
    )[];
    callback: (
        player: Globals.modules.cmds.executeCommandPlayerW,
        event: ChatSendBeforeEvent,
    ) => CommandResponse;
    categories?: [commandCategory?, ...commandCategory[]];
    command_version?: string;
    commandName: string;
    customPrefix: string;
    deprecated?: boolean;
    description?: string;
    enabled?: boolean;
    flagsDocs?: string;
    formatting_code?: string;
    functional?: boolean;
    hidden?: boolean;
    requiredTags?: string[];
    syntax?: string;
    type: "built-in" | "custom" | "unknown";
    ultraSecurityModeSecurityLevel?:
        | "WorldEdit"
        | "owner"
        | "headAdmin"
        | "admin"
        | "moderator"
        | "everyone";
}

Hierarchy (View Summary)

Properties

accessType aliases? callback categories? command_version? commandName customPrefix deprecated? description? enabled? flagsDocs? formatting_code? functional? hidden? requiredTags? syntax? type ultraSecurityModeSecurityLevel?

Properties

accessType

accessType: "named"

The way the command is accessed.

  • named - Accessed through the command's name.
  • regexp - Accessed through a regular expression.

Optionalaliases

aliases?: (
    | RegExpAccessibleCommandTypeAlias
    | PrefixAccessibleCommandTypeAlias
    | NameAccessibleCommandTypeAlias
)[]

The aliases of the command.

Default

[]

callback

callback: (
    player: Globals.modules.cmds.executeCommandPlayerW,
    event: ChatSendBeforeEvent,
) => CommandResponse

The callback function of the command.

This function will be called in read-only mode.

Type declaration

Throws

If the command throws an error.

Optionalcategories

categories?: [commandCategory?, ...commandCategory[]]

The categories of the command.

Default

[]

Optionalcommand_version

command_version?: string

The version of the command.

Default

"1.0.0"

commandName

commandName: string

The name of the command.

customPrefix

customPrefix: string

The custom prefix of the command.

Optionaldeprecated

deprecated?: boolean

Whether or not the command is deprecated.

Default

false

Optionaldescription

description?: string

The description of the command.

Default

"Description Missing"

Optionalenabled

enabled?: boolean

Whether or not the command is enabled.

Default

true

OptionalflagsDocs

flagsDocs?: string

The documentation on the flags parameters of the command.

Optionalformatting_code

formatting_code?: string

The formatting code to display the command with.

Default

"§f"

Optionalfunctional

functional?: boolean

Whether or not the command is functional.

Default

true

Optionalhidden

hidden?: boolean

Whether or not the command is hidden.

Default

false

OptionalrequiredTags

requiredTags?: string[]

The tags required to execute the command.

Only applies when Ultra Security Mode is disabled.

Default

[]

Optionalsyntax

syntax?: string

The syntax of the command.

Default

"Syntax Missing"

type

type: "built-in" | "custom" | "unknown"

The type of the command.

OptionalultraSecurityModeSecurityLevel

ultraSecurityModeSecurityLevel?:
    | "WorldEdit"
    | "owner"
    | "headAdmin"
    | "admin"
    | "moderator"
    | "everyone"

The ultra security mode security level required to execute the command.

Default

"everyone"

Settings

Member Visibility

On This Page

Properties