Package net.gcnt.additionsplus.api

Class BaseCmd

java.lang.Object
net.gcnt.additionsplus.api.BaseCmd
public abstract class BaseCmd extends Object
Base command class that holds all information about a (sub) command and its usage.

  • Field Details

    • plugin

      public AdditionsPlugin plugin

    • sender

      public org.bukkit.command.CommandSender sender

    • args

      public String[] args

    • command

      public String command

    • mainCommand

      public String mainCommand

    • forcePlayer

      public boolean forcePlayer

    • permission

      public String permission

    • subUsage

      public String subUsage

    • usage

      public String usage

    • player

      public org.bukkit.entity.Player player

  • Constructor Details

  • Method Details

    • processCommand

      public boolean processCommand(org.bukkit.command.CommandSender sender, String[] args)
      Processes the command, used in listeners. Checks for required permission.
      Parameters:
      sender - The sender of the command.
      args - The arguments the sender provided.
      Returns:
      True when completed, false on failure.

    • run

      public abstract boolean run()
      The method that is called when this command is being executed.
      Returns:
      True when completed, false on failure.

    • sendUsage

      public String sendUsage(boolean send)
      Send the usage of this command to the sender.
      Parameters:
      send - Whether to send the message or only return its value.
      Returns:
      The formatted usage string.