Package net.gcnt.additionsplus.api.objects

Interface AdditionsCommand

public interface AdditionsCommand
Custom AdditionsPlus Command class. Execute or overrides bukkit commands with custom actions, aliases and more.

  • Method Details

    • getPlugin

      String getPlugin()
      Get the plugin of this command.
      Returns:
      Plugin of this command.

    • getCommandName

      String getCommandName()
      Get the command name.
      Returns:
      Command name.

    • getAliases

      List<String> getAliases()
      Get the List of command aliases.
      Returns:
      List of aliases.

    • setAliases

      void setAliases(List<String> aliases)
      Set the List of aliases of this command.
      Parameters:
      aliases - List of aliases.

    • getCooldown

      long getCooldown()
      Get the cooldown in ticks.
      Returns:
      Cooldown in ticks.

    • setCooldown

      void setCooldown(long cooldown)
      Set the cooldown in ticks.
      Parameters:
      cooldown - Cooldown in ticks.

    • getCooldownMessage

      String getCooldownMessage()
      Get the on-cooldown message of this command.
      Returns:
      Cooldown message.

    • setCooldownMessage

      void setCooldownMessage(String cooldownMessage)
      Set the on-cooldown message of this command.
      Parameters:
      cooldownMessage - Message to send.

    • getPermission

      String getPermission()
      Get the required Bukkit permission of this command.
      Returns:
      Required Bukkit permission.

    • setPermission

      void setPermission(@Nullable String permission)
      Set the permission of this command.
      Parameters:
      permission - Bukkit permission.

    • getNoPermissionMessage

      String getNoPermissionMessage()
      Get the message that is sent to the player when they do not have permission for this command.
      Returns:
      No permission message to send.

    • setNoPermissionMessage

      void setNoPermissionMessage(String message)
      Set the message that is sent to the player when they do not have permission for this command.
      Parameters:
      message - Message to send.

    • isRegister

      boolean isRegister()
      Get whether the command should be registered to Bukkit. If this is enabled, the message will pop up while tab completing. This is required if you want the command to be executable from other plugins.
      Returns:
      True if enabled, false otherwise.

    • setRegister

      void setRegister(boolean register)
      Set whether this command should be registered to Bukkit.
      Parameters:
      register - Whether the command should be registered.

    • getActions

      List<String> getActions()
      Get the actions of this command.
      Returns:
      List of actions.

    • setActions

      void setActions(List<String> actions)
      Set theactions of this command.
      Parameters:
      actions - List of actions.

    • getUsage

      String getUsage()
      Get the usage of this command.
      Returns:
      Usage of this command.

    • setUsage

      void setUsage(String usage)
      Set the usage of this command.
      Parameters:
      usage - New usage.

    • getDescription

      String getDescription()
      Get the description of this command.
      Returns:
      Description of this command.

    • setDescription

      void setDescription(String description)
      Set the description of the command.
      Parameters:
      description - Description of the command.