Index (commandapi-core 9.7.0 API)

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractArgument<T,Impl,Argument,CommandSender> - Class in dev.jorel.commandapi.arguments: The core abstract class for Command API arguments
AbstractArgument(String, ArgumentType<?>) - Constructor for class dev.jorel.commandapi.arguments.AbstractArgument: Constructs an argument with a given NMS/brigadier type.
AbstractArgumentTree<Impl,Argument,CommandSender> - Class in dev.jorel.commandapi: This is a base class for arguments, allowing them to behave as tree nodes in a AbstractCommandTree
AbstractArgumentTree() - Constructor for class dev.jorel.commandapi.AbstractArgumentTree: Instantiates an AbstractArgumentTree.
AbstractArgumentTree(Argument) - Constructor for class dev.jorel.commandapi.AbstractArgumentTree: Instantiates an AbstractArgumentTree with an underlying argument.
AbstractBlockCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractCommandAPICommand<Impl,Argument,CommandSender> - Class in dev.jorel.commandapi: A builder used to create commands to be registered by the CommandAPI.
AbstractCommandAPICommand(CommandMetaData<CommandSender>) - Constructor for class dev.jorel.commandapi.AbstractCommandAPICommand: Creates a new Command builder
AbstractCommandAPICommand(String) - Constructor for class dev.jorel.commandapi.AbstractCommandAPICommand: Creates a new command builder
AbstractCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders: An interface that represents an object sends commands on some platform
AbstractCommandTree<Impl,Argument,CommandSender> - Class in dev.jorel.commandapi: This is the root node for creating a command as a tree
AbstractCommandTree(String) - Constructor for class dev.jorel.commandapi.AbstractCommandTree: Creates a main root node for a command tree with a given command name
AbstractConsoleCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractEntity<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractFeedbackForwardingCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractNativeProxyCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractPlayer<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractProxiedCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders
AbstractRemoteConsoleCommandSender<Source> - Interface in dev.jorel.commandapi.commandsenders
ADD - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation: Addition of two values (+=)
addNormalExecutor(NormalExecutor<?, ?>) - Method in class dev.jorel.commandapi.CommandAPIExecutor
addResultingExecutor(ResultingExecutor<?, ?>) - Method in class dev.jorel.commandapi.CommandAPIExecutor
addSkipSenderProxy(String...) - Method in class dev.jorel.commandapi.CommandAPIConfig
addSkipSenderProxy(List<String>) - Method in class dev.jorel.commandapi.CommandAPIConfig
ADVANCEMENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The AdvancementArgument
ADVANCEMENTS - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders: A suggestion provider for the AdvancementArgument
ADVENTURE_CHAT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The ChatArgument (with Paper Adventure backend)
ADVENTURE_CHAT_COMPONENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The ChatComponentArgument (with Paper Adventure backend)
ADVENTURE_CHATCOLOR - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The ChatColorArgument (with Paper Adventure backend)
aliases() - Method in record class dev.jorel.commandapi.RegisteredCommand: Returns the value of the aliases record component.
ALL - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType: An executor where the CommandSender is any CommandSender
ANGLE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The AngleArgument
apply(float, float) - Method in enum class dev.jorel.commandapi.wrappers.MathOperation: Applies the current MathOperation to two floats
apply(int, int) - Method in enum class dev.jorel.commandapi.wrappers.MathOperation: Applies the current MathOperation to two ints
args() - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns the value of the args record component.
args() - Method in interface dev.jorel.commandapi.executors.ExecutionInfo
argsAsStr() - Method in record class dev.jorel.commandapi.RegisteredCommand: Returns the value of the argsAsStr record component.
argsMap() - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns the value of the argsMap record component.
arguments - Variable in class dev.jorel.commandapi.AbstractCommandAPICommand
arguments() - Method in record class dev.jorel.commandapi.RegisteredCommand: Returns the value of the arguments record component.
ArgumentSuggestions<CommandSender> - Interface in dev.jorel.commandapi.arguments: This class represents suggestions for an argument.
arrayOf(Tooltip<S>...) - Static method in class dev.jorel.commandapi.Tooltip: Constructs a Tooltip<S>[] from an array of Tooltip<S> via varargs.
ASSIGN - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation: Assignment of a value (=)
AXIS - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The AxisArgument

B

BadLiteralException - Exception Class in dev.jorel.commandapi.exceptions: An exception caused when a literal is null or empty
BadLiteralException(boolean) - Constructor for exception class dev.jorel.commandapi.exceptions.BadLiteralException: Creates a BadLiteralException
beLenientForMinorVersions(boolean) - Method in class dev.jorel.commandapi.CommandAPIConfig: Sets whether the CommandAPI should load a (potentially unsupported) NMS version when updating to a minor release of Minecraft.
bindToMethods(Consumer<String>, Consumer<String>, Consumer<String>, BiConsumer<String, Throwable>) - Static method in interface dev.jorel.commandapi.CommandAPILogger
BIOME - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The BiomeArgument
BIOMES - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders: A suggestion provider for the BiomeArgument
BLOCK - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType: An executor where the CommandSender is a BlockCommandSender
BLOCK_POSITION - Enum constant in enum class dev.jorel.commandapi.arguments.LocationType: Represents the integer coordinates of a block, for example: (10, 70, -19) or (5, 10)
BLOCK_PREDICATE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The BlockPredicateArgument
BLOCKSTATE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The BlockStateArgument
branch(SuggestionsBranch<CommandSender>...) - Method in class dev.jorel.commandapi.arguments.SuggestionsBranch: Adds further branches to this SuggestionsBranch.
Brigadier - Class in dev.jorel.commandapi: The Brigadier class is used to access some of the internals of the CommandAPI so you can use the CommandAPI alongside Mojang's com.mojang.brigadier package
build(Function<S, String>) - Static method in class dev.jorel.commandapi.Tooltip: Constructs a function that maps the current Tooltip<S> into a StringTooltip, using a standard mapping function which is defined for a given argument.

C

canRegister() - Static method in class dev.jorel.commandapi.CommandAPI: Determines whether command registration is permitted via the CommandAPI
ChainableBuilder<Impl> - Interface in dev.jorel.commandapi
CHAT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The ChatArgument (with BaseComponent backend)
CHAT_COMPONENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The ChatComponentArgument (with BaseComponent backend)
CHATCOLOR - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The ChatColorArgument
clearExecutors() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Clear all executors from the current command builder
clearExecutors() - Method in class dev.jorel.commandapi.AbstractArgumentTree: Clear all executors from the current command builder
clearExecutors() - Method in class dev.jorel.commandapi.AbstractCommandAPICommand: Clear all executors from the current command builder
clearExecutors() - Method in class dev.jorel.commandapi.AbstractCommandTree: Clear all executors from the current command builder
clearExecutors() - Method in class dev.jorel.commandapi.ExecutableCommand: Clear all executors from the current command builder
combineWith(Argument...) - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Adds combined arguments to this argument.
COMMAND - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The CommandArgument
CommandAPI - Class in dev.jorel.commandapi: Class to register commands with the 1.13 command UI
CommandAPIArgumentType - Enum Class in dev.jorel.commandapi.arguments: An enum that represents the different arguments declared in the Command API
CommandAPIConfig<Impl> - Class in dev.jorel.commandapi: A class to contain information about how to configure the CommandAPI during its loading step.
CommandAPIConfig() - Constructor for class dev.jorel.commandapi.CommandAPIConfig
CommandAPIExecutor<CommandSender,WrapperType> - Class in dev.jorel.commandapi: CommandAPIExecutor is the main executor implementation for command executors.
CommandAPIExecutor() - Constructor for class dev.jorel.commandapi.CommandAPIExecutor
CommandAPIHandler<Argument,CommandSender,Source> - Class in dev.jorel.commandapi: The "brains" behind the CommandAPI.
CommandAPIHandler(CommandAPIPlatform<Argument, CommandSender, Source>) - Constructor for class dev.jorel.commandapi.CommandAPIHandler
CommandAPILogger - Interface in dev.jorel.commandapi
CommandAPIPlatform<Argument,CommandSender,Source> - Interface in dev.jorel.commandapi
CommandAPIVersionHandler - Class in dev.jorel.commandapi: This file handles loading the correct platform implementation.
CommandAPIVersionHandler() - Constructor for class dev.jorel.commandapi.CommandAPIVersionHandler
CommandArguments - Record Class in dev.jorel.commandapi.executors: This class stores the arguments for this command
CommandArguments(Object[], Map<String, Object>, String[], Map<String, String>, String) - Constructor for record class dev.jorel.commandapi.executors.CommandArguments: Creates an instance of a CommandArguments record class.
commandName() - Method in record class dev.jorel.commandapi.RegisteredCommand: Returns the value of the commandName record component.
CommandPermission - Class in dev.jorel.commandapi: A representation of permission nodes for commands.
ConflictingPermissionsException - Exception Class in dev.jorel.commandapi.exceptions: An exception caused when the same permission is registered to a command
ConflictingPermissionsException(String, CommandPermission, CommandPermission) - Constructor for exception class dev.jorel.commandapi.exceptions.ConflictingPermissionsException: Creates a ConflictingPermissionsException
CONSOLE - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType: An executor where the CommandSender is a ConsoleCommandSender
context() - Method in record class dev.jorel.commandapi.LoadContext: Returns the value of the context record component.
copy() - Method in class dev.jorel.commandapi.AbstractCommandAPICommand
copyPermissionsAndRequirements(Argument) - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Copies permissions and requirements from the provided argument to this argument This also resets additional permissions and requirements.
count() - Method in record class dev.jorel.commandapi.executors.CommandArguments
createDispatcherFile(File, CommandDispatcher<Source>) - Method in interface dev.jorel.commandapi.CommandAPIPlatform: Creates a JSON file that describes the hierarchical structure of the commands that have been registered by the server.
currentArg() - Method in record class dev.jorel.commandapi.SuggestionInfo: Returns the value of the currentArg record component.
currentInput() - Method in record class dev.jorel.commandapi.SuggestionInfo: Returns the value of the currentInput record component.
CUSTOM - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The CustomArgument
CustomProvidedArgument - Interface in dev.jorel.commandapi.arguments: An interface allowing arguments to have built-in suggestion providers based on Minecraft namespaced keys

