Class command<T>

Represents a command.

Type Param: The

type of the command.

Type Parameters

T extends "built-in" | "custom" | "unknown" = "unknown"

Constructors

constructor

new command<T extends "built-in" | "custom" | "unknown" = "unknown">(
    command:
        | Globals.modules.cmds.command<T>
        | {
            category?: string | string[];
            command_version?: string | number;
            commandName: string;
            commands_format_version?: string | number;
            commandSettingsId?: string;
            customCommandCodeLines?: number;
            customCommandId?: string;
            customCommandParametersEnabled?: boolean;
            customCommandParametersList?: evaluateParametersArgumentTypes[];
            customCommandPrefix?: string;
            customCommandType?: "commands" | "javascript";
            description?: string;
            escregexp?: { f?: string; v: string };
            format_version?: string | number;
            formats?: command_formats_type_list;
            formatting_code?: string;
            type: T;
        },
): Globals.modules.cmds.command<T>
Creates an instance of the command class.
Type Parameters
- T extends "built-in" | "custom" | "unknown" = "unknown"
Parameters
- command:
      | Globals.modules.cmds.command<T>
      | {
          category?: string | string[];
          command_version?: string | number;
          commandName: string;
          commands_format_version?: string | number;
          commandSettingsId?: string;
          customCommandCodeLines?: number;
          customCommandId?: string;
          customCommandParametersEnabled?: boolean;
          customCommandParametersList?: evaluateParametersArgumentTypes[];
          customCommandPrefix?: string;
          customCommandType?: "commands" | "javascript";
          description?: string;
          escregexp?: { f?: string; v: string };
          format_version?: string | number;
          formats?: command_formats_type_list;
          formatting_code?: string;
          type: T;
      }
  The command to create.
Returns Globals.modules.cmds.command<T>
An instance of the command class.
- Defined in modules/commands/classes/command.ts:260

Properties

`Optional`categories

categories?: string[]

The categories of the command.

This is used in the manage commands menu to determine where it should appear.

`Optional`category

category?: string | string[]

The category(ies) of the command.

This is used in the manage commands menu to determine where it should appear.

`Optional`command_version

command_version?: string | number

The version of the command.

commandName

commandName: string

The name of the command.

commands_format_version

commands_format_version: string | number = commands_format_version

The commands format version that the command was created in.

commandSettingsId

commandSettingsId: string

The ID of the command settings.

currentCommandName

currentCommandName: string

The currently entered command name, either the command name or an alias.

`Optional`currentescregexp

currentescregexp?: { f?: string; v: string }

The current escaped regular expression to determine if a string is this command, either the regular expression or the regular expression of an alias.

`Optional`customCommandCodeLines

customCommandCodeLines?: number

The number of lines of code in the custom command.

`Optional`customCommandId

customCommandId?: string

The ID of the custom command.

`Optional`customCommandParametersEnabled

customCommandParametersEnabled?: boolean

Whether parameters should be automatcially evaluated for the command.

`Optional`customCommandParametersList

customCommandParametersList?: evaluateParametersArgumentTypes[]

The list of parameters of the custom command.

`Optional`customCommandPrefix

customCommandPrefix?: string

The prefix of the custom command.

`Optional`customCommandType

customCommandType?: "commands" | "javascript"

The type of the custom command.

"commands": The custom command uses vanilla Minecraft commands.
"javascript": The custom command uses javascript.

`Optional`description

description?: string

The description of the command.

`Optional`escregexp

escregexp?: { f?: string; v: string }

The escaped regular expression to determine if a string is this command.

format_version

format_version: string | number = format_version

The version of the add-on that custom command was created in.

formats

formats: command_formats_type_list

The syntaxes of the command.

formatting_code

formatting_code: string = "§r§f"

The formatting code of the command.

`Optional`parameters

parameters?: {
    displayType?: string;
    evaluationType?: string;
    internalType?: evaluateParametersArgumentTypes;
    name: string;
    type?: string;
}[]

The parameters of the command.

Only applies to custom commands.

Type declaration

OptionaldisplayType?: string
The display type of the parameter.
OptionalevaluationType?: string
The evaluation type of the parameter.
OptionalinternalType?: evaluateParametersArgumentTypes
The internal type of the parameter.
name: string
The name of the parameter.
Optionaltype?: string
The type of the parameter.

`Optional`selectedalias

selectedalias?: {
    alias: {
        aliasTo?: string;
        commandName: string;
        escregexp?: { f?: string; v: string };
        regexp: RegExp;
    };
    index: number;
}

The currently selected alias of the command, if the user is using an alias.

Type declaration

alias: {
    aliasTo?: string;
    commandName: string;
    escregexp?: { f?: string; v: string };
    regexp: RegExp;
}
The details of the alias.
- OptionalaliasTo?: string
  The name of the command the alias is an alias of.
