CommandAPI 9.6.0
An API for the command UI introduced in Minecraft 1.13
|
This is a base class for AbstractCommandAPICommand
and AbstractCommandTree
command definitions.
More...
Public Member Functions | |
String | getName () |
Returns the name of this command. More... | |
Impl | withPermission (CommandPermission permission) |
Applies a permission to the current command builder. More... | |
Impl | withPermission (String permission) |
Applies a permission to the current command builder. More... | |
Impl | withoutPermission (CommandPermission permission) |
Applies a permission to the current command builder. More... | |
Impl | withoutPermission (String permission) |
Applies a permission to the current command builder. More... | |
Impl | withRequirement (Predicate< CommandSender > requirement) |
Adds a requirement that has to be satisfied to use this command. More... | |
Impl | withAliases (String... aliases) |
Adds an array of aliases to the current command builder. More... | |
CommandPermission | getPermission () |
Returns the permission associated with this command. More... | |
void | setPermission (CommandPermission permission) |
Sets the permission required to run this command. More... | |
String[] | getAliases () |
Returns an array of aliases that can be used to run this command. More... | |
void | setAliases (String[] aliases) |
Sets the aliases for this command. More... | |
Predicate< CommandSender > | getRequirements () |
Returns the requirements that must be satisfied to run this command. More... | |
void | setRequirements (Predicate< CommandSender > requirements) |
Sets the requirements that must be satisfied to run this command. More... | |
String | getShortDescription () |
Returns the short description for this command. More... | |
Impl | withShortDescription (String description) |
Sets the short description for this command. More... | |
String | getFullDescription () |
Returns the full description for this command. More... | |
Impl | withFullDescription (String description) |
Sets the full description for this command. More... | |
Impl | withUsage (String... usage) |
Sets the full usage for this command. More... | |
String[] | getUsage () |
Returns the usage for this command. More... | |
Impl | withHelp (String shortDescription, String fullDescription) |
Sets the short and full description for this command. More... | |
void | override () |
Overrides a command. More... | |
void | register () |
Registers this command with the default namespace. | |
abstract void | register (String namespace) |
Registers this command with a custom String namespace. More... | |
CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > | getExecutor () |
Returns the executors that this command has. More... | |
void | setExecutor (CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > executor) |
Sets the executors for this command. More... | |
Impl | clearExecutors () |
Clear all executors from the current command builder. More... | |
Impl | instance () |
Returns the instance of this class with the class Impl. More... | |
Protected Member Functions | |
ExecutableCommand (final CommandMetaData< CommandSender > meta) | |
Protected Attributes | |
final CommandMetaData< CommandSender > | meta |
The Command's meta-data for this executable command. | |
CommandAPIExecutor< CommandSender, AbstractCommandSender<? extends CommandSender > > | executor = new CommandAPIExecutor<>() |
The CommandAPIExecutor for this executable implementation. | |
This is a base class for AbstractCommandAPICommand
and AbstractCommandTree
command definitions.
<Impl> | The class extending this class, used as the return type for chain calls |
<CommandSender> | The CommandSender class used by the class extending this class |
|
inherited |
Clear all executors from the current command builder.
String[] dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getAliases | ( | ) |
Returns an array of aliases that can be used to run this command.
|
inherited |
Returns the executors that this command has.
String dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getFullDescription | ( | ) |
Returns the full description for this command.
String dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getName | ( | ) |
Returns the name of this command.
CommandPermission dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getPermission | ( | ) |
Returns the permission associated with this command.
Predicate< CommandSender > dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getRequirements | ( | ) |
Returns the requirements that must be satisfied to run this command.
String dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getShortDescription | ( | ) |
Returns the short description for this command.
String[] dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.getUsage | ( | ) |
Returns the usage for this command.
|
inherited |
Returns the instance of this class with the class Impl.
Used for chaining builder methods.
Implemented in dev.jorel.commandapi.arguments.Argument< T >.
void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.override | ( | ) |
Overrides a command.
Effectively the same as unregistering the command using CommandAPI.unregister() and then registering the command using .register()
|
abstract |
Registers this command with a custom String
namespace.
Reimplemented in dev.jorel.commandapi.AbstractCommandAPICommand< Impl, Argument, CommandSender >, and dev.jorel.commandapi.AbstractCommandTree< Impl, Argument, CommandSender >.
void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.setAliases | ( | String[] | aliases | ) |
Sets the aliases for this command.
aliases | the aliases for this command |
|
inherited |
Sets the executors for this command.
executor | the executors for this command |
void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.setPermission | ( | CommandPermission | permission | ) |
Sets the permission required to run this command.
permission | the permission required to run this command |
void dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.setRequirements | ( | Predicate< CommandSender > | requirements | ) |
Sets the requirements that must be satisfied to run this command.
requirements | the requirements that must be satisfied to run this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withAliases | ( | String... | aliases | ) |
Adds an array of aliases to the current command builder.
aliases | An array of aliases which can be used to execute this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withFullDescription | ( | String | description | ) |
Sets the full description for this command.
This is the help which is shown in the specific /help page for this command (e.g. /help mycommand).
description | the full description for this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withHelp | ( | String | shortDescription, |
String | fullDescription | ||
) |
Sets the short and full description for this command.
This is a short-hand for the ExecutableCommand#withShortDescription
and ExecutableCommand#withFullDescription
methods.
shortDescription | the short description for this command |
fullDescription | the full description for this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withoutPermission | ( | CommandPermission | permission | ) |
Applies a permission to the current command builder.
permission | The permission node required to execute this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withoutPermission | ( | String | permission | ) |
Applies a permission to the current command builder.
permission | The permission node required to execute this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withPermission | ( | CommandPermission | permission | ) |
Applies a permission to the current command builder.
permission | The permission node required to execute this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withPermission | ( | String | permission | ) |
Applies a permission to the current command builder.
permission | The permission node required to execute this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withRequirement | ( | Predicate< CommandSender > | requirement | ) |
Adds a requirement that has to be satisfied to use this command.
This method can be used multiple times and each use of this method will AND its requirement with the previously declared ones
requirement | the predicate that must be satisfied to use this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withShortDescription | ( | String | description | ) |
Sets the short description for this command.
This is the help which is shown in the main /help menu.
description | the short description for this command |
Impl dev.jorel.commandapi.ExecutableCommand< Impl, CommandSender >.withUsage | ( | String... | usage | ) |
Sets the full usage for this command.
This is the usage which is shown in the specific /help page for this command (e.g. /help mycommand).
usage | the full usage for this command |