Index
All Classes and Interfaces|All Packages|Serialized Form
A
- activePlatform() - Method in class dev.jorel.commandapi.CommandAPISpigot
- append(Object) - Method in class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Appends an object to the end of this message
- append(String) - Method in class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Appends a string to the end of this message
- appendArgInput() - Method in class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Appends the argument input that the CommandSender used in this command.
For example, if/foo barwas executed and an error occurs with the CustomArgumentbar, then the arg input will appendbarto the end of the message.
This input is determined at runtime, and is stored as%input%until executed - appendFullInput() - Method in class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Appends the whole input that the CommandSender used in this command.
For example, if/foo barwas executed, thenfoo barwill be appended to the end of the message.
This input is determined at runtime, and is stored as%finput%until executed - appendHere() - Method in class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Appends
<--[HERE]to the end of the message - apply(CustomArgument.CustomArgumentInfo<B>) - Method in interface dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfoParser
-
Applies a CustomArgumentInfo input to this custom argument parser
- AsyncPlayerProfileArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a list of the Bukkit PlayerProfile object with asynchronous support.
- AsyncPlayerProfileArgument(String) - Constructor for class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
-
A PlayerProfile argument.
B
- bukkitNMS() - Method in interface dev.jorel.commandapi.nms.SpigotNMS
C
- ChatArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents chat with entity selectors
- ChatArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ChatArgument
-
Constructs a Chat argument with a given node name.
- ChatColorArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit ChatColor object
- ChatColorArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ChatColorArgument
-
Constructs a ChatColor argument with a given node name.
- ChatComponentArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents raw JSON text
- ChatComponentArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ChatComponentArgument
-
Constructs a ChatComponent argument with a given node name.
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.ChatArgument
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.CustomArgument
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- CommandAPISpigot<Source> - Class in dev.jorel.commandapi
- CommandAPISpigot(InternalSpigotConfig) - Constructor for class dev.jorel.commandapi.CommandAPISpigot
- CommandAPISpigotConfig - Class in dev.jorel.commandapi
- CommandAPISpigotConfig(JavaPlugin) - Constructor for class dev.jorel.commandapi.CommandAPISpigotConfig
- ComplexRecipeImpl - Record Class in dev.jorel.commandapi.wrappers
-
Creates a ComplexRecipe based on a NamespacedKey and a Recipe object.
- ComplexRecipeImpl(NamespacedKey, Recipe) - Constructor for record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Creates an instance of a
ComplexRecipeImplrecord class. - currentInput() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
currentInputrecord component. - CustomArgument<T,
B> - Class in dev.jorel.commandapi.arguments -
An argument that represents any custom object
- CustomArgument(Argument<B>, CustomArgument.CustomArgumentInfoParser<T, B>) - Constructor for class dev.jorel.commandapi.arguments.CustomArgument
-
Creates a CustomArgument with a valid parser, with an underlying base argument as its parsing implementation.
- CustomArgument.CustomArgumentException - Exception Class in dev.jorel.commandapi.arguments
-
An exception used to create command-related errors for the CustomArgument
- CustomArgument.CustomArgumentInfo<B> - Record Class in dev.jorel.commandapi.arguments
-
A record which contains information which can be passed to the custom argument's parser.
- CustomArgument.CustomArgumentInfoParser<T,
B> - Interface in dev.jorel.commandapi.arguments -
A FunctionalInterface that takes in a
CustomArgument.CustomArgumentInfo, returns T and can throw aCustomArgument.CustomArgumentException - CustomArgument.MessageBuilder - Class in dev.jorel.commandapi.arguments
-
MessageBuilder is used to create error messages for invalid argument inputs
- CustomArgumentInfo(CommandSender, CommandArguments, String, B) - Constructor for record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Creates an instance of a
CustomArgumentInforecord class.
D
- dev.jorel.commandapi - package dev.jorel.commandapi
- dev.jorel.commandapi.arguments - package dev.jorel.commandapi.arguments
- dev.jorel.commandapi.nms - package dev.jorel.commandapi.nms
- dev.jorel.commandapi.wrappers - package dev.jorel.commandapi.wrappers
E
- equals(Object) - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Indicates whether some other object is "equal to" this one.
- executor - Variable in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- executor - Variable in class dev.jorel.commandapi.arguments.ChatArgument
- executor - Variable in class dev.jorel.commandapi.arguments.ChatColorArgument
- executor - Variable in class dev.jorel.commandapi.arguments.ChatComponentArgument
- executor - Variable in class dev.jorel.commandapi.arguments.CustomArgument
- executor - Variable in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- executor - Variable in class dev.jorel.commandapi.arguments.RecipeArgument
F
- failWithBaseComponents(BaseComponent...) - Static method in class dev.jorel.commandapi.CommandAPISpigot
-
Forces a command to return a success value of 0
- fromBaseComponents(BaseComponent[]) - Static method in exception class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Constructs a CustomArgumentException with a given error message
- fromMessageBuilder(CustomArgument.MessageBuilder) - Static method in exception class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Constructs a CustomArgumentException with a given error message
- fromString(String) - Static method in exception class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Constructs a CustomArgumentException with a given error message
G
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ChatArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.CustomArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- getChat(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.SpigotNMS
- getChatColor(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.SpigotNMS
- getChatComponent(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.SpigotNMS
- getCommandMap() - Method in class dev.jorel.commandapi.CommandAPISpigot
- getConfiguration() - Static method in class dev.jorel.commandapi.CommandAPISpigot
- getExecutor() - Method in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- getExecutor() - Method in class dev.jorel.commandapi.arguments.ChatArgument
- getExecutor() - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- getExecutor() - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- getExecutor() - Method in class dev.jorel.commandapi.arguments.CustomArgument
- getExecutor() - Method in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- getExecutor() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- getKey() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Return the namespaced identifier for this object.
- getPlugin() - Method in class dev.jorel.commandapi.InternalSpigotConfig
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ChatArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.CustomArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- getProfile(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.SpigotNMS
- getResult() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Get the result of this recipe.
- getSpigot() - Static method in class dev.jorel.commandapi.CommandAPISpigot
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
H
- hashCode() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns a hash code value for this object.
I
- input() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
inputrecord component. - instance() - Method in class dev.jorel.commandapi.CommandAPISpigotConfig
- InternalSpigotConfig - Class in dev.jorel.commandapi
- InternalSpigotConfig(CommandAPISpigotConfig) - Constructor for class dev.jorel.commandapi.InternalSpigotConfig
K
- key() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns the value of the
keyrecord component.
M
- MessageBuilder() - Constructor for class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Create a blank message
- MessageBuilder(String) - Constructor for class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Create a message with an input string
O
- onEnable() - Method in class dev.jorel.commandapi.CommandAPISpigot
-
Enables the CommandAPI.
P
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.ChatArgument
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.CustomArgument
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- parseArgument(CommandContext<CommandSourceStack>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- PlayerProfileArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Spigot PlayerProfile object.
- PlayerProfileArgument(String) - Constructor for class dev.jorel.commandapi.arguments.PlayerProfileArgument
-
A PlayerProfile argument.
- previousArgs() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
previousArgsrecord component.
R
- recipe() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns the value of the
reciperecord component. - RecipeArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Recipe object
- RecipeArgument(String) - Constructor for class dev.jorel.commandapi.arguments.RecipeArgument
-
A Recipe argument.
S
- sender() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
senderrecord component. - setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.AsyncPlayerProfileArgument
- setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.ChatArgument
- setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.CustomArgument
- setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.PlayerProfileArgument
- setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- skipReloadDatapacks(boolean) - Method in class dev.jorel.commandapi.CommandAPISpigotConfig
-
Sets whether the CommandAPI should skip its datapack reload step after the server has finished loading.
- SpigotNMS<CommandListenerWrapper> - Interface in dev.jorel.commandapi.nms
T
- toCommandSyntax(String, CommandContext<?>) - Method in exception class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Converts this CustomArgumentException into a CommandSyntaxException
- toString() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns a string representation of this record class.
- toString() - Method in class dev.jorel.commandapi.arguments.CustomArgument.MessageBuilder
-
Returns the String content of this MessageBuilder
- toString() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns a string representation of this record class.
W
- wrapCommandSender(CommandSender) - Method in class dev.jorel.commandapi.CommandAPISpigot
All Classes and Interfaces|All Packages|Serialized Form