| Package | Description |
|---|---|
| org.bukkit.command |
Classes relating to handling specialized non-chat player input.
|
| org.bukkit.command.defaults |
Commands for emulating the Minecraft commands and other necessary ones for
use by a Bukkit implementation.
|
| org.bukkit.help |
Classes used to manipulate the default command and topic assistance system.
|
| org.bukkit.plugin.java |
Classes for handling
plugins written in
java. |
| Modifier and Type | Class | Description |
|---|---|---|
class |
FormattedCommandAlias |
|
class |
MultipleCommandAlias |
Represents a command that delegates to one or more other commands
|
class |
PluginCommand |
Represents a
Command belonging to a plugin |
| Modifier and Type | Field | Description |
|---|---|---|
protected Map<String,Command> |
SimpleCommandMap.knownCommands |
| Modifier and Type | Method | Description |
|---|---|---|
@Nullable Command |
CommandMap.getCommand(@NotNull String name) |
Gets the command registered to the specified name
|
@Nullable Command |
SimpleCommandMap.getCommand(@NotNull String name) |
|
@NotNull Command[] |
MultipleCommandAlias.getCommands() |
Gets the commands associated with the multi-command alias.
|
@NotNull Command |
Command.setAliases(@NotNull List<String> aliases) |
Sets the list of aliases to request on registration for this command.
|
@NotNull Command |
Command.setDescription(@NotNull String description) |
Sets a brief description of this command.
|
@NotNull Command |
Command.setPermissionMessage(@Nullable String permissionMessage) |
Sets the message sent when a permission check fails
|
@NotNull Command |
Command.setUsage(@NotNull String usage) |
Sets the example usage of this command
|
| Modifier and Type | Method | Description |
|---|---|---|
@NotNull Collection<Command> |
SimpleCommandMap.getCommands() |
|
static @NotNull List<Command> |
PluginCommandYamlParser.parse(@NotNull Plugin plugin) |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
CommandExecutor.onCommand(@NotNull CommandSender sender,
@NotNull Command command,
@NotNull String label,
@NotNull String[] args) |
Executes the given command, returning its success.
|
@Nullable List<String> |
TabCompleter.onTabComplete(@NotNull CommandSender sender,
@NotNull Command command,
@NotNull String alias,
@NotNull String[] args) |
Requests a list of possible completions for a command argument.
|
boolean |
CommandMap.register(@NotNull String label,
@NotNull String fallbackPrefix,
@NotNull Command command) |
Registers a command.
|
boolean |
CommandMap.register(@NotNull String fallbackPrefix,
@NotNull Command command) |
Registers a command.
|
boolean |
SimpleCommandMap.register(@NotNull String label,
@NotNull String fallbackPrefix,
@NotNull Command command) |
Registers a command.
|
boolean |
SimpleCommandMap.register(@NotNull String fallbackPrefix,
@NotNull Command command) |
Registers a command.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
CommandMap.registerAll(@NotNull String fallbackPrefix,
@NotNull List<Command> commands) |
Registers all the commands belonging to a certain plugin.
|
void |
SimpleCommandMap.registerAll(@NotNull String fallbackPrefix,
@NotNull List<Command> commands) |
Registers all the commands belonging to a certain plugin.
|
| Constructor | Description |
|---|---|
MultipleCommandAlias(@NotNull String name,
@NotNull Command[] commands) |
| Modifier and Type | Class | Description |
|---|---|---|
class |
BukkitCommand |
|
class |
HelpCommand |
|
class |
PluginsCommand |
|
class |
ReloadCommand |
|
class |
TimingsCommand |
|
class |
VersionCommand |
| Modifier and Type | Interface | Description |
|---|---|---|
interface |
HelpTopicFactory<TCommand extends Command> |
A HelpTopicFactory is used to create custom
HelpTopic objects from
commands that inherit from a common base class or have executors that
inherit from a common base class. |
| Modifier and Type | Field | Description |
|---|---|---|
protected Command |
GenericCommandHelpTopic.command |
| Constructor | Description |
|---|---|
GenericCommandHelpTopic(@NotNull Command command) |
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
JavaPlugin.onCommand(@NotNull CommandSender sender,
@NotNull Command command,
@NotNull String label,
@NotNull String[] args) |
Executes the given command, returning its success.
|
@Nullable List<String> |
JavaPlugin.onTabComplete(@NotNull CommandSender sender,
@NotNull Command command,
@NotNull String alias,
@NotNull String[] args) |
Requests a list of possible completions for a command argument.
|
Copyright © 2020. All rights reserved.