Class CMD

custom command creator.

Example

const command = new CMD()
  .setName("tp")
  .setDescription("tp player to coord")
  .setPermision(CommandPermissionLevel.Any)
  .addPlayerSelector("player", true)
  .addLocation("location", true)
  .setFunction((eventData) => {
    const { source, args } = eventData;

    if (
      !source.sourceEntity ||
      source.sourceEntity?.typeId !== "minecraft:player"
    )
      return ResultStatus.failure();
    if (!Is.Player(args["player"]))
      return ResultStatus.failure("arg player need to be a player entity");
    if (!args["location"]) return ResultStatus.failure("need to be location");

    const target = args["player"];
    target.teleport(args["location"]);

    return ResultStatus.success();
  })
  .register();

Constructors

constructor

new CMD(init?: CustomCommand): CMD
create new instance of custom command creator.
Parameters
- Optionalinit: CustomCommand = ...
  custom command that already listed/registered.
Returns CMD
- Defined in cc.ts:210

Methods

addBlockType

addBlockType(name: string, require?: boolean): CMD
add argument type block, like when you use /fill or /place.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:489

addBoolean

addBoolean(name: string, require?: boolean): CMD
add argument type boolean, like yes/no true/false.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:349

addEntitySelector

addEntitySelector(name: string, require?: boolean): CMD
add argument type entity, like player, zombie ,or other entity.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:429

addEnum

addEnum(name: string, require?: boolean): CMD
add argument type enum from RegisterEnum
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:527

addFloat

addFloat(name: string, require?: boolean): CMD
add argument type float or decimal number, like 1.0, 2.4, 7.2.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:389

addInteger

addInteger(name: string, require?: boolean): CMD
add argument type integer or round number, like 1, 2, 3.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:369

addItemType

addItemType(name: string, require?: boolean): CMD
add argument type item.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:508

addLocation

addLocation(name: string, require?: boolean): CMD
add argument type location or position, usualy xyz coordinate.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:469

addPlayerSelector

addPlayerSelector(name: string, require?: boolean): CMD
add argument type player only, only a player will be check unlike addEntitySelector.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:449

addString

addString(name: string, require?: boolean): CMD
add argument type string or text, just text, a normal text.
Parameters
- name: string
  the name of this argument.
- Optionalrequire: boolean = true
  is it required or not, required arguments listed first.
Returns CMD
this

Throws
if its a required parameters, but added after optional parameters
- Defined in cc.ts:409

getCmd

getCmd(): CustomCommand
get this custom command object so can be use again

Returns CustomCommand
- Defined in cc.ts:266

getDescription

getDescription(): string
get this command description.

Returns string
the description of this command.
- Defined in cc.ts:304

getFunction

getFunction(): cmdFuncOut
get this command function.

Returns cmdFuncOut
function.
- Defined in cc.ts:604

getName

getName(): string
get this command name.

Returns string
the name of this command.
- Defined in cc.ts:285

getOptionalParams

getOptionalParams(): cmdParam
get this custom command optional arguments

Returns cmdParam
array of optional arguments
- Defined in cc.ts:573

getParameters

getParameters(): cmdParam
get this custom command's all arguments in order

Returns cmdParam
array of required and optional arguments
- Defined in cc.ts:582

getPermision

getPermision(): string
get this command permission level.

Returns string
permissionLevel.
- Defined in cc.ts:323

getRequireParams

getRequireParams(): cmdParam
get this custom command required arguments

Returns cmdParam
array of required arguments
- Defined in cc.ts:554

register

register(): void
do this at the end. verify the command and register it.

Returns void
Throws
if the syntax is wrong
- Defined in cc.ts:672

requireCheat

requireCheat(a: boolean): CMD
is cheat need to be enable to use (default can be change in the config)
Parameters
- a: boolean
  required?
Returns CMD
this
- Defined in cc.ts:258

run

run(source: CustomCommandOrigin, ...args: any[]): CustomCommandResult
convert raw data from the api into an object, that is the same to your arguments, for easy read, then pass it to your function to run it
Parameters
- source: CustomCommandOrigin
- ...args: any[]
Returns CustomCommandResult
Remarks
⚠️ don't use this functionn
- Defined in cc.ts:615

setDescription

setDescription(a: string): CMD
set this command description.
Parameters
- a: string
  description.
Returns CMD
this.
- Defined in cc.ts:295

setFunction

setFunction(func: cmdFuncOut): CMD
set this command function to run when called/executed.
Parameters
- func: cmdFuncOut
  function.
Returns CMD
this.
- Defined in cc.ts:595

setName

setName(a: string): CMD
set this command name.
Parameters
- a: string
  name.
Returns CMD
this.
- Defined in cc.ts:276

setOptionalParams

setOptionalParams(obj: cmdParam): CMD
set this custom command's optional arguments in batch
Parameters
- obj: cmdParam
  an array of cmdParam
Returns CMD
this
- Defined in cc.ts:564

setPermision

setPermision(a: CommandPermissionLevel): CMD
set this command permission level.
Parameters
- a: CommandPermissionLevel
  permissionLevel.
Returns CMD
this.
- Defined in cc.ts:314

setRequireParams

setRequireParams(obj: cmdParam): CMD
set this custom command's required arguments in batch
Parameters
- obj: cmdParam
  an array of cmdParam
Returns CMD
this
- Defined in cc.ts:545

setTagRank

setTagRank(tags: string[], anyOrAll?: "all" | "any"): CMD
set tab that required when running this command
Parameters
- tags: string[]
- anyOrAll: "all" | "any" = "any"
Returns CMD
- Defined in cc.ts:245

`Static`create

create(name: string): CMD
create new instance of custom command creator.
Parameters
- name: string
  name of the command
Returns CMD
- Defined in cc.ts:233

Class CMD

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CMD

Methods

addBlockType

Parameters

Returns CMD

Throws

addBoolean

Parameters

Returns CMD

Throws

addEntitySelector

Parameters

Returns CMD

Throws

addEnum

Parameters

Returns CMD

Throws

addFloat

Parameters

Returns CMD

Throws

addInteger

Parameters

Returns CMD

Throws

addItemType

Parameters

Returns CMD

Throws

addLocation

Parameters

Returns CMD

Throws

addPlayerSelector

Parameters

Returns CMD

Throws

addString

Parameters

Returns CMD

Throws

getCmd

Returns CustomCommand

getDescription

Returns string

getFunction

Returns cmdFuncOut

getName

Returns string

getOptionalParams

Returns cmdParam

getParameters

Returns cmdParam

getPermision

Returns string

getRequireParams

Returns cmdParam

register

Returns void

Throws

requireCheat

Parameters

Returns CMD

run

Parameters

Returns CustomCommandResult

Remarks

⚠️ don't use this functionn

setDescription

Parameters

Returns CMD

`Static`create