- commandName: string
  The name of the alias.
- Optionalescregexp?: { f?: string; v: string }
  The escaped regular expression of the alias.
- regexp: RegExp
  The regular expression of the alias.
index: number
The index of the alias.

type

type: T

The type of the command.

"built-in": Built-in command.
"custom": Custom command.
"unknown": Unknown command type.

Accessors

aliases

get aliases(): T extends "built-in"
    ? {
        aliasTo?: string;
        commandName: string;
        escregexp?: { f?: string; v: string };
        regexp: RegExp;
    }[]
    : undefined
The aliases of the command.

Only available if the command is a built-in command.

Returns T extends "built-in"
    ? {
        aliasTo?: string;
        commandName: string;
        escregexp?: { f?: string; v: string };
        regexp: RegExp;
    }[]
    : undefined
- Defined in modules/commands/classes/command.ts:396

code

get code(): string[]
The code of the custom command.

If customCommandType is commands, the code will be a list of strings with vanilla Minecraft commands.

If customCommandType is javascript, the code will be a list of strings that represent lines of JavaScript code, this should be merged together with newline characters.

Returns string[]
Throws
If the command is not a custom command (Tests if the type property is custom).

Throws
If the customCommandId property is undefined.
- Defined in modules/commands/classes/command.ts:460

currentregexp

get currentregexp(): RegExp
The current regular expression to determine if a string is this command, will be either the parsed regexp of the command or on of its aliases.

Returns RegExp
- Defined in modules/commands/classes/command.ts:388

isDeprecated

get isDeprecated(): boolean
If the command is deprecated.

Returns boolean
- Defined in modules/commands/classes/command.ts:364

isFunctional

get isFunctional(): boolean
If the command is functional.

Returns boolean
- Defined in modules/commands/classes/command.ts:370

isHidden

get isHidden(): boolean
If the command is hidden.

Returns boolean
- Defined in modules/commands/classes/command.ts:358

regexp

get regexp(): RegExp
The regular expression to determine if a string is this command.

Returns RegExp
- Defined in modules/commands/classes/command.ts:382

releaseStage

get releaseStage(): string
The release stage of the command.

Returns string
- Defined in modules/commands/classes/command.ts:376

settings

get settings(): Globals.modules.cmds.commandSettings<T>
The settings of the command, will be an instance of the commandSettings class.

Returns Globals.modules.cmds.commandSettings<T>
- Defined in modules/commands/classes/command.ts:431

ultraSecurityModeSecurityLevel

get ultraSecurityModeSecurityLevel(): | "admin"
| "WorldEdit"
| "owner"
| "headAdmin"
| "moderator"
| "everyone"
The ultra security mode security level of the command.

Only applies when ultra security mode is enabled.
- owner: Only the owner or people with the andexdb.fullControl or andexdb.useOwnerLevelCommands permissions can execute the command.
- headAdmin: Only players with the andexdb.headAdmin or andexdb.useHeadAdminLevelCommands permissions can execute the command.
- admin: Only players with the andexdb.admin or andexdb.useAdminLevelCommands permissions can execute the command.
- moderator: Only players with the andexdb.moderator or andexdb.useModeratorLevelCommands permissions can execute the command.
- WorldEdit: Only players with the andexdb.WorldEdit permission can execute the command.
- everyone: Everyone can execute the command.
Returns "admin" | "WorldEdit" | "owner" | "headAdmin" | "moderator" | "everyone"
- Defined in modules/commands/classes/command.ts:446

`Static`defaultPrefix

get defaultPrefix(): string
The current prefix set for the chat commands.

Returns string
Default
```
"\\"
```
- Defined in modules/commands/classes/command.ts:830

`Static`dp

get dp(): string
The current prefix set for the chat commands.

This is an alias of defaultPrefix.

Returns string
Default
```
"\\"
```
- Defined in modules/commands/classes/command.ts:840

Methods

remove

remove(): void
Removes the current command if it is a custom command.

Returns void
Throws
If the command is not a custom command (Tests if the type property is custom).

Throws
If the customCommandId property is undefined.
- Defined in modules/commands/classes/command.ts:503

run

run(
    commandstring: string,
    executor: Dimension | loosePlayerType,
    player?: Player | Globals.modules.cmds.executeCommandPlayerW,
    event?: Object,
): void
Runs the custom command.
Parameters
- commandstring: string
  The command string.
- executor: Dimension | loosePlayerType
  The executor of the command.
- Optionalplayer: Player | Globals.modules.cmds.executeCommandPlayerW
  The player object that can be accessed by the code of the command.
- Optionalevent: Object
  The event object that can be accessed by the code of the command.
Returns void
Throws
If the command is not a custom command (Tests if the type property is custom).

Throws
If the customCommandId property is undefined.

