com.bgsoftware.superiorskyblock.api.commands

Interface SuperiorCommand

public interface SuperiorCommand

Method Summary

Modifier and Type	Method and Description
boolean	canBeExecutedByConsole() Can the command be executed from console? If true, sender cannot be casted directly into a player.
boolean	displayCommand() Should the command be displayed in /is help (or /is admin for admin commands)?
void	execute(SuperiorSkyblock plugin, org.bukkit.command.CommandSender sender, java.lang.String[] args) The method to be executed when the command is running.
java.util.List<java.lang.String>	getAliases() Get the aliases of the sub command.
java.lang.String	getDescription(java.util.Locale locale) Get the description of the sub command.
int	getMaxArgs() Get the maximum arguments required for the command.
int	getMinArgs() Get the minimum arguments required for the command.
java.lang.String	getPermission() Get the required permission to use the sub command.
java.lang.String	getUsage(java.util.Locale locale) Get the usage of the sub command.
java.util.List<java.lang.String>	tabComplete(SuperiorSkyblock plugin, org.bukkit.command.CommandSender sender, java.lang.String[] args) Get the tab-complete arguments of the command.

Method Detail

getAliases

java.util.List<java.lang.String> getAliases()

Get the aliases of the sub command.

getPermission

java.lang.String getPermission()

Get the required permission to use the sub command. If no permission is required, can be empty.

getUsage

java.lang.String getUsage(java.util.Locale locale)

Get the usage of the sub command.

Parameters:

locale - The locale of the player.

getDescription

java.lang.String getDescription(java.util.Locale locale)

Get the description of the sub command.

Parameters:

locale - The locale of the player.

getMinArgs

int getMinArgs()

Get the minimum arguments required for the command. For example, the command /is example PLAYER_NAME has 2 arguments.

getMaxArgs

int getMaxArgs()

Get the maximum arguments required for the command. For example, the command /is example PLAYER_NAME has 2 arguments.

canBeExecutedByConsole

boolean canBeExecutedByConsole()

Can the command be executed from console? If true, sender cannot be casted directly into a player. Otherwise, it can be.

displayCommand

boolean displayCommand()

Should the command be displayed in /is help (or /is admin for admin commands)?

execute

void execute(SuperiorSkyblock plugin,
             org.bukkit.command.CommandSender sender,
             java.lang.String[] args)

The method to be executed when the command is running.

Parameters:

plugin - The instance of the plugin.

sender - The sender who ran the command.

args - The arguments of the command.

tabComplete

java.util.List<java.lang.String> tabComplete(SuperiorSkyblock plugin,
                                             org.bukkit.command.CommandSender sender,
                                             java.lang.String[] args)

Get the tab-complete arguments of the command.

Parameters:

plugin - The instance of the plugin.

sender - The sender who ran the command.

args - The arguments of the command.