Command (Spigot-API 1.16.5-R0.1-SNAPSHOT API 中文文档)

java.lang.Object
- org.bukkit.command.Command

直接已知子类:

BukkitCommand, FormattedCommandAlias, MultipleCommandAlias, PluginCommand
```
public abstract class Command
extends java.lang.Object
```
代表一个命令，在用户输入时执行各种任务.

字段概要

字段
限定符和类型字段和说明

protected java.lang.String description

CustomTimingsHandler timings

protected java.lang.String usageMessage

字段
限定符和类型	字段和说明
`protected java.lang.String`	`description`
`CustomTimingsHandler`	`timings`
`protected java.lang.String`	`usageMessage`

构造器概要

构造器
限定符	构造器和说明
`protected`	`Command(java.lang.String name)`
`protected`	`Command(java.lang.String name, java.lang.String description, java.lang.String usageMessage, java.util.List<java.lang.String> aliases)`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`static void`	`broadcastCommandMessage(CommandSender source, java.lang.String message)`
`static void`	`broadcastCommandMessage(CommandSender source, java.lang.String message, boolean sendToSource)`
`abstract boolean`	`execute(CommandSender sender, java.lang.String commandLabel, java.lang.String[] args)` 执行命令.
`java.util.List<java.lang.String>`	`getAliases()` 返回这个命令激活的别名列表.
`java.lang.String`	`getDescription()` 获取这个命令的简介.
`java.lang.String`	`getLabel()` 返回这个命令的别名.
`java.lang.String`	`getName()` 返回这个命令的名称.
`java.lang.String`	`getPermission()` 获取用户执行此命令所需的权限.
`java.lang.String`	`getPermissionMessage()` 返回当没有这个命令的权限时显示的消息.
`java.lang.String`	`getUsage()` 获取这个命令的用法示例.
`boolean`	`isRegistered()` 返回这个命令的注册状态.
`boolean`	`register(CommandMap commandMap)` 把这个命令注册给一个CommandMap.
`Command`	`setAliases(java.util.List<java.lang.String> aliases)` 设置这个命令的别名.
`Command`	`setDescription(java.lang.String description)` 设置此命令的简介.在`PluginDescriptionFile.getCommands()`的 `description` 节点上定义介绍与本方法是等效的.
`boolean`	`setLabel(java.lang.String name)` 设置这个命令的别名.
`boolean`	`setName(java.lang.String name)` 设置这个命令的名称.
`void`	`setPermission(java.lang.String permission)` 设置用户执行此命令所需的权限.
`Command`	`setPermissionMessage(java.lang.String permissionMessage)` 设置当没有这个命令的权限时发送的消息.
`Command`	`setUsage(java.lang.String usage)` 设置这个命令的用法示例.
`java.util.List<java.lang.String>`	`tabComplete(CommandSender sender, java.lang.String alias, java.lang.String[] args)` 对此命令进行tab补全并返回补全项列表.
`java.util.List<java.lang.String>`	`tabComplete(CommandSender sender, java.lang.String alias, java.lang.String[] args, Location location)` 对此命令进行tab补全并返回补全项列表.
`boolean`	`testPermission(CommandSender target)` 测试给定的`CommandSender`能否执行此命令.
`boolean`	`testPermissionSilent(CommandSender target)` 测试给定的`CommandSender`能否执行这个命令.
`java.lang.String`	`toString()`
`boolean`	`unregister(CommandMap commandMap)` 从给定的 CommandMap 中注销此命令, 并应用所有未完成的更改.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - description
```
protected java.lang.String description
```
  - usageMessage
```
protected java.lang.String usageMessage
```
  - timings
```
public CustomTimingsHandler timings
```
- 构造器详细资料
  - Command
```
protected Command(java.lang.String name)
```
  - Command
```
protected Command(java.lang.String name,
                  java.lang.String description,
                  java.lang.String usageMessage,
                  java.util.List<java.lang.String> aliases)
```
- 方法详细资料
  - execute
```
public abstract boolean execute(CommandSender sender,
                                java.lang.String commandLabel,
                                java.lang.String[] args)
```
    执行命令.
    原文：Executes the command, returning its success
    
    参数:
    
    sender - 执行此命令的对象
    
    commandLabel - 执行命令所用的别名
    
    args - 传递给此命令的所有参数，用' '分割
    
    返回:
    
    如果命令执行成功则为true，false反之
  - tabComplete
