SimpleCommandMap
public interface CommandMap
Modifier and Type | Method | Description |
---|---|---|
void |
clearCommands() |
Clears all registered commands.
|
boolean |
dispatch(@NotNull CommandSender sender,
@NotNull String cmdLine) |
Looks for the requested command and executes it if found.
|
@Nullable Command |
getCommand(@NotNull String name) |
Gets the command registered to the specified name
|
boolean |
register(@NotNull String label,
@NotNull String fallbackPrefix,
@NotNull Command command) |
Registers a command.
|
boolean |
register(@NotNull String fallbackPrefix,
@NotNull Command command) |
Registers a command.
|
void |
registerAll(@NotNull String fallbackPrefix,
@NotNull List<Command> commands) |
Registers all the commands belonging to a certain plugin.
|
@Nullable List<String> |
tabComplete(@NotNull CommandSender sender,
@NotNull String cmdLine) |
Looks for the requested command and executes an appropriate
tab-completer if found.
|
@Nullable List<String> |
tabComplete(@NotNull CommandSender sender,
@NotNull String cmdLine,
@Nullable Location location) |
Looks for the requested command and executes an appropriate
tab-completer if found.
|
void registerAll(@NotNull @NotNull String fallbackPrefix, @NotNull @NotNull List<Command> commands)
Caller can use:-
fallbackPrefix
- a prefix which is prepended to each command with
a ':' one or more times to make the command uniquecommands
- a list of commands to registerboolean register(@NotNull @NotNull String label, @NotNull @NotNull String fallbackPrefix, @NotNull @NotNull Command command)
Caller can use:-
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 uniquecommand
- the command to registerboolean register(@NotNull @NotNull String fallbackPrefix, @NotNull @NotNull Command command)
Caller can use:-
fallbackPrefix
- a prefix which is prepended to the command with a
':' one or more times to make the command uniquecommand
- the command to register, from which label is determined
from the command nameboolean dispatch(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String cmdLine) throws CommandException
sender
- The command's sendercmdLine
- command + arguments. Example: "/test abc 123"CommandException
- Thrown when the executor for the given command
fails with an unhandled exceptionvoid clearCommands()
@Nullable @Nullable Command getCommand(@NotNull @NotNull String name)
name
- Name of the command to retrieve@Nullable @Nullable List<String> tabComplete(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String cmdLine) throws IllegalArgumentException
sender
- The command's sender.cmdLine
- The entire command string to tab-complete, excluding
initial slash.CommandException
- Thrown when the tab-completer for the given
command fails with an unhandled exceptionIllegalArgumentException
- if either sender or cmdLine are null@Nullable @Nullable List<String> tabComplete(@NotNull @NotNull CommandSender sender, @NotNull @NotNull String cmdLine, @Nullable @Nullable Location location) throws IllegalArgumentException
sender
- The command's sender.cmdLine
- The entire command string to tab-complete, excluding
initial slash.location
- The position looked at by the sender, or null if noneCommandException
- Thrown when the tab-completer for the given
command fails with an unhandled exceptionIllegalArgumentException
- if either sender or cmdLine are nullCopyright © 2020. All rights reserved.