801132b89f
Updated docs to reflect what the code really does This adds a few new methods to Command including:- * A full constructor that takes descriptio, usageMassage and aliases for convenience * getLabel() which returns the active label for a command, which is derived from the Command name or subsiquent call to setLabel(..) * A number of registration functions for use in the CommandMap implementer Also of note is Command.getAliases() no returns the "active" aliases
65 lines
2.9 KiB
Java
65 lines
2.9 KiB
Java
package org.bukkit.command;
|
|
|
|
import java.util.List;
|
|
|
|
public interface CommandMap {
|
|
|
|
/**
|
|
* Registers all the commands belonging to a certain plugin.
|
|
* Caller can use:-
|
|
* command.getName() to determine the label registered for this command
|
|
* command.getAliases() to determine the aliases which where registered
|
|
*
|
|
* @param fallbackPrefix a prefix which is prepended to each command with a ':' one or more times to make the command unique
|
|
* @param commands a list of commands to register
|
|
*/
|
|
public void registerAll(String fallbackPrefix, List<Command> commands);
|
|
|
|
/**
|
|
* Registers a command. Returns true on success; false if name is already taken and fallback had to be used.
|
|
* Caller can use:-
|
|
* command.getName() to determine the label registered for this command
|
|
* command.getAliases() to determine the aliases which where registered
|
|
*
|
|
* @param label the label of the command, without the '/'-prefix.
|
|
* @param fallbackPrefix a prefix which is prepended to the command with a ':' one or more times to make the command unique
|
|
* @param command the command to register
|
|
* @return true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times
|
|
*/
|
|
public boolean register(String label, String fallbackPrefix, Command command);
|
|
|
|
/**
|
|
* Registers a command. Returns true on success; false if name is already taken and fallback had to be used.
|
|
* Caller can use:-
|
|
* command.getName() to determine the label registered for this command
|
|
* command.getAliases() to determine the aliases which where registered
|
|
*
|
|
* @param fallbackPrefix a prefix which is prepended to the command with a ':' one or more times to make the command unique
|
|
* @param command the command to register, from which label is determined from the command name
|
|
* @return true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times
|
|
*/
|
|
public boolean register(String fallbackPrefix, Command command);
|
|
|
|
/**
|
|
* Looks for the requested command and executes it if found.
|
|
*
|
|
* @param cmdLine command + arguments. Example: "/test abc 123"
|
|
* @return targetFound returns false if no target is found.
|
|
* @throws CommandException Thrown when the executor for the given command fails with an unhandled exception
|
|
*/
|
|
public boolean dispatch(CommandSender sender, String cmdLine) throws CommandException;
|
|
|
|
/**
|
|
* Clears all registered commands.
|
|
*/
|
|
public void clearCommands();
|
|
|
|
/**
|
|
* Gets the command registered to the specified name
|
|
*
|
|
* @param name Name of the command to retrieve
|
|
* @return Command with the specified name or null if a command with that label doesn't exist
|
|
*/
|
|
public Command getCommand(String name);
|
|
}
|