```
public java.util.List<java.lang.String> tabComplete(CommandSender sender,
                                                    java.lang.String alias,
                                                    java.lang.String[] args)
                                             throws java.lang.IllegalArgumentException
```
    对此命令进行tab补全并返回补全项列表.
    原文：Executed on tab completion for this command, returning a list of options the player can tab through.
    
    参数:
    
    sender - 执行此命令的对象
    
    alias - 执行命令所用的别名
    
    args - 传递给此命令的所有参数，用' '分割
    
    返回:
    
    指定参数的tab补全项列表.列表永远不会为null. 列表可能是不可变的.
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果sender, alias, args任意一参数为null
  - tabComplete
```
public java.util.List<java.lang.String> tabComplete(CommandSender sender,
                                                    java.lang.String alias,
                                                    java.lang.String[] args,
                                                    Location location)
                                             throws java.lang.IllegalArgumentException
```
    对此命令进行tab补全并返回补全项列表.
    原文：Executed on tab completion for this command, returning a list of options the player can tab through.
    
    参数:
    
    sender - 执行此命令的对象
    
    alias - 执行命令所用的别名
    
    args - 传递给此命令的所有参数，用' '分割
    
    location - 执行此命令对象所在的坐标，当无法获取命令执行者的坐标时该参数为null
    
    返回:
    
    指定参数的tab补全项列表.列表永远不会为null. 列表可能是不可变的.
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果参数sender, alias或args为null
  - getName
```
public java.lang.String getName()
```
    返回这个命令的名称.
    原文:Returns the name of this command
    
    返回:
    
    这个命令的名称
  - setName
```
public boolean setName(java.lang.String name)
```
    设置这个命令的名称.
    只能在注册之前使用本方法.
    如果成功设置新的名称将返回true，命令已被注册返回false.
    原文:Sets the name of this command.
    May only be used before registering the command. Will return true if the new name is set, and false if the command has already been registered.
    
    参数:
    
    name - 新的命令名称
    
    返回:
    
    如果新的名称被更改返回true，命令已被注册返回false
  - getPermission
```
public java.lang.String getPermission()
```
    获取用户执行此命令所需的权限.
    原文:Gets the permission required by users to be able to perform this command
    
    返回:
    
    权限名，未指定权限则为null
  - setPermission
```
public void setPermission(java.lang.String permission)
```
    设置用户执行此命令所需的权限.
    原文:Sets the permission required by users to be able to perform this command
    
    参数:
    
    permission - 权限名，无需任何权限则为null
  - testPermission
```
public boolean testPermission(CommandSender target)
```
    测试给定的CommandSender能否执行此命令.
    如果他们没有权限，将提示他们无权执行此命令.
    原文：Tests the given CommandSender to see if they can perform this command.
    If they do not have permission, they will be informed that they cannot do this.
    
    参数:
    
    target - 要测试的用户
    
    返回:
    
    如果他们有权限则为true，false反之
  - testPermissionSilent
```
public boolean testPermissionSilent(CommandSender target)
```
    测试给定的CommandSender能否执行这个命令.
    此方法不会给sender发送错误消息.
    原文:Tests the given CommandSender to see if they can perform this command.
    No error is sent to the sender.
    
    参数:
    
    target - 要测试的用户
    
    返回:
    
    他们能不能使用命令
  - getLabel
```
public java.lang.String getLabel()
```
    返回这个命令的别名.
    原文:Returns the label for this command
    
    返回:
    
    这个命令的别名
  - setLabel
```
public boolean setLabel(java.lang.String name)
```
    设置这个命令的别名.
    只能在注册之前使用本方法.
    如果成功设置新的别名将返回true，命令已被注册则返回false.
    原文：Sets the label of this command.
    May only be used before registering the command. Will return true if the new name is set, and false if the command has already been registered.
    
    参数:
    
    name - 新的命令别名
    
    返回:
    
    如果新的别名被更改返回true，命令已被注册则返回false
  - register
