Package cn.nukkit.command
Class Command
java.lang.Object
cn.nukkit.command.Command
- All Implemented Interfaces:
GenericParameter
- Direct Known Subclasses:
EffectCommand
,FormattedCommandAlias
,PluginCommand
,PluginsCommand
,SimpleCommand
,TestCommand
,TpsCommand
,VanillaCommand
,VersionCommand
,XpCommand
- Author:
- MagicDroidX (Nukkit Project)
-
Nested Class Summary
Nested classes/interfaces inherited from interface cn.nukkit.command.data.GenericParameter
GenericParameter.CommandParameterSupplier<T>
-
Field Summary
Modifier and TypeFieldDescriptionprotected CommandData
protected Map<String,
CommandParameter[]> protected String
protected ParamTree
protected String
Fields inherited from interface cn.nukkit.command.data.GenericParameter
CHAINED_COMMAND, ITEM_NAME, OBJECTIVES, ORIGIN, TARGET_OBJECTIVES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommandParameters
(String key, CommandParameter[] parameters) boolean
allowChangesFrom
(CommandMap commandMap) static void
broadcastCommandMessage
(CommandSender source, TextContainer message) static void
broadcastCommandMessage
(CommandSender source, TextContainer message, boolean sendToSource) static void
broadcastCommandMessage
(CommandSender source, String message) static void
broadcastCommandMessage
(CommandSender source, String message, boolean sendToSource) void
若调用此方法,则将启用ParamTree用于解析命令参数boolean
execute
(CommandSender sender, String commandLabel, String[] args) int
execute
(CommandSender sender, String commandLabel, Map.Entry<String, ParamList> result, CommandLogger log) Execute int.generateCustomCommandData
(Player player) Generates modified command data for the specified player for AvailableCommandsPacket.static CommandData
Deprecated.String[]
Returns an CommandData containing command datagetLabel()
getName()
getUsage()
boolean
boolean
protected double
parseTilde
(String arg, double pos) boolean
register
(CommandMap commandMap) void
setAliases
(String[] aliases) void
setCommandParameters
(Map<String, CommandParameter[]> commandParameters) void
setDescription
(String description) boolean
void
setPermission
(String permission) void
setPermissionMessage
(String permissionMessage) void
boolean
testPermission
(CommandSender target) boolean
testPermissionSilent
(CommandSender target) toString()
boolean
unregister
(CommandMap commandMap)
-
Field Details
-
timing
-
description
-
usageMessage
-
commandParameters
-
paramTree
-
commandData
-
-
Constructor Details
-
Command
-
Command
-
Command
-
Command
-
-
Method Details
-
getDefaultCommandData
Returns an CommandData containing command data- Returns:
- CommandData
-
getCommandParameters
-
getCommandParameters
-
setCommandParameters
-
addCommandParameters
-
generateCustomCommandData
Generates modified command data for the specified player for AvailableCommandsPacket.- Parameters:
player
- player- Returns:
- CommandData|null
-
getOverloads
-
parseTilde
-
execute
-
execute
@PowerNukkitXOnly @Since("1.19.60-r1") public int execute(CommandSender sender, String commandLabel, Map.Entry<String, ParamList> result, CommandLogger log) Execute int.- Parameters:
sender
- 命令发送者commandLabel
- the command labelresult
- 解析的命令结果log
- 命令输出工具- Returns:
- int 返回0代表执行失败, 返回大于等于1代表执行成功
-
getName
-
getPermission
-
setPermission
-
testPermission
-
testPermissionSilent
-
getLabel
-
setLabel
-
register
-
unregister
-
allowChangesFrom
-
isRegistered
public boolean isRegistered() -
getAliases
-
getPermissionMessage
-
getDescription
-
getUsage
-
getCommandFormatTips
-
setAliases
-
setDescription
-
setPermissionMessage
-
setUsage
-
hasParamTree
-
enableParamTree
若调用此方法,则将启用ParamTree用于解析命令参数 -
getParamTree
-
generateDefaultData
@Deprecated @DeprecationDetails(by="PowerNukkit", since="1.5.2.0-PN", reason="Unused and always throws an exception even in Cloudburst Nukkit") @PowerNukkitDifference(since="1.5.2.0-PN", info="Throws UnsupportedOperationException instead of NullPointerException") public static CommandData generateDefaultData()Deprecated. -
broadcastCommandMessage
-
broadcastCommandMessage
public static void broadcastCommandMessage(CommandSender source, String message, boolean sendToSource) -
broadcastCommandMessage
-
broadcastCommandMessage
public static void broadcastCommandMessage(CommandSender source, TextContainer message, boolean sendToSource) -
toString
-