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
public abstract class Command extends Object implements GenericParameter
Author:
MagicDroidX (Nukkit Project)

  • Field Details

  • Constructor Details

  • Method Details

    • getDefaultCommandData

      public CommandData getDefaultCommandData()
      Returns an CommandData containing command data
      Returns:
      CommandData

    • getCommandParameters

      public CommandParameter[] getCommandParameters(String key)

    • getCommandParameters

      public Map<String,CommandParameter[]> getCommandParameters()

    • setCommandParameters

      public void setCommandParameters(Map<String,CommandParameter[]> commandParameters)

    • addCommandParameters

      public void addCommandParameters(String key, CommandParameter[] parameters)

    • generateCustomCommandData

      public CommandDataVersions generateCustomCommandData(Player player)
      Generates modified command data for the specified player for AvailableCommandsPacket.
      Parameters:
      player - player
      Returns:
      CommandData|null

    • getOverloads

      public Map<String,CommandOverload> getOverloads()

    • parseTilde

      @PowerNukkitOnly protected double parseTilde(String arg, double pos)

    • execute

      public boolean execute(CommandSender sender, String commandLabel, String[] args)

    • 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 label
      result - 解析的命令结果
      log - 命令输出工具
      Returns:
      int 返回0代表执行失败, 返回大于等于1代表执行成功

    • getName

      public String getName()

    • getPermission

      public String getPermission()

    • setPermission

      public void setPermission(String permission)

    • testPermission

      public boolean testPermission(CommandSender target)

    • testPermissionSilent

      public boolean testPermissionSilent(CommandSender target)

    • getLabel

      public String getLabel()

    • setLabel

      public boolean setLabel(String name)

    • register

      public boolean register(CommandMap commandMap)

    • unregister

      public boolean unregister(CommandMap commandMap)

    • allowChangesFrom

      public boolean allowChangesFrom(CommandMap commandMap)

    • isRegistered

      public boolean isRegistered()

    • getAliases

      public String[] getAliases()

    • getPermissionMessage

      public String getPermissionMessage()

    • getDescription

      public String getDescription()

    • getUsage

      public String getUsage()

    • isServerSideOnly

      @PowerNukkitXOnly @Since("1.20.0-r2") public boolean isServerSideOnly()

    • getCommandFormatTips

      @PowerNukkitXOnly @Since("1.6.0.0-PNX") public String getCommandFormatTips()

    • setAliases

      public void setAliases(String[] aliases)

    • setDescription

      public void setDescription(String description)

    • setPermissionMessage

      public void setPermissionMessage(String permissionMessage)

    • setUsage

      public void setUsage(String usageMessage)

    • hasParamTree

      @PowerNukkitXOnly @Since("1.19.60-r1") public boolean hasParamTree()

    • enableParamTree

      @PowerNukkitXOnly @Since("1.19.60-r1") public void enableParamTree()
      若调用此方法，则将启用ParamTree用于解析命令参数

    • getParamTree

      @PowerNukkitXOnly @Since("1.19.60-r1") public 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

      public static void broadcastCommandMessage(CommandSender source, String message)

    • broadcastCommandMessage

      public static void broadcastCommandMessage(CommandSender source, String message, boolean sendToSource)

    • broadcastCommandMessage

      public static void broadcastCommandMessage(CommandSender source, TextContainer message)

    • broadcastCommandMessage

      public static void broadcastCommandMessage(CommandSender source, TextContainer message, boolean sendToSource)

    • toString

      public String toString()
      Overrides:
      toString in class Object