```
public boolean register(CommandMap commandMap)
```
    把这个命令注册给一个CommandMap.
    若此命令已经注册给某个 CommandMap, 则无法再注册给别的 CommandMap, 只能修改注册过的 CommandMap.
    原文：Registers this command to a CommandMap. Once called it only allows changes the registered CommandMap
    
    参数:
    
    commandMap - 注册此命令给这个CommandMap
    
    返回:
    
    如果注册成功则为true(当前注册的CommandMap是传递的CommandMap或null)，false反之
  - unregister
```
public boolean unregister(CommandMap commandMap)
```
    从给定的 CommandMap 中注销此命令, 并应用所有未完成的更改.
    原文：Unregisters this command from the passed CommandMap applying any outstanding changes
    
    参数:
    
    commandMap - 指定的CommandMap
    
    返回:
    
    如果成功注销则为true(当前注册的CommandMap是传递的CommandMap或null)，false反之
  - isRegistered
```
public boolean isRegistered()
```
    返回这个命令的注册状态.
    原文:Returns the current registered state of this command
    
    返回:
    
    这个命令当前是否已注册
  - getAliases
```
public java.util.List<java.lang.String> getAliases()
```
    返回这个命令激活的别名列表.
    原文:Returns a list of active aliases of this command
    
    返回:
    
    别名列表
  - getPermissionMessage
```
public java.lang.String getPermissionMessage()
```
    返回当没有这个命令的权限时显示的消息.
    原文:Returns a message to be displayed on a failed permission check for this command
    
    返回:
    
    无权提示消息
  - getDescription
```
public java.lang.String getDescription()
```
    获取这个命令的简介.
    原文:Gets a brief description of this command
    
    返回:
    
    命令简介
  - getUsage
```
public java.lang.String getUsage()
```
    获取这个命令的用法示例.
    原文:Gets an example usage of this command
    
    返回:
    
    一个或多个用法示例
  - setAliases
```
public Command setAliases(java.util.List<java.lang.String> aliases)
```
    设置这个命令的别名. 若没在PluginDescriptionFile.getCommands()的 aliases 节点定义(就是没在plugin.yml定义)将没有效果，与此等效.
    原文：Sets the list of aliases to request on registration for this command. This is not effective outside of defining aliases in the PluginDescriptionFile.getCommands() (under the `aliases' node) is equivalent to this method.
    
    参数:
    
    aliases - 要为这个命令注册的别名
    
    返回:
    
    这个命令对象，可用于链式调用
  - setDescription
```
public Command setDescription(java.lang.String description)
```
    设置此命令的简介.在PluginDescriptionFile.getCommands()的 description 节点上定义介绍与本方法是等效的.
    原文：Sets a brief description of this command. Defining a description in the PluginDescriptionFile.getCommands() (under the `description' node) is equivalent to this method.
    
    参数:
    
    description - 新的命令介绍
    
    返回:
    
    这个命令对象，可用于链式调用
  - setPermissionMessage
```
public Command setPermissionMessage(java.lang.String permissionMessage)
```
    设置当没有这个命令的权限时发送的消息.
    原文：Sets the message sent when a permission check fails
    
    参数:
    
    permissionMessage - 新的无权提示消息，null表示默认消息，空字符串表示没有提示消息
    
    返回:
    
    这个命令对象，可用于链式调用
  - setUsage
```
public Command setUsage(java.lang.String usage)
```
    设置这个命令的用法示例.
    原文:Sets the example usage of this command
    
    参数:
    
    usage - 新的用法示例
    
    返回:
    
    命令对象
  - broadcastCommandMessage
```
public static void broadcastCommandMessage(CommandSender source,
                                           java.lang.String message)
```
  - broadcastCommandMessage
```
public static void broadcastCommandMessage(CommandSender source,
                                           java.lang.String message,
                                           boolean sendToSource)
```
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 Command

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

description

usageMessage

timings

构造器详细资料

Command

Command

方法详细资料

execute

tabComplete

tabComplete

getName

setName

getPermission

setPermission

testPermission

testPermissionSilent

getLabel

setLabel

register

unregister

isRegistered

getAliases

getPermissionMessage

getDescription

getUsage

setAliases

setDescription

setPermissionMessage

setUsage

broadcastCommandMessage

broadcastCommandMessage

toString