Class CMD<P, A>

custom command creator.

Example

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();

Type Parameters

P extends Phase = "required"
A extends object = {}

Constructors

constructor

new CMD(
init?: CustomCommand,
): CMD<P, A>
create new instance of custom command creator.
Type Parameters
- P extends Phase = "required"
- A extends object = {}
Parameters
- Optionalinit: CustomCommand = ...
 custom command that already listed/registered.
Returns CMD<P, A>
- Defined in cc.ts:209

Methods

addAlias

addAlias(a: string): CMD<P, A>
add this command a name alias
Parameters
- a: string
 name
Returns CMD<P, A>
this
- Defined in cc.ts:303

addBlockType

addBlockType<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
add argument type block, like when you use /fill or /place.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
this

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

addBoolean

addBoolean<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true
 ? { [P in string]: boolean }
 : { [P in string]?: boolean }
 ),
>
add argument type boolean, like yes/no true/false.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true
 ? { [P in string]: boolean }
 : { [P in string]?: boolean }
 ),
>
this

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

addEntitySelector

addEntitySelector<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: Entity } : { [P in string]?: Entity }
 ),
>
add argument type entity, like player, zombie ,or other entity.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: Entity } : { [P in string]?: Entity }
 ),
>
this

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

addEnum

addEnum<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
 value?: string[],
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
add argument type enum from RegisterEnum
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first
- Optionalvalue: string[] = []
 the value of enum to add if enum is not registered.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
this

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

addFloat

addFloat<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: number } : { [P in string]?: number }
 ),
>
add argument type float or decimal number, like 1.0, 2.4, 7.2.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: number } : { [P in string]?: number }
 ),
>
this

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

addInteger

addInteger<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: number } : { [P in string]?: number }
 ),
>
add argument type integer or round number, like 1, 2, 3.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: number } : { [P in string]?: number }
 ),
>
this

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

addItemType

addItemType<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
add argument type item.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
this

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

addLocation

addLocation<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true
 ? { [P in string]: Vector3 }
 : { [P in string]?: Vector3 }
 ),
>
add argument type location or position, usualy xyz coordinate.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true
 ? { [P in string]: Vector3 }
 : { [P in string]?: Vector3 }
 ),
>
this

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

addPlayerSelector

addPlayerSelector<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: Player } : { [P in string]?: Player }
 ),
>
add argument type player only, only a player will be check unlike addEntitySelector.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: Player } : { [P in string]?: Player }
 ),
>
this

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

addString

addString<N extends string, R extends boolean>(
 this: P extends "required"
 ? CMD<P, A>
 : R extends false ? CMD<P, A> : never,
 name: N,
 require?: R,
): CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
add argument type string or text, just text, a normal text.
Type Parameters
- N extends string
- R extends boolean
Parameters
- this: P extends "required" ? CMD<P, A> : R extends false ? CMD<P, A> : never
- name: N
 the name of this argument.
- Optionalrequire: R = ...
 is it required or not, required arguments listed first.
Returns CMD<
 R extends true ? "required" : "optional",
 A & (
 R extends true ? { [P in string]: string } : { [P in string]?: string }
 ),
>
this

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

getAlias

getAlias(): string[]
get this command name alias.

Returns string[]
the name of this command.
- Defined in cc.ts:312

getCmd

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

Returns CustomCommand
- Defined in cc.ts:264

getDescription

getDescription(): string
get this command description.

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

getFunction

getFunction(): cmdFuncOut<A>
get this command function.

Returns cmdFuncOut<A>
function.
- Defined in cc.ts:746

getName

getName(): string
get this command name.

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

getOptionalParams

getOptionalParams(): readonly CustomCommandParameter[]
get this custom command optional arguments

Returns readonly CustomCommandParameter[]
array of optional arguments
- Defined in cc.ts:715

getPermision

getPermision(): string
get this command permission level.

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

getRequireParams

getRequireParams(): readonly CustomCommandParameter[]
get this custom command required arguments

Returns readonly CustomCommandParameter[]
array of required arguments
- Defined in cc.ts:696

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:814

requireCheat

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

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:757

setAlias

setAlias(a: string[]): CMD<P, A>
set this command name alias.
Parameters
- a: string[]
 name array.
Returns CMD<P, A>
this.
- Defined in cc.ts:293

setDescription

setDescription(a: string): CMD<P, A>
set this command description.
Parameters
- a: string
 description.
Returns CMD<P, A>
this.
- Defined in cc.ts:322

setFunction

setFunction(func: cmdFuncOut<A>): CMD<P, A>
set this command function to run when called/executed.
Parameters
- func: cmdFuncOut<A>
 function.
Returns CMD<P, A>
this.
- Defined in cc.ts:737

setName

setName(a: string): CMD<P, A>
set this command name.
Parameters
- a: string
 name.
Returns CMD<P, A>
this.
- Defined in cc.ts:274

setOptionalParams

setOptionalParams(obj: CustomCommandParameter[]): CMD<P, A>
set this custom command's optional arguments in batch
Parameters
- obj: CustomCommandParameter[]
 an array of cmdParam
Returns CMD<P, A>
this
- Defined in cc.ts:706

setPermision

setPermision(a: CommandPermissionLevel): CMD<P, A>
set this command permission level.
Parameters
- a: CommandPermissionLevel
 permissionLevel.
Returns CMD<P, A>
this.
- Defined in cc.ts:341

setRequireParams

setRequireParams(obj: CustomCommandParameter[]): CMD<P, A>
set this custom command's required arguments in batch
Parameters
- obj: CustomCommandParameter[]
 an array of cmdParam
Returns CMD<P, A>
this
- Defined in cc.ts:687

setTagRank

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

`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:231

Class CMD<P, A>

Example

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CMD<P, A>

Methods

addAlias

Parameters

Returns CMD<P, A>

addBlockType

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: string } : { [P in string]?: string } ),>

Throws

addBoolean

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: boolean } : { [P in string]?: boolean } ),>

Throws

addEntitySelector

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: Entity } : { [P in string]?: Entity } ),>

Throws

addEnum

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: string } : { [P in string]?: string } ),>

Throws

addFloat

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: number } : { [P in string]?: number } ),>

Throws

addInteger

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: number } : { [P in string]?: number } ),>

Throws

addItemType

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: string } : { [P in string]?: string } ),>

Throws

addLocation

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: Vector3 } : { [P in string]?: Vector3 } ),>

Throws

addPlayerSelector

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: Player } : { [P in string]?: Player } ),>

Throws

addString

Type Parameters

Parameters

Returns CMD< R extends true ? "required" : "optional", A & ( R extends true ? { [P in string]: string } : { [P in string]?: string } ),>

Throws

getAlias

Returns string[]

getCmd

Returns CustomCommand

getDescription

Returns string

getFunction

Returns cmdFuncOut<A>

getName

Returns string

getOptionalParams

Returns readonly CustomCommandParameter[]

getPermision

Returns string

getRequireParams

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: string } : { [P in string]?: string }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true
? { [P in string]: boolean }
: { [P in string]?: boolean }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: Entity } : { [P in string]?: Entity }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: string } : { [P in string]?: string }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: number } : { [P in string]?: number }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: number } : { [P in string]?: number }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: string } : { [P in string]?: string }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true
? { [P in string]: Vector3 }
: { [P in string]?: Vector3 }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: Player } : { [P in string]?: Player }
),
>

Returns CMD<
R extends true ? "required" : "optional",
A & (
R extends true ? { [P in string]: string } : { [P in string]?: string }
),
>

`Static`create