|
| void | registerAll (String fallbackPrefix, List< Command > commands) |
| | Registers all the commands belonging to a certain plugin.
|
| |
| boolean | register (String label, String fallbackPrefix, Command command) |
| | Registers a command.
|
| |
| boolean | register (String fallbackPrefix, Command command) |
| | Registers a command.
|
| |
| boolean | dispatch (CommandSender sender, String cmdLine) throws CommandException |
| | Looks for the requested command and executes it if found.
|
| |
| void | clearCommands () |
| | Clears all registered commands.
|
| |
| Command | getCommand (String name) |
| | Gets the command registered to the specified name.
|
| |
| List< String > | tabComplete (CommandSender sender, String cmdLine) throws IllegalArgumentException |
| | Looks for the requested command and executes an appropriate tab-completer if found.
|
| |
Definition at line 5 of file CommandMap.java.
| void org.bukkit.command.CommandMap.clearCommands |
( |
| ) |
|
Clears all registered commands.
Looks for the requested command and executes it if found.
- Parameters
-
| sender | The command's sender |
| cmdLine | command + arguments. Example: "/test abc 123" |
- Returns
- returns false if no target is found, true otherwise.
- Exceptions
-
| CommandException | Thrown when the executor for the given command fails with an unhandled exception |
| Command org.bukkit.command.CommandMap.getCommand |
( |
String |
name | ) |
|
Gets the command registered to the specified name.
- Parameters
-
| name | Name of the command to retrieve |
- Returns
- Command with the specified name or null if a command with that label doesn't exist
| boolean org.bukkit.command.CommandMap.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
- Parameters
-
| label | the label of the command, without the '/'-prefix. |
| fallbackPrefix | a prefix which is prepended to the command with a ':' one or more times to make the command unique |
| command | the command to register |
- Returns
- true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times
| boolean org.bukkit.command.CommandMap.register |
( |
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
- Parameters
-
| fallbackPrefix | a prefix which is prepended to the command with a ':' one or more times to make the command unique |
| command | the command to register, from which label is determined from the command name |
- Returns
- true if command was registered with the passed in label, false otherwise, which indicates the fallbackPrefix was used one or more times
| void org.bukkit.command.CommandMap.registerAll |
( |
String |
fallbackPrefix, |
|
|
List< Command > |
commands |
|
) |
| |
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
- Parameters
-
| fallbackPrefix | a prefix which is prepended to each command with a ':' one or more times to make the command unique |
| commands | a list of commands to register |
| List<String> org.bukkit.command.CommandMap.tabComplete |
( |
CommandSender |
sender, |
|
|
String |
cmdLine |
|
) |
| throws IllegalArgumentException |
Looks for the requested command and executes an appropriate tab-completer if found.
This method will also tab-complete partial commands.
- Parameters
-
| sender | The command's sender. |
| cmdLine | The entire command string to tab-complete, excluding initial slash. |
- Returns
- a list of possible tab-completions. This list may be immutable. Will be null if no matching command of which sender has permission.
- Exceptions
-
| CommandException | Thrown when the tab-completer for the given command fails with an unhandled exception |
| IllegalArgumentException | if either sender or cmdLine are null |
The documentation for this interface was generated from the following file:
Inheritance diagram for org.bukkit.command.CommandMap:
1.8.2 