D

days(int) - Static method in class dev.jorel.commandapi.wrappers.Time: Create a Time object with a given number of days
dev.jorel.commandapi - package dev.jorel.commandapi
dev.jorel.commandapi.arguments - package dev.jorel.commandapi.arguments: Classes to be used as arguments for commands
dev.jorel.commandapi.commandsenders - package dev.jorel.commandapi.commandsenders
dev.jorel.commandapi.exceptions - package dev.jorel.commandapi.exceptions: Classes which are the exceptions raised during the execution of the Command API
dev.jorel.commandapi.executors - package dev.jorel.commandapi.executors: Classes relating to the different FunctionalInterfaces for command execution
dev.jorel.commandapi.wrappers - package dev.jorel.commandapi.wrappers: Classes that are wrappers for various vanilla-related command features
DIMENSION - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The DimensionArgument
dispatcherFile(File) - Method in class dev.jorel.commandapi.CommandAPIConfig: Specifies the location for the CommandAPI to store the internal representation of Brigadier's command tree.
DIVIDE - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation: Division of a value by another value (/=)

E

empty() - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions: Suggest nothing
empty() - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions: Create an empty SafeSuggestions object.
EmptyExecutorException - Exception Class in dev.jorel.commandapi.exceptions: An exception caused when a command has no executor
EmptyExecutorException() - Constructor for exception class dev.jorel.commandapi.exceptions.EmptyExecutorException: Creates an EmptyExecutorException
ENCHANTMENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The EnchantmentArgument
enforceReplacements(CommandSender, String...) - Method in class dev.jorel.commandapi.arguments.SuggestionsBranch: Makes sure the given arguments correspond to the suggestions of this SuggestionsBranch
ENTITIES - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders: A suggestion provider for the EntityTypeArgument
ENTITY - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType: An executor where the CommandSender is an Entity
ENTITY_SELECTOR - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The EntitySelectorArgument
ENTITY_TYPE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The EntityTypeArgument
ENVIRONMENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The EnvironmentArgument
equals(Object) - Method in record class dev.jorel.commandapi.arguments.PreviewInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class dev.jorel.commandapi.CommandPermission
equals(Object) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.jorel.commandapi.LoadContext: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.jorel.commandapi.RegisteredCommand: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class dev.jorel.commandapi.SuggestionInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class dev.jorel.commandapi.wrappers.FloatRange
equals(Object) - Method in class dev.jorel.commandapi.wrappers.IntegerRange
equals(Object) - Method in class dev.jorel.commandapi.wrappers.Rotation
equals(Object) - Method in class dev.jorel.commandapi.wrappers.Time
ExecutableCommand<Impl,CommandSender> - Class in dev.jorel.commandapi: This is a base class for AbstractCommandAPICommand and AbstractCommandTree command definitions
ExecutableCommand(CommandMetaData<CommandSender>) - Constructor for class dev.jorel.commandapi.ExecutableCommand
execute(ExecutionInfo<CommandSender, WrapperType>) - Method in class dev.jorel.commandapi.CommandAPIExecutor
executeWith(ExecutionInfo<CommandSender, WrapperType>) - Method in interface dev.jorel.commandapi.executors.NormalExecutor: Executes the command executor with the provided command sender and the provided arguments.
executeWith(ExecutionInfo<CommandSender, WrapperType>) - Method in interface dev.jorel.commandapi.executors.ResultingExecutor: Executes the command executor with the provided command sender and the provided arguments.
executeWith(ExecutionInfo<CommandSender, WrapperType>) - Method in interface dev.jorel.commandapi.executors.TypedExecutor: Executes the command executor with the provided command sender and the provided arguments.
Execution<CommandSender,Argument> - Class in dev.jorel.commandapi: A list of arguments which results in an execution.
Execution(List<Argument>, CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Constructor for class dev.jorel.commandapi.Execution
ExecutionInfo<Sender,WrapperType> - Interface in dev.jorel.commandapi.executors: This interface represents an ExecutionInfo for a command.
executor - Variable in class dev.jorel.commandapi.arguments.AbstractArgument: The CommandAPIExecutor for this executable implementation
executor - Variable in class dev.jorel.commandapi.AbstractArgumentTree: The CommandAPIExecutor for this executable implementation
executor - Variable in class dev.jorel.commandapi.AbstractCommandAPICommand: The CommandAPIExecutor for this executable implementation
executor - Variable in class dev.jorel.commandapi.AbstractCommandTree: The CommandAPIExecutor for this executable implementation
executor - Variable in class dev.jorel.commandapi.ExecutableCommand: The CommandAPIExecutor for this executable implementation
ExecutorType - Enum Class in dev.jorel.commandapi.executors: An enum representing the type of an executor

F

failWithMessage(Message) - Static method in class dev.jorel.commandapi.CommandAPI: Forces a command to return a success value of 0
failWithString(String) - Static method in class dev.jorel.commandapi.CommandAPI: Forces a command to return a success value of 0
FEEDBACK_FORWARDING - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType: An executor where the CommandSender is a io.papermc.paper.commands.FeedbackForwardingSender
FLOAT_RANGE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The FloatRangeArgument
FloatRange - Class in dev.jorel.commandapi.wrappers: A class representing a range of floats
FloatRange(float, float) - Constructor for class dev.jorel.commandapi.wrappers.FloatRange: Constructs a FloatRange with a lower bound and an upper bound
floatRangeGreaterThanOrEq(float) - Static method in class dev.jorel.commandapi.wrappers.FloatRange: Constructs a FloatRange with a given lower bound and no upper bound
floatRangeLessThanOrEq(float) - Static method in class dev.jorel.commandapi.wrappers.FloatRange: Constructs a FloatRange with a given upper bound and no lower bound
fromApacheLog4jLogger(Logger) - Static method in interface dev.jorel.commandapi.CommandAPILogger
fromArgument(Argument) - Static method in class dev.jorel.commandapi.Brigadier: Constructs a RequiredArgumentBuilder from a given argument
fromArgument(List<Argument>, Argument) - Static method in class dev.jorel.commandapi.Brigadier: Constructs a RequiredArgumentBuilder from a given argument within a command declaration.
fromCommand(AbstractCommandAPICommand<?, Argument, CommandSender>) - Static method in class dev.jorel.commandapi.Brigadier: Converts a CommandAPICommand into a Brigadier Command
fromInternal(String) - Static method in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: Converts an internal name (e.g. minecraft:time) to a CommandAPIArgumentType
fromJavaLogger(Logger) - Static method in interface dev.jorel.commandapi.CommandAPILogger
fromLiteralArgument(Literal<Argument>) - Static method in class dev.jorel.commandapi.Brigadier: Creates a new literal argument builder from a CommandAPI LiteralArgument
fromPredicate(BiPredicate<CommandSender, Object[]>, List<Argument>) - Static method in class dev.jorel.commandapi.Brigadier: Constructs a RedirectModifier from a predicate that uses a command sender and some arguments.
fromSlf4jLogger(Logger) - Static method in interface dev.jorel.commandapi.CommandAPILogger
fromString(String) - Static method in class dev.jorel.commandapi.CommandPermission: Generates a new CommandPermission from a permission node
fromString(String) - Static method in enum class dev.jorel.commandapi.wrappers.MathOperation: Creates a MathOperation from the Minecraft string representation (e.g. "=" or "/=")
fullDescription() - Method in record class dev.jorel.commandapi.RegisteredCommand: Returns the value of the fullDescription record component.
fullInput() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo: Returns the value of the fullInput record component.
fullInput() - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns the value of the fullInput record component.
FUNCTION - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType: The FunctionArgument
FUNCTION - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders: A suggestion provider for the FunctionArgument

G

generate(Function<String, T>, BiFunction<String, T, StringTooltip>, String...) - Static method in class dev.jorel.commandapi.StringTooltip: Internal base method for the other generation types
generate(Function<String, T>, BiFunction<String, T, StringTooltip>, Collection<String>) - Static method in class dev.jorel.commandapi.StringTooltip: Internal base method for the other generation types
generate(Function<String, T>, BiFunction<String, T, StringTooltip>, Stream<String>) - Static method in class dev.jorel.commandapi.StringTooltip: Internal base method for the other generation types
generate(Function<S, T>, BiFunction<S, T, Tooltip<S>>, Collection<S>) - Static method in class dev.jorel.commandapi.Tooltip: Internal base method for the other generation types, for processing collections
generate(Function<S, T>, BiFunction<S, T, Tooltip<S>>, S...) - Static method in class dev.jorel.commandapi.Tooltip: Internal base method for the other generation types, for processing arrays
generateCommand(Argument[], CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>, boolean) - Method in class dev.jorel.commandapi.CommandAPIHandler: Generates a command to be registered by the CommandAPI.
generateMessages(Function<String, Message>, String...) - Static method in class dev.jorel.commandapi.StringTooltip: Constructs a collection of StringTooltip objects from an array of suggestions, and a function which generates a formatted tooltip for each suggestion
generateMessages(Function<String, Message>, Collection<String>) - Static method in class dev.jorel.commandapi.StringTooltip: Constructs a collection of StringTooltip objects from a collection of suggestions, and a function which generates a formatted tooltip for each suggestion
generateMessages(Function<S, Message>, Collection<S>) - Static method in class dev.jorel.commandapi.Tooltip: Constructs a collection of ~~objects from an collection of suggestions, and a function which generates a formatted tooltip for each suggestion~~
generateMessages(Function<S, Message>, S...) - Static method in class dev.jorel.commandapi.Tooltip: Constructs a collection of ~~objects from an array of suggestions, and a function which generates a formatted tooltip for each suggestion~~
generatePreview(PreviewInfo<T>) - Method in interface dev.jorel.commandapi.wrappers.PreviewableFunction
generateStrings(Function<S, String>, Collection<S>) - Static method in class dev.jorel.commandapi.Tooltip: Constructs a collection of ~~objects from a collection of suggestions, and a function which generates a string tooltip for each suggestion~~
generateStrings(Function<S, String>, S...) - Static method in class dev.jorel.commandapi.Tooltip: Constructs a collection of ~~objects from an array of suggestions, and a function which generates a string tooltip for each suggestion~~
generateStrings(UnaryOperator<String>, String...) - Static method in class dev.jorel.commandapi.StringTooltip: Constructs a collection of StringTooltip objects from an array of suggestions, and a function which generates a string tooltip for each suggestion
generateStrings(UnaryOperator<String>, Collection<String>) - Static method in class dev.jorel.commandapi.StringTooltip: Constructs a collection of StringTooltip objects from a collection of suggestions, and a function which generates a string tooltip for each suggestion
get(int) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its position
get(String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
get(Type) - Method in class dev.jorel.commandapi.SafeVarHandle
getAliases() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns an array of aliases that can be used to run this command
getArgumentPermission() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the permission required to run this command
getArguments() - Method in class dev.jorel.commandapi.AbstractCommandAPICommand: Returns the list of arguments that this command has
getArgumentType() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the argument type for this argument.
getBrigadierDispatcher() - Method in interface dev.jorel.commandapi.CommandAPIPlatform
getBrigadierSourceFromCommandSender(CommandSender) - Static method in class dev.jorel.commandapi.Brigadier: Gets a Brigadier source object (e.g.
getBrigadierSourceFromCommandSender(AbstractCommandSender<? extends CommandSender>) - Method in interface dev.jorel.commandapi.CommandAPIPlatform: Converts a CommandSender wrapped in an AbstractCommandSender to an object Brigadier can use when running its commands
getByArgument(AbstractArgument<T, ?, ?, ?>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument purely based on its CommandAPI representation.
getByArgumentOrDefault(AbstractArgument<T, ?, ?, ?>, T) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument purely based on its CommandAPI representation or a default value if the argument wasn't found.
getByClass(int, Class<T>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument based on its index.
getByClass(String, Class<T>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument based on its node name.
getByClassOrDefault(int, Class<T>, T) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument based on its index or a default value if the argument wasn't found.
getByClassOrDefault(String, Class<T>, T) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument based on its node name or a default value if the argument wasn't found.
getCause() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
getCombinedArguments() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns a list of arguments linked to this argument.
getCommandDispatcher() - Static method in class dev.jorel.commandapi.Brigadier: Returns the Brigadier CommandDispatcher tree that is used internally by the CommandAPI.
getCommandSenderFromCommandSource(Source) - Method in interface dev.jorel.commandapi.CommandAPIPlatform: Converts the class used by Brigadier when running commands into an AbstractCommandSender wrapping the platform's CommandSender
getCommandSenderFromContext(CommandContext) - Static method in class dev.jorel.commandapi.Brigadier: Returns a Bukkit CommandSender from a Brigadier CommandContext
getConfiguration() - Static method in class dev.jorel.commandapi.CommandAPI: Returns the internal configuration used to manage the CommandAPI
getContext() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns some contextual information about where the error occurred.
getCursor() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns the cursor position.
getDispatcherFile() - Method in class dev.jorel.commandapi.InternalConfig
getEntityNames(Object) - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Gets a list of entity names for the current provided argument.
getException() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns the wrapped CommandSyntaxException
getExecutor() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the executors that this command has
getExecutor() - Method in class dev.jorel.commandapi.AbstractArgumentTree: Returns the executors that this command has
getExecutor() - Method in class dev.jorel.commandapi.AbstractCommandAPICommand: Returns the executors that this command has
getExecutor() - Method in class dev.jorel.commandapi.AbstractCommandTree: Returns the executors that this command has
getExecutor() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the executors that this command has
getExecutor() - Method in interface dev.jorel.commandapi.PlatformExecutable
getField(Class<?>, String) - Static method in class dev.jorel.commandapi.CommandAPIHandler: Caches a field using reflection if it is not already cached, then return the field of a given class.
getField(Class<?>, String, String) - Static method in class dev.jorel.commandapi.CommandAPIHandler: Caches a field using reflection if it is not already cached, then return the field of a given class.
getFullDescription() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the full description for this command
getFullInput() - Method in record class dev.jorel.commandapi.executors.CommandArguments: Deprecated, for removal: This API element is subject to removal in a future version.
This method has been deprecated in favour of CommandArguments.fullInput()
getHelpString() - Method in class dev.jorel.commandapi.arguments.AbstractArgument
getIncludedSuggestions() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns an optional function which produces an array of suggestions which should be added to existing suggestions.
getInput() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns the input that caused the CommandSyntaxException.
getInstance() - Static method in class dev.jorel.commandapi.CommandAPIHandler
getLiteral() - Method in interface dev.jorel.commandapi.arguments.Literal: Returns the literal string represented by this argument
getLiterals() - Method in interface dev.jorel.commandapi.arguments.MultiLiteral: Returns the literals that are present in this argument
getLocalizedMessage() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
getLogger() - Static method in class dev.jorel.commandapi.CommandAPI
getLogger() - Method in interface dev.jorel.commandapi.CommandAPIPlatform
getLowerBound() - Method in class dev.jorel.commandapi.wrappers.FloatRange: The lower bound of this range.
getLowerBound() - Method in class dev.jorel.commandapi.wrappers.IntegerRange: The lower bound of this range.
getMapper() - Method in interface dev.jorel.commandapi.arguments.SafeOverrideable
getMessage() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns the message together with the position it occurred on and some context.
getMissingImplementationMessage() - Method in class dev.jorel.commandapi.InternalConfig
getName() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the name of this command
getNamespace() - Method in class dev.jorel.commandapi.InternalConfig
getNBTContainerClass() - Method in class dev.jorel.commandapi.InternalConfig
getNBTContainerConstructor() - Method in class dev.jorel.commandapi.InternalConfig
getNextSuggestion(CommandSender, String...) - Method in class dev.jorel.commandapi.arguments.SuggestionsBranch: Gets the next ArgumentSuggestions based on the previous arguments.
getNodeName() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the name of this argument's node
getNormalExecutors() - Method in class dev.jorel.commandapi.CommandAPIExecutor
getNormalizedPitch() - Method in class dev.jorel.commandapi.wrappers.Rotation: Normalizes the given pitch angle to a value between +/-90 degrees.
getNormalizedYaw() - Method in class dev.jorel.commandapi.wrappers.Rotation: Normalizes the given yaw angle to a value between +/-180 degrees.
getOptional(int) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the argument by its index
getOptional(String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
getOptionalByArgument(AbstractArgument<T, ?, ?, ?>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the provided argument.
getOptionalByClass(int, Class<T>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the argument at the given index.
getOptionalByClass(String, Class<T>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the argument with the given node name.
getOptionalUnchecked(int) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the argument at its index
getOptionalUnchecked(String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the argument by its node name
getOrDefault(int, Object) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its index
getOrDefault(int, Supplier<?>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its index
getOrDefault(String, Object) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
getOrDefault(String, Supplier<?>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
getOrDefaultRaw(int, String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns a raw argument by its index
getOrDefaultRaw(int, Supplier<String>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns a raw argument by its index
getOrDefaultRaw(String, String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns a raw argument by its node name
getOrDefaultRaw(String, Supplier<String>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns a raw argument by its node name
getOrDefaultUnchecked(int, Supplier<T>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its index
getOrDefaultUnchecked(int, T) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its index
getOrDefaultUnchecked(String, Supplier<T>) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
getOrDefaultUnchecked(String, T) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
getOverriddenSuggestions() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns an optional function that maps the command sender to an IStringTooltip array of suggestions for the current command
getPermission() - Method in class dev.jorel.commandapi.CommandPermission: Returns the custom permission in string form if set
getPermission() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the permission associated with this command
getPitch() - Method in class dev.jorel.commandapi.wrappers.Rotation: Gets the pitch of this rotation, measured in degrees.
getPlatform() - Method in class dev.jorel.commandapi.CommandAPIHandler
getPreview() - Method in interface dev.jorel.commandapi.arguments.Previewable
getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the primitive type of the current Argument.
getRaw(int) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns a raw argument by its position
getRaw(String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns a raw argument by its node name
getRawArgumentInput(CommandContext<CommandSource>, String) - Static method in class dev.jorel.commandapi.CommandAPIHandler: Returns the raw input for an argument for a given command context and its key.
getRawMessage() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns the raw message, not including positional information
getRawOptional(int) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the raw argument by its index
getRawOptional(String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an Optional holding the raw argument by its node name
getRawType() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the NMS or brigadier type for this argument.
getRegisteredCommands() - Static method in class dev.jorel.commandapi.CommandAPI
getRequirements() - Method in class dev.jorel.commandapi.arguments.AbstractArgument: Returns the requirements required to run this command
getRequirements() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the requirements that must be satisfied to run this command
getResultingExecutors() - Method in class dev.jorel.commandapi.CommandAPIExecutor
getRootNode() - Static method in class dev.jorel.commandapi.Brigadier: Returns the root node of the current CommandDispatcher.
getSenderForCommand(CommandContext<Source>, boolean) - Method in interface dev.jorel.commandapi.CommandAPIPlatform: Converts a Brigadier CommandContext into an AbstractCommandSender wrapping the platform's CommandSender
getShortDescription() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the short description for this command
getSource() - Method in interface dev.jorel.commandapi.commandsenders.AbstractCommandSender
getStackTrace() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
getStatic() - Method in class dev.jorel.commandapi.SafeVarHandle
getSubcommands() - Method in class dev.jorel.commandapi.AbstractCommandAPICommand: Returns the list of subcommands that this command has
getSuggestion() - Method in interface dev.jorel.commandapi.IStringTooltip: Returns the suggestion that this object contains
getSuggestion() - Method in class dev.jorel.commandapi.StringTooltip: Returns the current suggestion that this class holds
getSuggestion() - Method in class dev.jorel.commandapi.Tooltip: Gets the suggestion for this object
getSuggestionProvider() - Method in interface dev.jorel.commandapi.arguments.CustomProvidedArgument: Returns the suggestion provider that this argument is populated with
getSuggestionProvider(SuggestionProviders) - Method in interface dev.jorel.commandapi.CommandAPIPlatform
getTooltip() - Method in interface dev.jorel.commandapi.IStringTooltip: Returns the tooltip text that this object contains
getTooltip() - Method in class dev.jorel.commandapi.StringTooltip: Returns the current tooltip text that this class holds
getTooltip() - Method in class dev.jorel.commandapi.Tooltip: Gets the formatted tooltip for this object
getType() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException: Returns the type of the exception.
getType() - Method in interface dev.jorel.commandapi.executors.TypedExecutor: Returns the type of the sender of the current executor.
getUnchecked(int) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its position
getUnchecked(String) - Method in record class dev.jorel.commandapi.executors.CommandArguments: Returns an argument by its node name
getUpperBound() - Method in class dev.jorel.commandapi.wrappers.FloatRange: The upper bound of this range.
getUpperBound() - Method in class dev.jorel.commandapi.wrappers.IntegerRange: The upper bound of this range.
getUsage() - Method in class dev.jorel.commandapi.ExecutableCommand: Returns the usage for this command
getYaw() - Method in class dev.jorel.commandapi.wrappers.Rotation: Gets the yaw of this location, measured in degrees.
GreedyArgument - Interface in dev.jorel.commandapi.arguments: An interface indicating that an argument consumes all available characters
GreedyArgumentException - Exception Class in dev.jorel.commandapi.exceptions: An exception caused when a greedy argument is not declared at the end of a List
GreedyArgumentException(AbstractArgument<?, ?, ?, ?>[]) - Constructor for exception class dev.jorel.commandapi.exceptions.GreedyArgumentException: Creates a GreedyArgumentException

H

hasAnyExecutors() - Method in class dev.jorel.commandapi.CommandAPIExecutor

hasCombinedArguments() - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Returns true if this argument has linked arguments.

hashCode() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo

Returns a hash code value for this object.

hashCode() - Method in class dev.jorel.commandapi.CommandPermission

hashCode() - Method in record class dev.jorel.commandapi.executors.CommandArguments

Returns a hash code value for this object.

hashCode() - Method in record class dev.jorel.commandapi.LoadContext

Returns a hash code value for this object.

hashCode() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns a hash code value for this object.

hashCode() - Method in record class dev.jorel.commandapi.SuggestionInfo

Returns a hash code value for this object.

hashCode() - Method in class dev.jorel.commandapi.wrappers.FloatRange

hashCode() - Method in class dev.jorel.commandapi.wrappers.IntegerRange

hashCode() - Method in class dev.jorel.commandapi.wrappers.Rotation

hashCode() - Method in class dev.jorel.commandapi.wrappers.Time

hasPermission(String) - Method in interface dev.jorel.commandapi.commandsenders.AbstractCommandSender

Tests if this CommandSender has permission to use the given permission node

hasSilentLogs() - Method in class dev.jorel.commandapi.InternalConfig

hasVerboseOutput() - Method in class dev.jorel.commandapi.InternalConfig

helpTopic() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns the value of the helpTopic record component.

I

includeSafeSuggestions(SafeSuggestions<S, CommandSender>) - Method in interface dev.jorel.commandapi.arguments.SafeOverrideable

Includes the suggestions provided with the existing suggestions for this argument.

includeSuggestions(ArgumentSuggestions<CommandSender>) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Include suggestions to add to the list of default suggestions represented by this argument.

includeSuggestions(ArgumentSuggestions<CommandSender>) - Method in interface dev.jorel.commandapi.arguments.SafeOverrideable

info(String) - Method in interface dev.jorel.commandapi.CommandAPILogger

initCause(Throwable) - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException

initializeNBTAPI(Class<T>, Function<Object, T>) - Method in class dev.jorel.commandapi.CommandAPIConfig

Initializes the CommandAPI's implementation of an NBT API.

input() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo

Returns the value of the input record component.

instance() - Method in interface dev.jorel.commandapi.ChainableBuilder

Returns the instance of this class with the class Impl.

INT_RANGE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The IntegerRangeArgument

IntegerRange - Class in dev.jorel.commandapi.wrappers

A class representing a range of integers

IntegerRange(int, int) - Constructor for class dev.jorel.commandapi.wrappers.IntegerRange

Constructs an IntegerRange with a lower bound and an upper bound

integerRangeGreaterThanOrEq(int) - Static method in class dev.jorel.commandapi.wrappers.IntegerRange

Constructs an IntegerRange with a given lower bound and no upper bound

integerRangeLessThanOrEq(int) - Static method in class dev.jorel.commandapi.wrappers.IntegerRange

Constructs a IntegerRange with a given upper bound and no lower bound

InternalConfig - Class in dev.jorel.commandapi

Configuration wrapper class.

InternalConfig(CommandAPIConfig<?>) - Constructor for class dev.jorel.commandapi.InternalConfig

Creates an InternalConfig from a CommandAPIConfig

InvalidCommandNameException - Exception Class in dev.jorel.commandapi.exceptions

An exception that occurs when trying to register a command with an invalid name

InvalidCommandNameException(String) - Constructor for exception class dev.jorel.commandapi.exceptions.InvalidCommandNameException

Creates an InvalidCommandNameException

InvalidRangeException - Exception Class in dev.jorel.commandapi.exceptions

An exception that occurs when the maximum value of a FloatRange or IntegerRange is less than its minimum value

InvalidRangeException() - Constructor for exception class dev.jorel.commandapi.exceptions.InvalidRangeException

Creates an InvalidRangeException

isConverted - Variable in class dev.jorel.commandapi.AbstractCommandAPICommand

isConverted() - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Returns whether this command is an automatically converted command

isForceNative() - Method in class dev.jorel.commandapi.CommandAPIExecutor

isInRange(float) - Method in class dev.jorel.commandapi.wrappers.FloatRange

Determines if a float is within range of the lower bound (inclusive) and the upper bound (inclusive).

isInRange(int) - Method in class dev.jorel.commandapi.wrappers.IntegerRange

Determines if an int is within range of the lower bound (inclusive) and the upper bound (inclusive).

isLegacy() - Method in interface dev.jorel.commandapi.arguments.Previewable

isListed() - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Returns true if this argument will be listed in the Object args[] of the command executor

isLoaded() - Static method in class dev.jorel.commandapi.CommandAPI

Returns whether the CommandAPI is currently loaded.

isMojangMapped() - Static method in interface dev.jorel.commandapi.MojangMappedVersionHandler

isNegated() - Method in class dev.jorel.commandapi.CommandPermission

Returns if the permission is negated

isOp() - Method in interface dev.jorel.commandapi.commandsenders.AbstractCommandSender

Tests if this CommandSender has `operator` status, or the ability to run any command

isOptional() - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Returns true if this argument will be optional when executing the command this argument is included in

IStringTooltip - Interface in dev.jorel.commandapi

A string-based tooltip interface that includes a string suggestion and a formatted tooltip text to display when hovering over the suggestion

ITEMSTACK - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ItemStackArgument

ITEMSTACK_PREDICATE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ItemStackPredicateArgument

L

lateInitializeNBT(Class<?>, Function<Object, ?>) - Method in class dev.jorel.commandapi.InternalConfig

LIST - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ListArgument

LIST_TEXT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ListTextArgument

Literal<Impl> - Interface in dev.jorel.commandapi.arguments

An interface representing literal-based arguments

LITERAL - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The LiteralArgument

LoadContext - Record Class in dev.jorel.commandapi

LoadContext(CommandAPIPlatform<?, ?, ?>) - Constructor for record class dev.jorel.commandapi.LoadContext

LoadContext(CommandAPIPlatform<?, ?, ?>, Runnable) - Constructor for record class dev.jorel.commandapi.LoadContext

Creates an instance of a LoadContext record class.

LOCATION - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The LocationArgument

LOCATION_2D - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The Location2dArgument

LocationType - Enum Class in dev.jorel.commandapi.arguments

An enum representing block position or precise position for location arguments

logError(String) - Static method in class dev.jorel.commandapi.CommandAPI

Logs an error from the CommandAPI.

logInfo(String) - Static method in class dev.jorel.commandapi.CommandAPI

Logs a message to the console using Logger.info() if the configuration has verbose logging enabled

logNormal(String) - Static method in class dev.jorel.commandapi.CommandAPI

Logs a message from the CommandAPI.

logWarning(String) - Static method in class dev.jorel.commandapi.CommandAPI

Logs a warning from the CommandAPI.

lookupPreviewable(List<String>) - Method in class dev.jorel.commandapi.CommandAPIHandler

Looks up the function to generate a chat preview for a path of nodes in the command tree.

lookupPreviewableLegacyStatus(List<String>) - Method in class dev.jorel.commandapi.CommandAPIHandler

LOOT_TABLE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The LootTableArgument

LOOT_TABLES - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders

A suggestion provider for the LootTableArgument

M

MAP - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The MapArgument

MATH_OPERATION - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The MathOperationArgument

MathOperation - Enum Class in dev.jorel.commandapi.wrappers

A representation of the math operations for the Minecraft scoreboard

MAX - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation

The maximum value of two values (>)

merge(ArgumentSuggestions<CommandSender>...) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Merge suggestions from multiple ArgumentSuggestions together

messageFromString(String) - Static method in class dev.jorel.commandapi.Tooltip

Converts an unformatted string to an unformatted tooltip by wrapping as with a LiteralMessage.

meta - Variable in class dev.jorel.commandapi.ExecutableCommand

The Command's meta-data for this executable command

MIN - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation

The minimum value of two values (<)

MissingCommandExecutorException - Exception Class in dev.jorel.commandapi.exceptions

An exception caused when a command does not declare any executors

MissingCommandExecutorException(String) - Constructor for exception class dev.jorel.commandapi.exceptions.MissingCommandExecutorException

Creates a MissingCommandExecutorException

missingExecutorImplementationMessage(String) - Method in class dev.jorel.commandapi.CommandAPIConfig

Sets the message to display to users when a command has no executor.

MOD - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation

Modulo of a value by another value (%=)

MojangMappedVersionHandler - Interface in dev.jorel.commandapi

This file handles loading the correct mappings information.

MULTI_LITERAL - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The MultiLiteralArgument

MultiLiteral<Impl> - Interface in dev.jorel.commandapi.arguments

An interface representing arguments with multiple literal string definitions

MULTIPLY - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation

Multiplication of a value by another value (*=)

N

namespace() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns the value of the namespace record component.

NAMESPACED_KEY - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The NamespacedKeyArgument

NATIVE - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType

An executor where the CommandSender is (always) a NativeProxyCommandSender

NBT_COMPOUND - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The NBTCompoundArgument

NBTAPINotFoundException - Exception Class in dev.jorel.commandapi.exceptions

An exception that occurs when the NBTAPI is not found, but an argument that uses it is declared

NBTAPINotFoundException(Class<?>) - Constructor for exception class dev.jorel.commandapi.exceptions.NBTAPINotFoundException

Creates an NBTAPINotFoundException

newConcreteCommandAPICommand(CommandMetaData<CommandSender>) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

newConcreteCommandAPICommand(CommandMetaData<CommandSender>) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

newConcreteLiteralArgument(String, String) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

newConcreteMultiLiteralArgument(String, String[]) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

none(String) - Static method in class dev.jorel.commandapi.StringTooltip

Constructs a StringTooltip with a suggestion and no tooltip

none(String...) - Static method in class dev.jorel.commandapi.StringTooltip

Constructs a collection of StringTooltip objects from an array of suggestions, and no tooltips

none(Collection<String>) - Static method in class dev.jorel.commandapi.StringTooltip

Constructs a collection of StringTooltip objects from a collection of suggestions, and no tooltips

none(Collection<S>) - Static method in class dev.jorel.commandapi.Tooltip

Constructs a collection of ~~objects from a collection of suggestions, and no tooltips~~

none(S) - Static method in class dev.jorel.commandapi.Tooltip

Constructs a Tooltip<S> with a suggestion and no tooltip

none(S...) - Static method in class dev.jorel.commandapi.Tooltip

Constructs a collection of ~~objects from an array of suggestions, and no tooltips~~

NONE - Static variable in class dev.jorel.commandapi.CommandPermission

Command can be run with no permissions

NormalExecutor<CommandSender,WrapperType> - Interface in dev.jorel.commandapi.executors

The interface for normal command executors

O

OBJECTIVE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ObjectiveArgument

OBJECTIVE_CRITERIA - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ObjectiveCriteriaArgument

OFFLINE_PLAYER - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The OfflinePlayerArgument

ofMessage(String, Message) - Static method in class dev.jorel.commandapi.StringTooltip

Constructs a StringTooltip with a suggestion and a formatted tooltip

ofMessage(S, Message) - Static method in class dev.jorel.commandapi.Tooltip

Constructs a Tooltip<S> with a suggestion and a tooltip

ofOrNull(Class<? super Type>, String, String, Class<? super FieldType>) - Static method in class dev.jorel.commandapi.SafeVarHandle

ofString(String, String) - Static method in class dev.jorel.commandapi.StringTooltip

Constructs a StringTooltip with a suggestion and a string tooltip

ofString(S, String) - Static method in class dev.jorel.commandapi.Tooltip

Constructs a Tooltip<S> with a suggestion and a tooltip

onDisable() - Static method in class dev.jorel.commandapi.CommandAPI

Unloads the CommandAPI.

onDisable() - Method in class dev.jorel.commandapi.CommandAPIHandler

onDisable() - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Platform-specific stuff that should happen when the CommandAPI is disabled.

onEnable() - Static method in class dev.jorel.commandapi.CommandAPI

Enables the CommandAPI.

onEnable() - Method in class dev.jorel.commandapi.CommandAPIHandler

onEnable() - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Platform-specific stuff that should happen when the CommandAPI is enabled, such as registering event listeners.

onLoad(CommandAPIConfig<?>) - Static method in class dev.jorel.commandapi.CommandAPI

Initializes the CommandAPI for loading.

onLoad(CommandAPIConfig<?>) - Method in class dev.jorel.commandapi.CommandAPIHandler

onLoad(CommandAPIConfig<?>) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Platform-specific stuff that should happen when the CommandAPI is loaded, such as checking dependencies and initializing helper classes.

OP - Static variable in class dev.jorel.commandapi.CommandPermission

A player that has to be an operator to run a command

OptionalArgumentException - Exception Class in dev.jorel.commandapi.exceptions

OptionalArgumentException(String) - Constructor for exception class dev.jorel.commandapi.exceptions.OptionalArgumentException

override() - Method in class dev.jorel.commandapi.ExecutableCommand

Overrides a command.

P

PaperAdventureNotFoundException - Exception Class in dev.jorel.commandapi.exceptions

An exception that occurs when Paper's Adventure API is not present and has been set to be used

PaperAdventureNotFoundException(Class<?>) - Constructor for exception class dev.jorel.commandapi.exceptions.PaperAdventureNotFoundException

Creates a PaperAdventureNotFoundException

parse(String) - Method in interface dev.jorel.commandapi.arguments.StringParser

A method that turns a String into an object of type T.

parseArgument(CommandContext<Source>, String, CommandArguments) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Parses an argument, returning the specific Bukkit object that the argument represents.

parseArguments(CommandContext, List<Argument>) - Static method in class dev.jorel.commandapi.Brigadier

Parses arguments into their respective objects with a given command context.

parsedInput() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo

Returns the value of the parsedInput record component.

PARTICLE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ParticleArgument

permission() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns the value of the permission record component.

platform() - Method in record class dev.jorel.commandapi.LoadContext

Returns the value of the platform record component.

PlatformExecutable<Impl,CommandSender> - Interface in dev.jorel.commandapi

player() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo

Returns the value of the player record component.

PLAYER - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The PlayerArgument

PLAYER - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType

An executor where the CommandSender is a Player

postCommandRegistration(RegisteredCommand, LiteralCommandNode<Source>, List<LiteralCommandNode<Source>>) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Stuff to run after a command has been generated.

POTION_EFFECT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The PotionEffectArgument

POTION_EFFECTS - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders

A suggestion provider for the PotionEffectArgument

PRECISE_POSITION - Enum constant in enum class dev.jorel.commandapi.arguments.LocationType

Represents the exact coordinates of a position, for example: (10.24, 70.00, -18.79) or (24.3, 25.5)

preCommandRegistration(String) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Stuff to run before a command is generated.

prependedBy(Argument) - Method in class dev.jorel.commandapi.Execution

Previewable<T,A> - Interface in dev.jorel.commandapi.arguments

An interface representing that the argument can be previewed using Minecraft's chat preview feature.

PreviewableFunction<T> - Interface in dev.jorel.commandapi.wrappers

PreviewInfo<T> - Record Class in dev.jorel.commandapi.arguments

PreviewInfo(AbstractPlayer<?>, String, String, T) - Constructor for record class dev.jorel.commandapi.arguments.PreviewInfo

Creates an instance of a PreviewInfo record class.

previousArgs() - Method in record class dev.jorel.commandapi.SuggestionInfo

Returns the value of the previousArgs record component.

PRIMITIVE_BOOLEAN - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument BooleanArgument

PRIMITIVE_DOUBLE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument DoubleArgument

PRIMITIVE_FLOAT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument F;patArgument

PRIMITIVE_GREEDY_STRING - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument GreedyStringArgument

PRIMITIVE_INTEGER - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument IntegerArgument

PRIMITIVE_LONG - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument LongArgument

PRIMITIVE_STRING - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument StringArgument

PRIMITIVE_TEXT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Primitive argument TextArgument

printStackTrace() - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException

printStackTrace(PrintStream) - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException

printStackTrace(PrintWriter) - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException

PROXY - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType

An executor where the CommandSender is a NativeProxyCommandSender

R

rawArgs() - Method in record class dev.jorel.commandapi.executors.CommandArguments

Returns the value of the rawArgs record component.

rawArgsMap() - Method in record class dev.jorel.commandapi.executors.CommandArguments

Returns the value of the rawArgsMap record component.

RECIPE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The RecipeArgument

RECIPES - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders

A suggestion provider for the RecipeArgument

register() - Method in class dev.jorel.commandapi.ExecutableCommand

Registers this command with the default namespace

register(CommandMetaData<CommandSender>, String) - Method in class dev.jorel.commandapi.Execution

Register a command with the given arguments and executor to brigadier, by converting it into a AbstractCommandAPICommand

register(String) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Registers the command with a given namespace

register(String) - Method in class dev.jorel.commandapi.AbstractCommandTree

Registers the command with a given namespace

register(String) - Method in class dev.jorel.commandapi.ExecutableCommand

Registers this command with a custom String namespace

registerCommand(Class<?>) - Static method in class dev.jorel.commandapi.CommandAPI

Registers a command.

registerCommandNode(LiteralArgumentBuilder<Source>, String) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Registers a Brigadier command node and returns the built node.

RegisteredCommand - Record Class in dev.jorel.commandapi

Class to store a registered command which has its command name and a list of arguments as a string.

RegisteredCommand(String, List<String>, List<AbstractArgument<?, ?, ?, ?>>, Optional<String>, Optional<String>, Optional<String[]>, Optional<Object>, String[], CommandPermission, String) - Constructor for record class dev.jorel.commandapi.RegisteredCommand

Creates an instance of a RegisteredCommand record class.

registerPermission(String) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

reloadDatapacks() - Static method in class dev.jorel.commandapi.CommandAPI

Reloads all the datapacks that are on the server.

reloadDataPacks() - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Reloads the server's data packs to include CommandAPI commands

REMOTE - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType

An executor where the CommandSender is a RemoteConsoleCommandSender

replaceSafeSuggestions(SafeSuggestions<S, CommandSender>) - Method in interface dev.jorel.commandapi.arguments.SafeOverrideable

Replaces the suggestions with a safe SafeSuggestions object.

replaceSuggestions(ArgumentSuggestions<CommandSender>) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Replace the suggestions of this argument.

replaceSuggestions(ArgumentSuggestions<CommandSender>) - Method in interface dev.jorel.commandapi.arguments.SafeOverrideable

ResultingExecutor<CommandSender,WrapperType> - Interface in dev.jorel.commandapi.executors

The interface for resulting command executors

Rotation - Class in dev.jorel.commandapi.wrappers

A class to represent the yaw and pitch rotation in degrees

Rotation(float, float) - Constructor for class dev.jorel.commandapi.wrappers.Rotation

Constructs a Rotation with a given yaw and pitch

ROTATION - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The RotationArgument

run(ExecutionInfo<CommandSender, WrapperType>) - Method in interface dev.jorel.commandapi.executors.NormalExecutor

Executes the command.

run(ExecutionInfo<CommandSender, WrapperType>) - Method in interface dev.jorel.commandapi.executors.ResultingExecutor

Executes the command.

S

SafeOverrideable<T,S,Impl,Argument,CommandSender> - Interface in dev.jorel.commandapi.arguments

SafeSuggestions<S,CommandSender> - Interface in dev.jorel.commandapi.arguments

This class represents safe suggestions.

SafeVarHandle<Type,FieldType> - Class in dev.jorel.commandapi

A wrapper around VarHandle with better type safety using generics and a toggleable underlying implementation depending on whether we're using mojang mappings or non-mojang mappings

SCORE_HOLDER - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ScoreHolderArgument

SCOREBOARD_SLOT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The ScoreboardSlotArgument

seconds(int) - Static method in class dev.jorel.commandapi.wrappers.Time

Create a Time object with a given number of seconds

sender() - Method in interface dev.jorel.commandapi.executors.ExecutionInfo

sender() - Method in record class dev.jorel.commandapi.SuggestionInfo

Returns the value of the sender record component.

senderWrapper() - Method in interface dev.jorel.commandapi.executors.ExecutionInfo

This is not intended for public use and is only used internally.

set(Type, FieldType) - Method in class dev.jorel.commandapi.SafeVarHandle

setAliases(String[]) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the aliases for this command

setArguments(List<Argument>) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Sets the arguments that this command has

setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Sets the executors for this command

setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.AbstractArgumentTree

Sets the executors for this command

setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Sets the executors for this command

setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.AbstractCommandTree

Sets the executors for this command

setExecutor(CommandAPIExecutor<CommandSender, AbstractCommandSender<? extends CommandSender>>) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the executors for this command

setListed(boolean) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Sets whether this argument will be listed in the Object args[] of the command executor

setLogger(CommandAPILogger) - Static method in class dev.jorel.commandapi.CommandAPI

setNamespace(String) - Method in class dev.jorel.commandapi.CommandAPIConfig

Sets the default namespace to use when register commands

setNormalExecutors(List<NormalExecutor<CommandSender, WrapperType>>) - Method in class dev.jorel.commandapi.CommandAPIExecutor

setOptional(boolean) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Sets whether this argument will be optional when executing the command this argument is included in

setPermission(CommandPermission) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the permission required to run this command

setRequirements(Predicate<CommandSender>) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the requirements that must be satisfied to run this command

setResultingExecutors(List<ResultingExecutor<CommandSender, WrapperType>>) - Method in class dev.jorel.commandapi.CommandAPIExecutor

setStackTrace(StackTraceElement[]) - Method in exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException

setSubcommands(List<Impl>) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Sets the list of subcommands that this command has

severe(String) - Method in interface dev.jorel.commandapi.CommandAPILogger

severe(String, Throwable) - Method in interface dev.jorel.commandapi.CommandAPILogger

shortDescription() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns the value of the shortDescription record component.

shouldBeLenientForMinorVersions() - Method in class dev.jorel.commandapi.InternalConfig

shouldSkipSenderProxy(String) - Method in class dev.jorel.commandapi.InternalConfig

shouldUseLatestNMSVersion() - Method in class dev.jorel.commandapi.InternalConfig

silentLogs(boolean) - Method in class dev.jorel.commandapi.CommandAPIConfig

Silences all logs (including warnings, but not errors) for the CommandAPI if true.

SOUND - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The SoundArgument

SOUNDS - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders

A suggestion provider for the SoundArgument

SpigotNotFoundException - Exception Class in dev.jorel.commandapi.exceptions

An exception that occurs when Spigot is not present and Spigot is required

SpigotNotFoundException(Class<?>) - Constructor for exception class dev.jorel.commandapi.exceptions.SpigotNotFoundException

Creates a SpigotNotFoundException

stopCommandRegistration() - Static method in class dev.jorel.commandapi.CommandAPI

Flag that commands should no longer be registered.

stringCollection(Function<SuggestionInfo<CommandSender>, Collection<String>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest a collection of strings as the result of a function

stringCollectionAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<Collection<String>>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest a collection of strings asynchronously

StringParser<T> - Interface in dev.jorel.commandapi.arguments

A class that represents a function that parses a String into another object.

strings(String...) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest hardcoded strings

strings(Collection<String>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest hardcoded strings

strings(Function<SuggestionInfo<CommandSender>, String[]>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest an array of strings as the result of a function

stringsAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<String[]>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest an array of strings asynchronously

stringsWithTooltips(IStringTooltip...) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest hardcoded strings with tooltips

stringsWithTooltips(Collection<IStringTooltip>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest hardcoded strings with tooltips

stringsWithTooltips(Function<SuggestionInfo<CommandSender>, IStringTooltip[]>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest an array of strings with tooltips as the result of a function

stringsWithTooltipsAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<IStringTooltip[]>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest an array of strings with tooltips asynchronously

stringsWithTooltipsCollection(Function<SuggestionInfo<CommandSender>, Collection<IStringTooltip>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest a collection of strings with tooltips as the result of a function

stringsWithTooltipsCollectionAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<Collection<IStringTooltip>>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Suggest a collection of strings with tooltips asynchronously

StringTooltip - Class in dev.jorel.commandapi

Represents a suggestion for an argument with a hover tooltip text for that suggestion.

StringTooltip(String, Message) - Constructor for class dev.jorel.commandapi.StringTooltip

subcommands - Variable in class dev.jorel.commandapi.AbstractCommandAPICommand

SUBTRACT - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation

Subtraction of a value by another value (-=)

suggest(ArgumentSuggestions<CommandSender>...) - Static method in class dev.jorel.commandapi.arguments.SuggestionsBranch

Creates a SuggestionsBranch starting with the given suggestions.

suggest(SuggestionInfo<CommandSender>, SuggestionsBuilder) - Method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions

Create a CompletableFuture resolving onto a brigadier Suggestions object.

suggest(Collection<T>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Hardcode a collection of values to suggest

suggest(Function<SuggestionInfo<CommandSender>, T[]>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest an array of values as the result of a function

suggest(T...) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Hardcode an array of values to suggest

suggestAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<T[]>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest an array of values provided asynchronously

suggestCollection(Function<SuggestionInfo<CommandSender>, Collection<T>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest a collection of values as the result of a function

suggestCollectionAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<Collection<T>>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest a collection of values provided asynchronously

SuggestionInfo<CommandSender> - Record Class in dev.jorel.commandapi

A class that represents information which you can use to generate suggestions.

SuggestionInfo(CommandSender, CommandArguments, String, String) - Constructor for record class dev.jorel.commandapi.SuggestionInfo

Creates an instance of a SuggestionInfo record class.

SuggestionProviders - Enum Class in dev.jorel.commandapi.arguments

An enum representing the different suggestion providers for arguments based on Minecraft namespaced keys

SuggestionsBranch<CommandSender> - Class in dev.jorel.commandapi.arguments

This class represents a branch in the suggestions of an argument.

SWAP - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation

Swap the results of two values (><)

T

TEAM - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The TeamArgument

then(AbstractArgumentTree<?, Argument, CommandSender>) - Method in class dev.jorel.commandapi.AbstractArgumentTree

Create a child branch on this node

then(AbstractArgumentTree<?, Argument, CommandSender>) - Method in class dev.jorel.commandapi.AbstractCommandTree

Create a child branch on the tree

thenNested(AbstractArgumentTree<?, Argument, CommandSender>...) - Method in class dev.jorel.commandapi.AbstractArgumentTree

Creates a chain of child branches starting at this node

thenNested(AbstractArgumentTree<?, Argument, CommandSender>...) - Method in class dev.jorel.commandapi.AbstractCommandTree

Creates a chain of child branches starting at this node

thenNested(List<AbstractArgumentTree<?, Argument, CommandSender>>) - Method in class dev.jorel.commandapi.AbstractArgumentTree

Creates a chain of child branches starting at this node

thenNested(List<AbstractArgumentTree<?, Argument, CommandSender>>) - Method in class dev.jorel.commandapi.AbstractCommandTree

Creates a chain of child branches starting at this node

ticks(int) - Static method in class dev.jorel.commandapi.wrappers.Time

Create a Time object with a given number of ticks

Time - Class in dev.jorel.commandapi.wrappers

A class that represents time suggestions for the TimeArgument

TIME - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The TimeArgument

Tooltip<S> - Class in dev.jorel.commandapi

This class represents a suggestion for an argument with a hover tooltip text for that suggestion.

Tooltip(S, Message) - Constructor for class dev.jorel.commandapi.Tooltip

tooltipCollection(Function<SuggestionInfo<CommandSender>, Collection<Tooltip<T>>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest a collection of values with tooltips as the result of a function

tooltipCollectionAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<Collection<Tooltip<T>>>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest a collection of values with tooltips asynchronously

tooltips(Tooltip<T>...) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest an array of hardcoded values with tooltips

tooltips(Collection<Tooltip<T>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest a collection of hardcoded values with tooltips

tooltips(Function<SuggestionInfo<CommandSender>, Tooltip<T>[]>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest an array of values with tooltips as the result of a function

tooltipsAsync(Function<SuggestionInfo<CommandSender>, CompletableFuture<Tooltip<T>[]>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Suggest an array of values with tooltips asynchronously

toString() - Method in class dev.jorel.commandapi.arguments.AbstractArgument

toString() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo

Returns a string representation of this record class.

toString() - Method in class dev.jorel.commandapi.CommandPermission

Returns a human-readable string of this CommandPermission

toString() - Method in record class dev.jorel.commandapi.executors.CommandArguments

Returns a string representation of this record class.

toString() - Method in record class dev.jorel.commandapi.LoadContext

Returns a string representation of this record class.

toString() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns a string representation of this record class.

toString() - Method in record class dev.jorel.commandapi.SuggestionInfo

Returns a string representation of this record class.

toString() - Method in class dev.jorel.commandapi.wrappers.FloatRange

Converts this FloatRange to a Minecraft string for use with arguments

toString() - Method in class dev.jorel.commandapi.wrappers.IntegerRange

Converts this IntegerRange to a Minecraft string for use with arguments

toString() - Method in enum class dev.jorel.commandapi.wrappers.MathOperation

Returns the Minecraft string value of this MathOperation

toString() - Method in class dev.jorel.commandapi.wrappers.Rotation

toString() - Method in class dev.jorel.commandapi.wrappers.Time

toSuggestions(Argument, List<Argument>) - Static method in class dev.jorel.commandapi.Brigadier

Converts an argument and a list of arguments to a Brigadier SuggestionProvider

toSuggestions(Function<S, String>) - Method in interface dev.jorel.commandapi.arguments.SafeSuggestions

Convert this SafeSuggestions object into an ArgumentSuggestions by mapping the values with a string mapping function.

TypedExecutor<CommandSender,WrapperType> - Interface in dev.jorel.commandapi.executors

An interface that includes the type of an executor (what command senders it can execute) and has a method that executes an executor with a given command sender and arguments

U

UnimplementedArgumentException - Exception Class in dev.jorel.commandapi.exceptions

An exception caused when using an argument which hasn't been implemented in this Minecraft version

UnimplementedArgumentException(String, String) - Constructor for exception class dev.jorel.commandapi.exceptions.UnimplementedArgumentException

Creates an EnvironmentArgumentException

unregister(String) - Static method in class dev.jorel.commandapi.CommandAPI

Unregisters a command

unregister(String, boolean) - Static method in class dev.jorel.commandapi.CommandAPI

Unregisters a command

unregister(String, boolean) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Unregisters a command from the CommandGraph so it can't be run anymore.

updateRequirements(AbstractPlayer<?>) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Updates the requirements required for a given player to execute a command.

updateRequirements(Player) - Static method in class dev.jorel.commandapi.CommandAPI

Updates the requirements required for a given player to execute a command.

usageDescription() - Method in record class dev.jorel.commandapi.RegisteredCommand

Returns the value of the usageDescription record component.

useLatestNMSVersion(boolean) - Method in class dev.jorel.commandapi.CommandAPIConfig

Sets whether the CommandAPI should run the latest available version of NMS support, regardless of Minecraft version.

usePluginNamespace() - Method in class dev.jorel.commandapi.CommandAPIConfig

Sets whether the CommandAPI should use the plugin's name as the default namespace

usePreview(boolean) - Method in interface dev.jorel.commandapi.arguments.Previewable

Whether this argument should use the preview result as the argument value for execution.

USING_MOJANG_MAPPINGS - Static variable in class dev.jorel.commandapi.SafeVarHandle

UUID - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

The UUIDArgument

V

valueOf(String) - Static method in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.jorel.commandapi.arguments.LocationType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.jorel.commandapi.arguments.SuggestionProviders

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.jorel.commandapi.executors.ExecutorType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class dev.jorel.commandapi.wrappers.MathOperation

Returns the enum constant of this class with the specified name.

values() - Static method in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.jorel.commandapi.arguments.LocationType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.jorel.commandapi.arguments.SuggestionProviders

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.jorel.commandapi.executors.ExecutorType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class dev.jorel.commandapi.wrappers.MathOperation

Returns an array containing the constants of this enum class, in the order they are declared.

verboseOutput(boolean) - Method in class dev.jorel.commandapi.CommandAPIConfig

Sets verbose output logging for the CommandAPI if true.

W

warning(String) - Method in interface dev.jorel.commandapi.CommandAPILogger

withAliases(String...) - Method in class dev.jorel.commandapi.ExecutableCommand

Adds an array of aliases to the current command builder

withArguments(Argument...) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Appends the argument(s) to the current command builder

withArguments(List<Argument>) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Appends the arguments to the current command builder

withFullDescription(String) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the full description for this command.

withHelp(String, String) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the short and full description for this command.

withOptionalArguments(Argument...) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Appends the optional arguments to the current command builder.

withOptionalArguments(List<Argument>) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Appends the optional arguments to the current command builder.

withoutPermission(CommandPermission) - Method in class dev.jorel.commandapi.ExecutableCommand

Applies a permission to the current command builder

withoutPermission(String) - Method in class dev.jorel.commandapi.ExecutableCommand

Applies a permission to the current command builder

withPermission(CommandPermission) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Assigns the given permission as a requirement to execute this command.

withPermission(CommandPermission) - Method in class dev.jorel.commandapi.ExecutableCommand

Applies a permission to the current command builder

withPermission(String) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Assigns the given permission as a requirement to execute this command.

withPermission(String) - Method in class dev.jorel.commandapi.ExecutableCommand

Applies a permission to the current command builder

withPreview(PreviewableFunction<A>) - Method in interface dev.jorel.commandapi.arguments.Previewable

Sets the PreviewableFunction for this argument.

withRequirement(Predicate<CommandSender>) - Method in class dev.jorel.commandapi.arguments.AbstractArgument

Adds a requirement that has to be satisfied to use this argument.

withRequirement(Predicate<CommandSender>) - Method in class dev.jorel.commandapi.ExecutableCommand

Adds a requirement that has to be satisfied to use this command.

withShortDescription(String) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the short description for this command.

withSubcommand(Impl) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Adds a subcommand to this command builder

withSubcommands(Impl...) - Method in class dev.jorel.commandapi.AbstractCommandAPICommand

Adds subcommands to this command builder

withUsage(String...) - Method in class dev.jorel.commandapi.ExecutableCommand

Sets the full usage for this command.

wrapCommandSender(CommandSender) - Method in interface dev.jorel.commandapi.CommandAPIPlatform

Wraps a CommandSender in an AbstractCommandSender class, the inverse operation to AbstractCommandSender.getSource()

WrapperCommandSyntaxException - Exception Class in dev.jorel.commandapi.exceptions

A wrapper for the CommandSyntaxException so other developers don't have to import Mojang's brigadier

WrapperCommandSyntaxException(CommandSyntaxException) - Constructor for exception class dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException

Creates a WrapperCommandSyntaxException

writeDispatcherToFile() - Method in class dev.jorel.commandapi.CommandAPIHandler

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form