API Reference / api/command/Command / Command

Class: Command

Defined in: api/command/Command.d.ts:7

命令接口

Methods

execute()

execute(sender, args): boolean

Defined in: api/command/Command.d.ts:17

执行命令并返回其成功状态。

Parameters

sender

CommandSender

指令的来源

args

string[]

命令传递给该指令的参数

Returns

boolean

如果执行成功则返回true，否则返回false

---

getAliases()

getAliases(): string[]

Defined in: api/command/Command.d.ts:53

返回此命令的别名列表

Returns

string[]

别名列表

---

getDescription()

getDescription(): string

Defined in: api/command/Command.d.ts:39

获取此命令的简要描述

Returns

string

该命令的简要描述

---

getName()

getName(): string

Defined in: api/command/Command.d.ts:24

获取此命令的名称

Returns

string

此命令的名称

---

getPermissions()

getPermissions(): string[]

Defined in: api/command/Command.d.ts:81

获取用户执行此命令所需的权限名称列表。

Returns

string[]

用户执行此命令所需权限名称列表，如果没有权限则返回空列表

---

getUsages()

getUsages(): string[]

Defined in: api/command/Command.d.ts:67

获取此命令的用法列表

Returns

string[]

用法列表

---

isRegistered()

isRegistered(): boolean

Defined in: api/command/Command.d.ts:127

返回当前注册此命令的状态。

Returns

boolean

如果此命令正在注册，则返回true，否则返回false

---

setAliases()

setAliases(...aliases): void

Defined in: api/command/Command.d.ts:60

将注册指令设置为此命令的别名列表。

Parameters

aliases

...string[]

要请求注册到该命令的别名列表

Returns

void

---

setDescription()

setDescription(description): void

Defined in: api/command/Command.d.ts:46

设置此命令的简要描述。

Parameters

description

string

新命令描述

Returns

void

---

setName()

setName(name): void

Defined in: api/command/Command.d.ts:32

设置此命令的名称。 可以在注册命令之前使用。

Parameters

name

string

新命令名称

Returns

void

---

setPermissions()

setPermissions(...permissions): void

Defined in: api/command/Command.d.ts:88

设置用户执行此命令所需的权限名称列表。

Parameters

permissions

...string[]

用户执行此命令所需权限名称列表

Returns

void

---

setUsages()

setUsages(...usages): void

Defined in: api/command/Command.d.ts:74

设置此命令的用法列表。

Parameters

usages

...string[]

用法列表

Returns

void

---

testPermission()

testPermission(target): boolean

Defined in: api/command/Command.d.ts:96

测试给定的CommandSender是否可以执行此命令。如果他们没有权限，则将被通知不能执行此操作

Parameters

target

CommandSender

要测试的用户

Returns

boolean

如果他们能够使用它，则返回true，否则返回false

---

testPermissionSilently()

testPermissionSilently(target): boolean

Defined in: api/command/Command.d.ts:104

测试给定的CommandSender是否可以执行此命令。不会发送错误信息到发送者。

Parameters

target

CommandSender

要测试的用户

Returns

boolean

如果他们能够使用它，则返回true，否则返回false

---

toString()

toString(): string

Defined in: api/command/Command.d.ts:8

Returns

string