Throws
If the vanilla minecraft command throws an error.

Throws
If the custom command throws an error.

Throws
If the custom JavaScript code throws an error.
- Defined in modules/commands/classes/command.ts:590

save

save(): string
Saves the custom command.

Returns string
The ID of the custom command.

Throws
If the command is not a custom command (Tests if the type property is custom).

Throws
If the customCommandId property is undefined.
- Defined in modules/commands/classes/command.ts:485

testCanPlayerUseCommand

testCanPlayerUseCommand(player: loosePlayerType): boolean
Tests if the given player can use this command.
Parameters
- player: loosePlayerType
  The player to test.
Returns boolean
True if the player can use this command, false otherwise. If the player is an instance of the executeCommandPlayerW class, and there is no linked player, or the linked player is not online, the function will return false.

Throws
If player is not an instance of the Player class or an instance of the executeCommandPlayerW class with a Player linked to it.
- Defined in modules/commands/classes/command.ts:521

`Static`findBuiltIn

findBuiltIn(
    commandString: string,
    returnCommandInsteadOfAlias?: boolean,
):
    | {
        aliases?: {
            commandName: string;
            escregexp?: { f?: string; v?: string };
        }[];
        category?: commandCategory
        | commandCategory[];
        command_version: string;
        commandName: string;
        commandSettingsId: string;
        deprecated: boolean;
        description: string;
        enabled: boolean;
        escregexp: { f?: string; v: string };
        formats: command_formats_type_list;
        formatting_code: string;
        functional: boolean;
        hidden: boolean;
        requiredTags: string[];
        type: "built-in";
        ultraSecurityModeSecurityLevel:
            | "admin"
            | "WorldEdit"
            | "owner"
            | "headAdmin"
            | "moderator"
            | "everyone";
    }
    | {
        alias: { commandName: string; escregexp?: { f?: string; v?: string } };
        aliasTo: {
            aliases?: {
                commandName: string;
                escregexp?: { f?: string; v?: string };
            }[];
            category?: commandCategory
            | commandCategory[];
            command_version: string;
            commandName: string;
            commandSettingsId: string;
            deprecated: boolean;
            description: string;
            enabled: boolean;
            escregexp: { f?: string; v: string };
            formats: command_formats_type_list;
            formatting_code: string;
            functional: boolean;
            hidden: boolean;
            requiredTags: string[];
            type: "built-in";
            ultraSecurityModeSecurityLevel:
                | "admin"
                | "WorldEdit"
                | "owner"
                | "headAdmin"
                | "moderator"
                | "everyone";
        };
        index: number;
    }
Gets a built-in command.
Parameters
- commandString: string
  The command string to detect the command from.
- OptionalreturnCommandInsteadOfAlias: boolean = false
  Whether or not to always return the main command, even if the detected command is an alias.
Returns
    | {
        aliases?: {
            commandName: string;
            escregexp?: { f?: string; v?: string };
        }[];
        category?: commandCategory
        | commandCategory[];
        command_version: string;
        commandName: string;
        commandSettingsId: string;
        deprecated: boolean;
        description: string;
        enabled: boolean;
        escregexp: { f?: string; v: string };
        formats: command_formats_type_list;
        formatting_code: string;
        functional: boolean;
        hidden: boolean;
        requiredTags: string[];
        type: "built-in";
        ultraSecurityModeSecurityLevel:
            | "admin"
            | "WorldEdit"
            | "owner"
            | "headAdmin"
            | "moderator"
            | "everyone";
    }
    | {
        alias: { commandName: string; escregexp?: { f?: string; v?: string } };
        aliasTo: {
            aliases?: {
                commandName: string;
                escregexp?: { f?: string; v?: string };
            }[];
            category?: commandCategory
            | commandCategory[];
            command_version: string;
            commandName: string;
            commandSettingsId: string;
            deprecated: boolean;
            description: string;
            enabled: boolean;
            escregexp: { f?: string; v: string };
            formats: command_formats_type_list;
            formatting_code: string;
            functional: boolean;
            hidden: boolean;
            requiredTags: string[];
            type: "built-in";
            ultraSecurityModeSecurityLevel:
                | "admin"
                | "WorldEdit"
                | "owner"
                | "headAdmin"
                | "moderator"
                | "everyone";
        };
        index: number;
    }
The built-in command.
- Defined in modules/commands/classes/command.ts:657

`Static`get

get<T extends "built-in" | "custom" | "unknown" = "built-in">(
commandName: string,
type?: T,
): Globals.modules.cmds.command<T>
Gets a command.
Type Parameters
- T extends "built-in" | "custom" | "unknown" = "built-in"
  The type of the command.
Parameters
- commandName: string
  The name of the command.
- Optionaltype: T
  The type of the command.
