com.projectkorra.projectkorra.command

Interface SubCommand

All Known Implementing Classes:

AddCommand, BindCommand, CheckCommand, ChooseCommand, ClearCommand, CopyCommand, DebugCommand, DisplayCommand, HelpCommand, ImportCommand, InvincibleCommand, PermaremoveCommand, PKCommand, PresetCommand, ReloadCommand, RemoveCommand, ToggleCommand, VersionCommand, WhoCommand

public interface SubCommand

Interface representation of a command executor.

Method Summary

Modifier and Type	Method and Description
void	execute(org.bukkit.command.CommandSender sender, java.util.List<java.lang.String> args) Executes the command.
java.lang.String[]	getAliases() Gets the aliases for the command.
java.lang.String	getDescription() Gets the description of the command.
java.lang.String	getName() Gets the name of the command.
java.lang.String	getProperUse() Gets the proper use of the command, in the format '/b name arg1 arg2 ...
void	help(org.bukkit.command.CommandSender sender, boolean description) Outputs the correct usage, and optionally the description, of a command to the given CommandSender.

Method Detail

getName

java.lang.String getName()

Gets the name of the command.

Returns:

The command's name

getAliases

java.lang.String[] getAliases()

Gets the aliases for the command.

Returns:

All aliases for the command

getProperUse

java.lang.String getProperUse()

Gets the proper use of the command, in the format '/b name arg1 arg2 ... '

Returns:

the proper use of the command

getDescription

java.lang.String getDescription()

Gets the description of the command.

Returns:

the description

help

void help(org.bukkit.command.CommandSender sender,
          boolean description)

Outputs the correct usage, and optionally the description, of a command to the given CommandSender.

Parameters:

sender - The CommandSender to output the help to

description - Whether or not to output the description of the command

execute

void execute(org.bukkit.command.CommandSender sender,
             java.util.List<java.lang.String> args)

Executes the command.

Parameters:

sender - The CommandSender who issued the command

args - the command's arguments