Package ch.njol.skript.command

Class ScriptCommand

java.lang.Object
ch.njol.skript.command.ScriptCommand
All Implemented Interfaces:
CommandExecutor, TabCompleter, TabExecutor
public class ScriptCommand extends Object implements TabExecutor
This class is used for user-defined commands.

  • Field Details

  • Constructor Details

    • ScriptCommand

      public ScriptCommand(Script script, String name, String pattern, List<Argument<?>> arguments, String description, @Nullable @Nullable String prefix, String usage, List<String> aliases, String permission, @Nullable @Nullable VariableString permissionMessage, @Nullable @Nullable Timespan cooldown, @Nullable @Nullable VariableString cooldownMessage, String cooldownBypass, @Nullable @Nullable VariableString cooldownStorage, int executableBy, SectionNode node)
      Creates a new ScriptCommand. Prefer using the CommandUsage class for the usage parameter.
      Parameters:
      name - /name
      pattern - the Skript pattern used to parse the input into arguments.
      arguments - the list of Arguments this command takes
      description - description to display in /help
      prefix - the prefix of the command
      usage - message to display if the command was used incorrectly
      aliases - /alias1, /alias2, ...
      permission - permission or null if none
      permissionMessage - message to display if the player doesn't have the given permission
      node - the node to parse and load into a Trigger

    • ScriptCommand

      public ScriptCommand(Script script, String name, String pattern, List<Argument<?>> arguments, String description, @Nullable @Nullable String prefix, CommandUsage usage, List<String> aliases, String permission, @Nullable @Nullable VariableString permissionMessage, @Nullable @Nullable Timespan cooldown, @Nullable @Nullable VariableString cooldownMessage, String cooldownBypass, @Nullable @Nullable VariableString cooldownStorage, int executableBy, SectionNode node)
      Creates a new ScriptCommand.
      Parameters:
      name - /name
      pattern - the Skript pattern used to parse the input into arguments.
      arguments - the list of Arguments this command takes
      description - description to display in /help
      prefix - the prefix of the command
      usage - message to display if the command was used incorrectly
      aliases - /alias1, /alias2, ...
      permission - permission or null if none
      permissionMessage - message to display if the player doesn't have the given permission
      node - the node to parse and load into a Trigger

  • Method Details

    • onCommand

      public boolean onCommand(@Nullable @Nullable CommandSender sender, @Nullable @Nullable Command command, @Nullable @Nullable String label, @Nullable @Nullable String[] args)
      Specified by:
      onCommand in interface CommandExecutor

    • execute

      public boolean execute(CommandSender sender, String commandLabel, String rest)

    • checkPermissions

      public boolean checkPermissions(CommandSender sender, String commandLabel, String arguments)

    • checkPermissions

      public boolean checkPermissions(CommandSender sender, Event event)

    • sendHelp

      public void sendHelp(CommandSender sender)

    • getArguments

      public List<Argument<?>> getArguments()
      Gets the arguments this command takes.
      Returns:
      The internal list of arguments. Do not modify it!

    • getPattern

      public String getPattern()

    • register

      public void register(SimpleCommandMap commandMap, Map<String,Command> knownCommands, @Nullable @Nullable Set<String> aliases)

    • unregister

      public void unregister(SimpleCommandMap commandMap, Map<String,Command> knownCommands, @Nullable @Nullable Set<String> aliases)

    • registerHelp

      public void registerHelp()

    • unregisterHelp

      public void unregisterHelp()

    • getName

      public String getName()

    • getPrefix

      public String getPrefix()

    • getLabel

      public String getLabel()

    • getCooldown

      @Nullable public @Nullable Timespan getCooldown()

    • getLastUsage

      @Nullable public @Nullable Date getLastUsage(UUID uuid, Event event)

    • setLastUsage

      public void setLastUsage(UUID uuid, Event event, @Nullable @Nullable Date date)

    • getRemainingMilliseconds

      public long getRemainingMilliseconds(UUID uuid, Event event)

    • setRemainingMilliseconds

      public void setRemainingMilliseconds(UUID uuid, Event event, long milliseconds)

    • getElapsedMilliseconds

      public long getElapsedMilliseconds(UUID uuid, Event event)

    • setElapsedMilliSeconds

      public void setElapsedMilliSeconds(UUID uuid, Event event, long milliseconds)

    • getCooldownBypass

      public String getCooldownBypass()

    • getAliases

      public List<String> getAliases()

    • getActiveAliases

      public List<String> getActiveAliases()

    • getBukkitCommand

      public PluginCommand getBukkitCommand()

    • getScript

      @Nullable public @Nullable Script getScript()

    • onTabComplete

      @Nullable public @Nullable List<String> onTabComplete(@Nullable @Nullable CommandSender sender, @Nullable @Nullable Command command, @Nullable @Nullable String alias, @Nullable @Nullable String[] args)
      Specified by:
      onTabComplete in interface TabCompleter