Returns Globals.modules.cmds.command<T>
The command.
- Defined in modules/commands/classes/command.ts:634

`Static`getCommandAliases

getCommandAliases(): {
    [key: string]: {
        commandName: string;
        escregexp?: { f?: string; v?: string };
    }[];
}
Gets all of the aliases of the built-in commands.

Returns {
    [key: string]: {
        commandName: string;
        escregexp?: { f?: string; v?: string };
    }[];
}
The aliases of the built-in commands.
- Defined in modules/commands/classes/command.ts:759

`Static`getCustomCommands

getCustomCommands(noSort?: boolean): Globals.modules.cmds.command<"custom">[]
Gets all of the custom commands.
Parameters
- OptionalnoSort: boolean = false
  If set to true, it will not sort the commands.
Returns Globals.modules.cmds.command<"custom">[]
The array of custom commands.
- Defined in modules/commands/classes/command.ts:786

`Static`getDefaultCommands

getDefaultCommands(noSort?: boolean): Globals.modules.cmds.command<"built-in">[]
Gets the built-in commands.
Parameters
- OptionalnoSort: boolean = false
  If set to true, it will not sort the commands.
Returns Globals.modules.cmds.command<"built-in">[]
The array of built-in commands.
- Defined in modules/commands/classes/command.ts:687

`Static`getDefaultCommandsOfCategory

getDefaultCommandsOfCategory(
category: commandCategory,
noSort?: boolean,
): Globals.modules.cmds.command<"built-in">[]
Gets the built-in commands of a category.
Parameters
- category: commandCategory
  The category of the commands.
- OptionalnoSort: boolean = false
  If set to true, it will not sort the commands.
Returns Globals.modules.cmds.command<"built-in">[]
The array of built-in commands.
- Defined in modules/commands/classes/command.ts:727

Class command<T>

Type Param: The

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Globals.modules.cmds.command<T>

Properties

Optionalcategories

Optionalcategory

Optionalcommand_version

commandName

commands_format_version

commandSettingsId

currentCommandName

Optionalcurrentescregexp

OptionalcustomCommandCodeLines

OptionalcustomCommandId

OptionalcustomCommandParametersEnabled

OptionalcustomCommandParametersList

OptionalcustomCommandPrefix

OptionalcustomCommandType

Optionaldescription

Optionalescregexp

format_version

formats

formatting_code

Optionalparameters

Type declaration

OptionaldisplayType?: string

OptionalevaluationType?: string

OptionalinternalType?: evaluateParametersArgumentTypes

name: string

Optionaltype?: string

Optionalselectedalias

Type declaration

alias: { aliasTo?: string; commandName: string; escregexp?: { f?: string; v: string }; regexp: RegExp;}

OptionalaliasTo?: string

commandName: string

Optionalescregexp?: { f?: string; v: string }

regexp: RegExp

index: number

type

Accessors

aliases

Returns T extends "built-in" ? { aliasTo?: string; commandName: string; escregexp?: { f?: string; v: string }; regexp: RegExp; }[] : undefined

code

Returns string[]

Throws

Throws

currentregexp

Returns RegExp

isDeprecated

Returns boolean

isFunctional

Returns boolean

isHidden

Returns boolean

regexp

Returns RegExp

releaseStage

Returns string

settings

Returns Globals.modules.cmds.commandSettings<T>

ultraSecurityModeSecurityLevel

Returns "admin" | "WorldEdit" | "owner" | "headAdmin" | "moderator" | "everyone"

StaticdefaultPrefix

Returns string

Default

Staticdp

Returns string

Default

Methods

remove

`Optional`categories

`Optional`category

`Optional`command_version

`Optional`currentescregexp

`Optional`customCommandCodeLines

`Optional`customCommandId

`Optional`customCommandParametersEnabled

`Optional`customCommandParametersList

`Optional`customCommandPrefix

`Optional`customCommandType

`Optional`description

`Optional`escregexp

`Optional`parameters

`Optional`displayType?: string

`Optional`evaluationType?: string

`Optional`internalType?: evaluateParametersArgumentTypes

`Optional`type?: string

`Optional`selectedalias

alias: {
aliasTo?: string;
commandName: string;
escregexp?: { f?: string; v: string };
regexp: RegExp;
}

`Optional`aliasTo?: string

`Optional`escregexp?: { f?: string; v: string }

Returns T extends "built-in"
? {
aliasTo?: string;
commandName: string;
escregexp?: { f?: string; v: string };
regexp: RegExp;
}[]
: undefined

`Static`defaultPrefix

`Static`dp

`Static`findBuiltIn

`Static`get

`Static`getCommandAliases

Returns {
[key: string]: {
commandName: string;
escregexp?: { f?: string; v?: string };
}[];
}

`Static`getCustomCommands

`Static`getDefaultCommands

`Static`getDefaultCommandsOfCategory