Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ADD - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation
-
Addition of two values (+=)
- addAttachment(Plugin) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Adds a new empty PermissionAttachment to this object
- addAttachment(Plugin, int) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Temporarily adds a new empty PermissionAttachment to this object
- addAttachment(Plugin, String, boolean) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Adds a new PermissionAttachment with a single permission by name and value
- addAttachment(Plugin, String, boolean, int) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Temporarily adds a new PermissionAttachment with a single permission by name and value
- addNormalExecutor(S) - Method in class dev.jorel.commandapi.CustomCommandExecutor
- addResultingExecutor(S) - Method in class dev.jorel.commandapi.CustomCommandExecutor
- addToHelpMap(Map<String, HelpTopic>) - Method in interface dev.jorel.commandapi.nms.NMS
- ADVANCEMENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The AdvancementArgument
- AdvancementArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Advancement object
- AdvancementArgument(String) - Constructor for class dev.jorel.commandapi.arguments.AdvancementArgument
-
Constructs an AdvancementArgument with a given node name
- 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)
- AdventureChatArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents chat with entity selectors
- AdventureChatArgument(String) - Constructor for class dev.jorel.commandapi.arguments.AdventureChatArgument
-
Constructs a Chat argument with a given node name.
- AdventureChatComponentArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents raw JSON text
- AdventureChatComponentArgument(String) - Constructor for class dev.jorel.commandapi.arguments.AdventureChatComponentArgument
-
Constructs a ChatComponnent argument with a given node name.
- aliases() - Method in record class dev.jorel.commandapi.RegisteredCommand
-
Returns the value of the
aliasesrecord component. - ALL - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType
-
An executor where the CommandSender is any CommandSender
- allowDuplicates(boolean) - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder
-
Whether duplicates are allowed in the provided list.
- ANGLE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The AngleArgument
- AngleArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a yaw angle, measured in degrees with float number.
- AngleArgument(String) - Constructor for class dev.jorel.commandapi.arguments.AngleArgument
-
Constructs an AngleArgument with a given node name
- AngleArgumentException - Exception in dev.jorel.commandapi.exceptions
-
An exception that occurs when trying to use the AngleArgument on Minecraft version < 1.16.2
- AngleArgumentException() - Constructor for exception dev.jorel.commandapi.exceptions.AngleArgumentException
-
Creates a AngleArgument
- 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(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
- apply(CustomArgument.CustomArgumentInfo<B>) - Method in interface dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfoParser
-
Applies a CustomArgumentInfo input to this custom argument parser
- argsAsStr() - Method in record class dev.jorel.commandapi.RegisteredCommand
-
Returns the value of the
argsAsStrrecord component. - Argument<T> - Class in dev.jorel.commandapi.arguments
-
The core abstract class for Command API arguments
- Argument(String, ArgumentType<?>) - Constructor for class dev.jorel.commandapi.arguments.Argument
-
Constructs an argument with a given NMS/brigadier type.
- ArgumentSuggestions - Interface in dev.jorel.commandapi.arguments
-
This class represents suggestions for an argument.
- ArgumentTree - Class in dev.jorel.commandapi
-
This is a base class for arguments, allowing them to behave as tree nodes in a
CommandTree - ArgumentTree() - Constructor for class dev.jorel.commandapi.ArgumentTree
-
Instantiates an
ArgumentTree. - ArgumentTree(Argument<?>) - Constructor for class dev.jorel.commandapi.ArgumentTree
-
Instantiates an
ArgumentTreewith an underlying argument. - arrayOf(Tooltip<S>...) - Static method in class dev.jorel.commandapi.Tooltip
-
Constructs a
Tooltip<S>[] from an array ofTooltip<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
- AxisArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents x, y and z axes as an EnumSet of Axis
- AxisArgument(String) - Constructor for class dev.jorel.commandapi.arguments.AxisArgument
-
Constructs an AxisArgument with a given node name.
B
- BadLiteralException - Exception in dev.jorel.commandapi.exceptions
-
An exception caused when a literal is null or empty
- BadLiteralException(boolean) - Constructor for exception dev.jorel.commandapi.exceptions.BadLiteralException
-
Creates a BadLiteralException
- BIOME - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The BiomeArgument
- BiomeArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Biome object
- BiomeArgument(String) - Constructor for class dev.jorel.commandapi.arguments.BiomeArgument
-
Constructs a BiomeArgument with a given node name.
- BiomeArgumentException - Exception in dev.jorel.commandapi.exceptions
-
An exception caused when using the BiomeArgument on Minecraft version < 1.16
- BiomeArgumentException() - Constructor for exception dev.jorel.commandapi.exceptions.BiomeArgumentException
-
Creates a BiomeArgumentException
- 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
- BlockPredicateArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a
Predicate<Block> - BlockPredicateArgument(String) - Constructor for class dev.jorel.commandapi.arguments.BlockPredicateArgument
-
Constructs a BlockPredicateArgument with a given node name.
- BLOCKSTATE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The BlockStateArgument
- BlockStateArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit BlockData object
- BlockStateArgument(String) - Constructor for class dev.jorel.commandapi.arguments.BlockStateArgument
-
Constructs a BlockStateArgument with a given node name.
- BooleanArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents primitive Java booleans
- BooleanArgument(String) - Constructor for class dev.jorel.commandapi.arguments.BooleanArgument
-
Constructs a Boolean argument with a given node name
- 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() - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder.ListArgumentBuilderSuggests.ListArgumentBuilderFinished
-
Builds this list argument.
- 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
- canUseChatPreview() - Method in interface dev.jorel.commandapi.nms.NMS
- 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)
- 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.
- CHATCOLOR - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The ChatColorArgument
- 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 ChatComponnent argument with a given node name.
- clearExecutors() - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Clear all executors from the current command builder
- 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
- CommandAPICommand - Class in dev.jorel.commandapi
-
A builder used to create commands to be registered by the CommandAPI.
- CommandAPICommand(CommandMetaData) - Constructor for class dev.jorel.commandapi.CommandAPICommand
-
Creates a new Command builder
- CommandAPICommand(String) - Constructor for class dev.jorel.commandapi.CommandAPICommand
-
Creates a new command builder
- CommandAPIConfig - 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
- CommandAPIHandler<CommandSourceStack> - Class in dev.jorel.commandapi
-
Handles the main backend of the CommandAPI.
- CommandAPIVersionHandler - Interface in dev.jorel.commandapi
-
This file handles the NMS version to be loaded.
- CommandBlockCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for a BlockCommandSender
- CommandBlockResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for a BlockCommandSender
- CommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for a CommandSender
- commandName() - Method in record class dev.jorel.commandapi.RegisteredCommand
-
Returns the value of the
commandNamerecord component. - CommandPermission - Class in dev.jorel.commandapi
-
A representation of permission nodes for commands.
- CommandTree - Class in dev.jorel.commandapi
-
This is the root node for creating a command as a tree
- CommandTree(String) - Constructor for class dev.jorel.commandapi.CommandTree
-
Creates a main root node for a command tree with a given command name
- compatibleVersions() - Method in interface dev.jorel.commandapi.nms.NMS
-
A String array of Minecraft versions that this NMS implementation is compatible with.
- 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. - ConflictingPermissionsException - Exception in dev.jorel.commandapi.exceptions
-
An exception caused when the same permission is registered to a command
- ConflictingPermissionsException(String, CommandPermission, CommandPermission) - Constructor for exception 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
- ConsoleCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for a ConsoleCommandSender
- ConsoleResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for a ConsoleCommandSender
- convert(ParticleData<?>) - Method in interface dev.jorel.commandapi.nms.NMS
- convert(String) - Static method in class dev.jorel.commandapi.Converter
-
Convert the provided command name into a CommandAPI-compatible command
- convert(String, List<Argument<?>>) - Static method in class dev.jorel.commandapi.Converter
-
Convert the provided command name with its list of arguments into a CommandAPI-compatible command
- convert(ItemStack) - Method in interface dev.jorel.commandapi.nms.NMS
- convert(JavaPlugin) - Static method in class dev.jorel.commandapi.Converter
-
Convert all commands stated in Plugin's plugin.yml file into CommandAPI-compatible commands
- convert(JavaPlugin, String) - Static method in class dev.jorel.commandapi.Converter
-
Convert a command stated in Plugin's plugin.yml file into CommandAPI-compatible commands
- convert(JavaPlugin, String, Argument<?>...) - Static method in class dev.jorel.commandapi.Converter
-
Convert a command stated in Plugin's plugin.yml file into CommandAPI-compatible commands
- convert(JavaPlugin, String, List<Argument<?>>) - Static method in class dev.jorel.commandapi.Converter
-
Convert a command stated in Plugin's plugin.yml file into CommandAPI-compatible commands
- convert(PotionEffectType) - Method in interface dev.jorel.commandapi.nms.NMS
- convert(Sound) - Method in interface dev.jorel.commandapi.nms.NMS
- Converter - Class in dev.jorel.commandapi
-
'Simple' conversion of Plugin commands
- createDispatcherFile(File, CommandDispatcher<CommandListenerWrapper>) - Method in interface dev.jorel.commandapi.nms.NMS
-
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
currentArgrecord component. - currentInput() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
currentInputrecord component. - currentInput() - Method in record class dev.jorel.commandapi.SuggestionInfo
-
Returns the value of the
currentInputrecord component. - CUSTOM - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The CustomArgument
- 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(String, CustomArgument.CustomArgumentInfoParser<T, String>) - Constructor for class dev.jorel.commandapi.arguments.CustomArgument
-
Deprecated, for removal: This API element is subject to removal in a future version.
- CustomArgument(String, CustomArgument.CustomArgumentInfoParser<T, String>, boolean) - Constructor for class dev.jorel.commandapi.arguments.CustomArgument
-
Deprecated, for removal: This API element is subject to removal in a future version.Use
CustomArgument(Argument, CustomArgumentInfoParser)withTextArgumentorNamespacedKeyArgumentinstead - CustomArgument.CustomArgumentException - Exception 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
- CustomArgumentException(CustomArgument.MessageBuilder) - Constructor for exception dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Constructs a CustomArgumentException with a given error message
- CustomArgumentException(String) - Constructor for exception dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Constructs a CustomArgumentException with a given error message
- CustomArgumentInfo(CommandSender, Object[], String, B) - Constructor for record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Creates an instance of a
CustomArgumentInforecord class. - CustomCommandExecutor<T extends org.bukkit.command.CommandSender> - Class in dev.jorel.commandapi
-
CustomCommandExecutor is the main executor implementation for command executors.
- CustomCommandExecutor() - Constructor for class dev.jorel.commandapi.CustomCommandExecutor
D
- data() - Method in record class dev.jorel.commandapi.wrappers.ParticleData
-
Returns the value of the
datarecord component. - 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.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.nms - package dev.jorel.commandapi.nms
-
Classes that access the NMS framework
- dev.jorel.commandapi.wrappers - package dev.jorel.commandapi.wrappers
-
Classes that are wrappers for various vanilla-related command features
- 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 (/=)
- DoubleArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents primitive Java doubles
- DoubleArgument(String) - Constructor for class dev.jorel.commandapi.arguments.DoubleArgument
-
A double argument
- DoubleArgument(String, double) - Constructor for class dev.jorel.commandapi.arguments.DoubleArgument
-
A double argument with a minimum value
- DoubleArgument(String, double, double) - Constructor for class dev.jorel.commandapi.arguments.DoubleArgument
-
A double argument with a minimum and maximum 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 in dev.jorel.commandapi.exceptions
-
An exception caused when a command has no executor
- EmptyExecutorException() - Constructor for exception dev.jorel.commandapi.exceptions.EmptyExecutorException
-
Creates an EmptyExecutorException
- ENCHANTMENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The EnchantmentArgument
- EnchantmentArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Enchantment object
- EnchantmentArgument(String) - Constructor for class dev.jorel.commandapi.arguments.EnchantmentArgument
-
An Enchantment argument.
- 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
- EntityCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for an Entity
- EntityResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for an Entity
- EntitySelector - Enum Class in dev.jorel.commandapi.arguments
-
An enum that represents single entities or players, as well as collections of entities or players
- EntitySelectorArgument<T> - Class in dev.jorel.commandapi.arguments
-
An argument that represents a selection of entities
- EntitySelectorArgument(String) - Constructor for class dev.jorel.commandapi.arguments.EntitySelectorArgument
-
An EntityType argument.
- EntitySelectorArgument(String, EntitySelector) - Constructor for class dev.jorel.commandapi.arguments.EntitySelectorArgument
-
An EntityType argument.
- EntityTypeArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit EntityType object
- EntityTypeArgument(String) - Constructor for class dev.jorel.commandapi.arguments.EntityTypeArgument
-
An EntityType argument.
- ENVIRONMENT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The EnvironmentArgument
- EnvironmentArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Environment object
- EnvironmentArgument(String) - Constructor for class dev.jorel.commandapi.arguments.EnvironmentArgument
-
An Environment argument.
- EnvironmentArgumentException - Exception in dev.jorel.commandapi.exceptions
-
An exception caused when using the EnvironmentArgument on Minecraft version 1.13
- EnvironmentArgumentException() - Constructor for exception dev.jorel.commandapi.exceptions.EnvironmentArgumentException
-
Creates an EnvironmentArgumentException
- 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.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.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 record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jorel.commandapi.wrappers.ParticleData
-
Indicates whether some other object is "equal to" this one.
- execute(CommandSender, Object[]) - Method in class dev.jorel.commandapi.CustomCommandExecutor
- executes(CommandExecutor, ExecutorType...) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executes(ResultingCommandExecutor, ExecutorType...) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesCommandBlock(CommandBlockCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesCommandBlock(CommandBlockResultingCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesConsole(ConsoleCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesConsole(ConsoleResultingCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesEntity(EntityCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesEntity(EntityResultingCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesNative(NativeCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesNative(NativeResultingCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesPlayer(PlayerCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesPlayer(PlayerResultingCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesProxy(ProxyCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executesProxy(ProxyResultingCommandExecutor) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Adds an executor to the current command builder
- executeWith(CommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.IExecutorNormal
-
Executes the command executor with the provided command sender and the provided arguments.
- executeWith(CommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.IExecutorResulting
-
Executes the command executor with the provided command sender and the provided arguments.
- executeWith(CommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.IExecutorTyped
-
Executes the command executor with the provided command sender and the provided arguments.
- executor - Variable in class dev.jorel.commandapi.arguments.AdvancementArgument
-
The CustomCommandExecutor for this executable implementation
- ExecutorType - Enum Class in dev.jorel.commandapi.executors
-
An enum representing the type of an executor
F
- fail(String) - Static method in class dev.jorel.commandapi.CommandAPI
-
Forces a command to return a success value of 0
- FLOAT_RANGE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The FloatRangeArgument
- FloatArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents primitive Java floats
- FloatArgument(String) - Constructor for class dev.jorel.commandapi.arguments.FloatArgument
-
A float argument
- FloatArgument(String, float) - Constructor for class dev.jorel.commandapi.arguments.FloatArgument
-
A float argument with a minimum value
- FloatArgument(String, float, float) - Constructor for class dev.jorel.commandapi.arguments.FloatArgument
-
A float argument with a minimum and maximum value
- 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
- FloatRangeArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a range of float values
- FloatRangeArgument(String) - Constructor for class dev.jorel.commandapi.arguments.FloatRangeArgument
-
A FloatRange argument that represents a range of floating-point values
- 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
- fromArgument(Argument) - Static method in class dev.jorel.commandapi.Brigadier
-
Constructs a RequiredArgumentBuilder from a given argument
- fromArgument(List<Argument>, String) - Static method in class dev.jorel.commandapi.Brigadier
-
Constructs a RequiredArgumentBuilder from a given argument within a command declaration.
- fromCommand(CommandAPICommand) - 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.
- fromLiteralArgument(LiteralArgument) - 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.
- fromSimpleFunctionWrapper(SimpleFunctionWrapper, Object, Function<Entity, Object>) - Static method in class dev.jorel.commandapi.wrappers.FunctionWrapper
-
Converts a SimpleFunctionWrapper into a FunctionWrapper
- 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.
- fullDescription() - Method in record class dev.jorel.commandapi.RegisteredCommand
-
Returns the value of the
fullDescriptionrecord component. - fullInput() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo
-
Returns the value of the
fullInputrecord 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
- FunctionArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents Minecraft functions and tags
- FunctionArgument(String) - Constructor for class dev.jorel.commandapi.arguments.FunctionArgument
-
A Minecraft function.
- FunctionWrapper - Class in dev.jorel.commandapi.wrappers
-
A wrapper class for Minecraft 1.12's functions
- FunctionWrapper(NamespacedKey, ToIntFunction, Object, Function<Entity, Object>, String[]) - Constructor for class dev.jorel.commandapi.wrappers.FunctionWrapper
-
Creates a FunctionWrapper
G
- generateHelpTopic(String, String, String, String) - Method in interface dev.jorel.commandapi.nms.NMS
- generatePreview(PreviewInfo<T>) - Method in interface dev.jorel.commandapi.wrappers.PreviewableFunction
- getAdvancement(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getAdventureChat(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getAdventureChatComponent(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getAliases() - Method in class dev.jorel.commandapi.CommandAPICommand
-
Returns an array of aliases that can be used to run this command
- getAngle(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getArgumentPermission() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns the permission required to run this command
- getArguments() - Method in class dev.jorel.commandapi.CommandAPICommand
-
Returns the list of arguments that this command has
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.AdventureChatArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.AdventureChatComponentArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.AngleArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns the argument type for this argument.
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.AxisArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.BiomeArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.BlockPredicateArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.BlockStateArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.BooleanArgument
- 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.DoubleArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.EnchantmentArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.EntitySelectorArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.EntityTypeArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.EnvironmentArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.FloatArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.FloatRangeArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.FunctionArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.GreedyStringArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.IntegerArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.IntegerRangeArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ItemStackArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ItemStackPredicateArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ListArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.LiteralArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.Location2DArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.LocationArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.LongArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.LootTableArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.MathOperationArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.MultiLiteralArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.NamespacedKeyArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.NBTCompoundArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ObjectiveArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ObjectiveCriteriaArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.OfflinePlayerArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ParticleArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.PlayerArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.PotionEffectArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.RotationArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ScoreboardSlotArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.ScoreHolderArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.SoundArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.StringArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.TeamArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.TextArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.TimeArgument
- getArgumentType() - Method in class dev.jorel.commandapi.arguments.UUIDArgument
- getAxis(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getBiome(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getBlockPredicate(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getBlockState(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getBlockY() - Method in class dev.jorel.commandapi.wrappers.Location2D
- getBrigadierDispatcher() - Method in interface dev.jorel.commandapi.nms.NMS
-
Returns the Brigadier CommandDispatcher from the NMS CommandDispatcher
- getBrigadierSourceFromCommandSender(CommandSender) - Static method in class dev.jorel.commandapi.Brigadier
-
Gets a Brigadier source object (e.g.
- getBukkitCommandSenderFromContext(CommandContext) - Static method in class dev.jorel.commandapi.Brigadier
-
Returns a Bukkit CommandSender from a Brigadier CommandContext
- getCallee() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Returns the CommandSender which is being used to call the command
- getCaller() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Returns the CommandSender which triggered this proxied command
- getCause() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- getChat(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getChatColor(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getChatComponent(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getCLWFromCommandSender(CommandSender) - Method in interface dev.jorel.commandapi.nms.NMS
-
Converts a CommandSender into a CLW
- getCommandDispatcher() - Static method in class dev.jorel.commandapi.Brigadier
-
Returns the Brigadier CommandDispatcher tree that is used internally by the CommandAPI.
- getCommandMap() - Method in class dev.jorel.commandapi.PaperImplementations
- getCommands() - Method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Returns an array of commands that will be executed by this FunctionWrapper
- getCommandSenderFromCSS(CommandListenerWrapper) - Method in interface dev.jorel.commandapi.nms.NMS
-
Returns a CommandSender of a given CommandListenerWrapper object
- getCommandsToConvert() - Method in class dev.jorel.commandapi.InternalConfig
- getConfiguration() - Static method in class dev.jorel.commandapi.CommandAPI
-
Returns the internal configuration used to manage the CommandAPI
- getContext() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns some contextual information about where the error occurred.
- getCursor() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns the cursor position.
- getCustomNMS() - Method in class dev.jorel.commandapi.InternalConfig
- getDimension(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getDispatcherFile() - Method in class dev.jorel.commandapi.InternalConfig
- getDisplaySlot() - Method in class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Gets the display slot of this scoreboard slot.
- getEffectivePermissions() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Gets a set containing all of the permissions currently in effect by this object
- getEnchantment(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getEntityNames(Object) - Method in class dev.jorel.commandapi.arguments.Argument
-
Gets a list of entity names for the current provided argument.
- getEntityNames(Object) - Method in class dev.jorel.commandapi.arguments.EntitySelectorArgument
- getEntitySelector() - Method in class dev.jorel.commandapi.arguments.EntitySelectorArgument
-
Returns the entity selector for this argument
- getEntitySelector(CommandContext<CommandListenerWrapper>, String, EntitySelector) - Method in interface dev.jorel.commandapi.nms.NMS
- getEntityType(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getException() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns the wrapped CommandSyntaxException
- getExecutor() - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Returns the executors that this command has
- getField(Class<?>, String) - 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.
- getFloatRange(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getFunction(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getFunction(NamespacedKey) - Method in interface dev.jorel.commandapi.nms.NMS
- getFunction(NamespacedKey) - Static method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Returns a SimpleFunctionWrapper representation of the Minecraft function for the provided NamespacedKey
- getFunctions() - Method in interface dev.jorel.commandapi.nms.NMS
- getFunctions() - Static method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Returns a set of all functions that the server has registered
- getIncludedSuggestions() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns an optional function which produces an array of suggestions which should be added to existing suggestions.
- getInput() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns the input that caused the CommandSyntaxException.
- getInstance() - Static method in class dev.jorel.commandapi.CommandAPIHandler
-
Returns the Singleton instance of the CommandAPI's internal handler
- getIntRange(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getItemStack(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getItemStackPredicate(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getKey() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Return the namespaced identifier for this object.
- getKey() - Method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Returns the NamespacedKey that uniquely represents this object
- getLiteral() - Method in class dev.jorel.commandapi.arguments.LiteralArgument
-
Returns the literal string represented by this argument
- getLiterals() - Method in class dev.jorel.commandapi.arguments.MultiLiteralArgument
-
Returns the literals that are present in this argument
- getLocalizedMessage() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- getLocation() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Returns the location that this native command sender represents
- getLocation2DBlock(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getLocation2DPrecise(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getLocationBlock(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getLocationPrecise(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getLocationType() - Method in class dev.jorel.commandapi.arguments.Location2DArgument
-
Returns whether this argument is
LocationType.BLOCK_POSITIONorLocationType.PRECISE_POSITION - getLocationType() - Method in class dev.jorel.commandapi.arguments.LocationArgument
-
Returns whether this argument is
LocationType.BLOCK_POSITIONorLocationType.PRECISE_POSITION - getLogger() - Static method in class dev.jorel.commandapi.CommandAPI
-
Returns the CommandAPI's logger
- getLootTable(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- 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.
- getMathOperation(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getMessage() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns the message together with the position it occurred on and some context.
- getMinecraftKey(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getMissingImplementationMessage() - Method in class dev.jorel.commandapi.InternalConfig
- getName() - Method in class dev.jorel.commandapi.CommandAPICommand
-
Returns the name of this command
- getName() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Gets the name of this command sender
- getNBTCompound(CommandContext<CommandListenerWrapper>, String, Function<Object, NBTContainer>) - Method in interface dev.jorel.commandapi.nms.NMS
- getNBTContainerClass() - Method in class dev.jorel.commandapi.InternalConfig
- getNBTContainerConstructor() - Method in class dev.jorel.commandapi.InternalConfig
- getNMS() - Method in class dev.jorel.commandapi.CommandAPIHandler
-
Returns an instance of NMS
- getNMS(String) - Static method in interface dev.jorel.commandapi.CommandAPIVersionHandler
-
Returns an instance of the version's implementation of NMS.
- getNodeName() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns the name of this argument's node
- getNormalExecutors() - Method in class dev.jorel.commandapi.CustomCommandExecutor
- 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.
- getObjective(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getObjectiveCriteria(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getOfflinePlayer(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getOverriddenSuggestions() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns an optional function that maps the command sender to an IStringTooltip array of suggestions for the current command
- getPaper() - Method in class dev.jorel.commandapi.CommandAPIHandler
-
Returns an instance of PaperImplementations
- getParticle(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getPermission() - Method in class dev.jorel.commandapi.CommandAPICommand
-
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.
- getPlayer(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getPluginsToConvert() - Method in class dev.jorel.commandapi.InternalConfig
- getPotionEffect(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getPreview() - Method in class dev.jorel.commandapi.arguments.AdventureChatArgument
- getPreview() - Method in class dev.jorel.commandapi.arguments.ChatArgument
- getPreview() - Method in interface dev.jorel.commandapi.arguments.IPreviewable
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AdventureChatArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AdventureChatComponentArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AngleArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns the primitive type of the current Argument.
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.AxisArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.BiomeArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.BlockPredicateArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.BlockStateArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.BooleanArgument
- 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.DoubleArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.EnchantmentArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.EntitySelectorArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.EntityTypeArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.EnvironmentArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.FloatArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.FloatRangeArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.FunctionArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.GreedyStringArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.IntegerArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.IntegerRangeArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ItemStackArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ItemStackPredicateArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ListArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.LiteralArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.Location2DArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.LocationArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.LongArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.LootTableArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.MathOperationArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.MultiLiteralArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.NamespacedKeyArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.NBTCompoundArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ObjectiveArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ObjectiveCriteriaArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.OfflinePlayerArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ParticleArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.PlayerArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.PotionEffectArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.RotationArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ScoreboardSlotArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.ScoreHolderArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.SoundArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.StringArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.TeamArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.TextArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.TimeArgument
- getPrimitiveType() - Method in class dev.jorel.commandapi.arguments.UUIDArgument
- getRawArgumentInput(CommandContext<CommandSourceStack>, 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 dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns the raw message, not including positional information
- getRawType() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns the NMS or brigadier type for this argument.
- getRecipe(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getRegisteredCommands() - Static method in class dev.jorel.commandapi.CommandAPI
- getRequirements() - Method in class dev.jorel.commandapi.arguments.Argument
-
Returns the requirements required to run this command
- getRequirements() - Method in class dev.jorel.commandapi.CommandAPICommand
-
Returns the requirements that must be satisfied to run this command
- getResult() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Get the result of this recipe.
- getResultingExecutors() - Method in class dev.jorel.commandapi.CustomCommandExecutor
- getRootNode() - Static method in class dev.jorel.commandapi.Brigadier
-
Returns the root node of the current CommandDispatcher.
- getRotation(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getScoreboardSlot(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getScoreHolderMultiple(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getScoreHolderSingle(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getSenderForCommand(CommandContext<CommandListenerWrapper>, boolean) - Method in interface dev.jorel.commandapi.nms.NMS
-
Retrieves a CommandSender, given some CommandContext.
- getServer() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Returns the server instance that this command is running on
- getSimpleCommandMap() - Method in interface dev.jorel.commandapi.nms.NMS
-
Returns the Server's internal (OBC) CommandMap
- getSound(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getStackTrace() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- getSubcommands() - Method in class dev.jorel.commandapi.CommandAPICommand
-
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
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.BiomeArgument
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.EntityTypeArgument
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.FunctionArgument
- getSuggestionProvider() - Method in interface dev.jorel.commandapi.arguments.ICustomProvidedArgument
-
Returns the suggestion provider that this argument is populated with
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.LootTableArgument
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- getSuggestionProvider() - Method in class dev.jorel.commandapi.arguments.SoundArgument
- getSuggestionProvider(SuggestionProviders) - Method in interface dev.jorel.commandapi.nms.NMS
-
Retrieve a specific NMS implemented SuggestionProvider
- getTag(NamespacedKey) - Method in interface dev.jorel.commandapi.nms.NMS
- getTag(NamespacedKey) - Static method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Returns a SimpleFunctionWrapper[], which is an array of all of the functions that this tag contains
- getTags() - Method in interface dev.jorel.commandapi.nms.NMS
- getTags() - Static method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Returns a set of all tags that the server has registered
- getTeam(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getTeamColor() - Method in class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Gets the team color of this scoreboard slot.
- getTime(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- 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
- getType() - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Returns the type of the exception.
- getType() - Method in interface dev.jorel.commandapi.executors.CommandBlockCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.CommandBlockResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.CommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.ConsoleCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.ConsoleResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.EntityCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.EntityResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.IExecutorTyped
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.NativeCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.NativeResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.PlayerCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.PlayerResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.ProxyCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.ProxyResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- getType() - Method in interface dev.jorel.commandapi.executors.ResultingCommandExecutor
-
Returns the type of the sender of the current executor.
- 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.
- getUUID(CommandContext<CommandListenerWrapper>, String) - Method in interface dev.jorel.commandapi.nms.NMS
- getWorld() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Returns the world that this native command sender represents
- getWorldForCSS(CommandListenerWrapper) - Method in interface dev.jorel.commandapi.nms.NMS
- getY() - Method in class dev.jorel.commandapi.wrappers.Location2D
- getYaw() - Method in class dev.jorel.commandapi.wrappers.Rotation
-
Gets the yaw of this location, measured in degrees.
- GreedyArgumentException - Exception in dev.jorel.commandapi.exceptions
-
An exception caused when a greedy argument is not declared at the end of a List
- GreedyArgumentException(Argument<?>[]) - Constructor for exception dev.jorel.commandapi.exceptions.GreedyArgumentException
-
Creates a GreedyArgumentException
- GreedyStringArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents arbitrary strings
- GreedyStringArgument(String) - Constructor for class dev.jorel.commandapi.arguments.GreedyStringArgument
-
A string argument for a string of any length
H
- hasAnyExecutors() - Method in class dev.jorel.commandapi.CustomCommandExecutor
- 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.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.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 record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jorel.commandapi.wrappers.ParticleData
-
Returns a hash code value for this object.
- hasPermission(String) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Gets the value of the specified permission, if set.
- hasPermission(Permission) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Gets the value of the specified permission, if set.
- hasSilentLogs() - Method in class dev.jorel.commandapi.InternalConfig
- hasTeamColor() - Method in class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Returns whether this scoreboard slot has a team color.
- hasVerboseOutput() - Method in class dev.jorel.commandapi.InternalConfig
- hookChatPreview(Plugin, Player) - Method in interface dev.jorel.commandapi.nms.NMS
-
Hooks into the chat previewing system for 1.19+
I
- ICustomProvidedArgument - Interface in dev.jorel.commandapi.arguments
-
An interface allowing arguments to have built-in suggestion providers based on Minecraft namespaced keys
- IExecutorNormal<T extends org.bukkit.command.CommandSender> - Interface in dev.jorel.commandapi.executors
-
The interface for normal command executors
- IExecutorResulting<T extends org.bukkit.command.CommandSender> - Interface in dev.jorel.commandapi.executors
-
The interface for resulting command executors
- IExecutorTyped - 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
- IGreedyArgument - Interface in dev.jorel.commandapi.arguments
-
An interface indicating that an argument consumes all available characters
- includeSafeSuggestions(SafeSuggestions<S>) - Method in class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Includes the suggestions provided with the existing suggestions for this argument.
- includeSuggestions(ArgumentSuggestions) - Method in class dev.jorel.commandapi.arguments.Argument
-
Include suggestions to add to the list of default suggestions represented by this argument.
- includeSuggestions(Function<SuggestionInfo, String[]>) - Method in class dev.jorel.commandapi.arguments.Argument
-
Deprecated, for removal: This API element is subject to removal in a future version.use
Argument.includeSuggestions(ArgumentSuggestions)instead - includeSuggestionsT(Function<SuggestionInfo, IStringTooltip[]>) - Method in class dev.jorel.commandapi.arguments.Argument
-
Deprecated, for removal: This API element is subject to removal in a future version.use
Argument.includeSuggestions(ArgumentSuggestions)instead - includeWithSafeSuggestions(Function<SuggestionInfo, S[]>) - Method in class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Deprecated, for removal: This API element is subject to removal in a future version.
- includeWithSafeSuggestionsT(Function<SuggestionInfo, Tooltip<S>[]>) - Method in class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Deprecated, for removal: This API element is subject to removal in a future version.
- initCause(Throwable) - Method in exception 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.CustomArgument.CustomArgumentInfo
-
Returns the value of the
inputrecord component. - input() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo
-
Returns the value of the
inputrecord component. - INT_RANGE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The IntegerRangeArgument
- IntegerArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents primitive Java ints
- IntegerArgument(String) - Constructor for class dev.jorel.commandapi.arguments.IntegerArgument
-
An integer argument
- IntegerArgument(String, int) - Constructor for class dev.jorel.commandapi.arguments.IntegerArgument
-
An integer argument with a minimum value
- IntegerArgument(String, int, int) - Constructor for class dev.jorel.commandapi.arguments.IntegerArgument
-
An integer argument with a minimum and maximum value
- 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
- IntegerRangeArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a range of integer values
- IntegerRangeArgument(String) - Constructor for class dev.jorel.commandapi.arguments.IntegerRangeArgument
-
An IntegerRange argument.
- 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(boolean) - Constructor for class dev.jorel.commandapi.InternalConfig
-
Deprecated, for removal: This API element is subject to removal in a future version.
- InternalConfig(CommandAPIConfig) - Constructor for class dev.jorel.commandapi.InternalConfig
-
Creates an
InternalConfigfrom aCommandAPIConfig - InvalidCommandNameException - Exception in dev.jorel.commandapi.exceptions
-
An exception that occurs when trying to register a command with an invalid name
- InvalidCommandNameException(String) - Constructor for exception dev.jorel.commandapi.exceptions.InvalidCommandNameException
-
Creates an InvalidCommandNameException
- InvalidRangeException - Exception 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 dev.jorel.commandapi.exceptions.InvalidRangeException
-
Creates an InvalidRangeException
- IPreviewable<T extends Argument<?>,
A> - Interface in dev.jorel.commandapi.arguments -
An interface representing that the argument can be previewed using Minecraft's chat preview feature.
- isConverted() - Method in class dev.jorel.commandapi.CommandAPICommand
-
Returns whether this command is an automatically converted command
- isForceNative() - Method in class dev.jorel.commandapi.CustomCommandExecutor
- 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 class dev.jorel.commandapi.arguments.AdventureChatArgument
- isLegacy() - Method in class dev.jorel.commandapi.arguments.ChatArgument
- isLegacy() - Method in interface dev.jorel.commandapi.arguments.IPreviewable
- isListed() - Method in class dev.jorel.commandapi.arguments.Argument
-
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.
- isOp() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Checks if this object is a server operator
- isPermissionSet(String) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Checks if this object contains an override for the specified permission, by fully qualified name
- isPermissionSet(Permission) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Checks if this object contains an override for the specified Permission
- isPresent() - Method in class dev.jorel.commandapi.PaperImplementations
- isSingle() - Method in class dev.jorel.commandapi.arguments.ScoreHolderArgument
-
Returns whether this argument represents a single score holder or a collection of score holders
- IStringTooltip - Interface in dev.jorel.commandapi
-
A string-based tooltip interface that includes a string suggestion and a string tooltip text to display when hovering over the suggestion
- isVanillaCommandWrapper(Command) - Method in interface dev.jorel.commandapi.nms.NMS
-
Checks if a Command is an instance of the OBC VanillaCommandWrapper
- 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
- ItemStackArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit ItemStack object
- ItemStackArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ItemStackArgument
-
An ItemStack argument.
- ItemStackPredicateArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a
Predicate<ItemStack> - ItemStackPredicateArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ItemStackPredicateArgument
-
A ItemStack Predicate argument.
K
- key() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns the value of the
keyrecord component.
L
- LIST - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The ListArgument
- ListArgument<T> - Class in dev.jorel.commandapi.arguments
-
An argument that accepts a list of objects
- ListArgumentBuilder<T> - Class in dev.jorel.commandapi.arguments
-
A builder to create a ListArgument
- ListArgumentBuilder(String) - Constructor for class dev.jorel.commandapi.arguments.ListArgumentBuilder
-
Creates a new ListArgumentBuilder with a specified node name.
- ListArgumentBuilder(String, String) - Constructor for class dev.jorel.commandapi.arguments.ListArgumentBuilder
-
Creates a new ListArgumentBuilder with a specified node name
- ListArgumentBuilder.ListArgumentBuilderSuggests - Class in dev.jorel.commandapi.arguments
-
An intermediary class for the
ListArgumentBuilder - ListArgumentBuilder.ListArgumentBuilderSuggests.ListArgumentBuilderFinished - Class in dev.jorel.commandapi.arguments
-
An intermediary class for the
ListArgumentBuilder - LITERAL - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The LiteralArgument
- LiteralArgument - Class in dev.jorel.commandapi.arguments
-
A pseudo-argument representing a single literal string
- LiteralArgument(String) - Constructor for class dev.jorel.commandapi.arguments.LiteralArgument
-
A literal argument.
- 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
- Location2D - Class in dev.jorel.commandapi.wrappers
-
A class that represents a Location in the x and z directions.
- Location2D(World, double, double) - Constructor for class dev.jorel.commandapi.wrappers.Location2D
-
Constructs a Location2D location
- Location2D(World, double, double, double) - Constructor for class dev.jorel.commandapi.wrappers.Location2D
-
Constructs a Location2D location
- Location2D(World, double, double, double, float, float) - Constructor for class dev.jorel.commandapi.wrappers.Location2D
-
Constructs a Location2D location
- Location2DArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit
Locationobject in x and z directions - Location2DArgument(String) - Constructor for class dev.jorel.commandapi.arguments.Location2DArgument
-
A Location argument.
- Location2DArgument(String, LocationType) - Constructor for class dev.jorel.commandapi.arguments.Location2DArgument
-
A Location argument.
- LocationArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit
Locationobject - LocationArgument(String) - Constructor for class dev.jorel.commandapi.arguments.LocationArgument
-
A Location argument.
- LocationArgument(String, LocationType) - Constructor for class dev.jorel.commandapi.arguments.LocationArgument
-
A Location argument.
- 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.
- LongArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents primitive Java longs
- LongArgument(String) - Constructor for class dev.jorel.commandapi.arguments.LongArgument
-
A long argument
- LongArgument(String, long) - Constructor for class dev.jorel.commandapi.arguments.LongArgument
-
A long argument with a minimum value
- LongArgument(String, long, long) - Constructor for class dev.jorel.commandapi.arguments.LongArgument
-
A long argument with a minimum and maximum value
- 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
- LootTableArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit LootTable object
- LootTableArgument(String) - Constructor for class dev.jorel.commandapi.arguments.LootTableArgument
-
A LootTable argument that represents a Bukkit LootTable.
M
- MANY_ENTITIES - Enum constant in enum class dev.jorel.commandapi.arguments.EntitySelector
-
Many entities.
- MANY_PLAYERS - Enum constant in enum class dev.jorel.commandapi.arguments.EntitySelector
-
Many players.
- 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
- MathOperationArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents Minecraft scoreboard math operations
- MathOperationArgument(String) - Constructor for class dev.jorel.commandapi.arguments.MathOperationArgument
-
A MathOperation argument.
- MAX - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation
-
The maximum value of two values (>)
- 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
- meta - Variable in class dev.jorel.commandapi.CommandAPICommand
-
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 (<)
- 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 (%=)
- MULTI_LITERAL - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The MultiLiteralArgument
- MultiLiteralArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents multiple LiteralArguments
- MultiLiteralArgument(String...) - Constructor for class dev.jorel.commandapi.arguments.MultiLiteralArgument
-
A multiliteral argument.
- MULTIPLE - Enum constant in enum class dev.jorel.commandapi.arguments.ScoreHolderArgument.ScoreHolderType
-
A collection of score holder names
- MULTIPLY - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation
-
Multiplication of a value by another value (*=)
N
- name() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
- NAMESPACED_KEY - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
- NamespacedKeyArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a Minecraft resource location (or namespaced key) in the form namespace:key.
- NamespacedKeyArgument(String) - Constructor for class dev.jorel.commandapi.arguments.NamespacedKeyArgument
-
Constructs a MinecraftKeyArgument with a given node name.
- NATIVE - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType
-
An executor where the CommandSender is (always) a NativeProxyCommandSender
- NativeCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for a NativeProxyCommandSender
- NativeProxyCommandSender - Class in dev.jorel.commandapi.wrappers
-
A simple representation of Minecraft's CommandListenerWrapper, in the form of Bukkit's ProxiedCommandSender
- NativeProxyCommandSender(CommandSender, CommandSender, Location, World) - Constructor for class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Constructs a NativeProxyCommandSender, which is basically Minecraft's CommandListenerWrapper
- NativeResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for a NativeProxyCommandSender
- NBT_COMPOUND - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The NBTCompoundArgument
- NBTAPINotFoundException - Exception 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 dev.jorel.commandapi.exceptions.NBTAPINotFoundException
-
Creates an NBTAPINotFoundException
- NBTCompoundArgument<NBTContainer> - Class in dev.jorel.commandapi.arguments
-
An argument that represents an NBTContainer from the NBT API
- NBTCompoundArgument(String) - Constructor for class dev.jorel.commandapi.arguments.NBTCompoundArgument
-
An NBT Compound Argument.
- NMS<CommandListenerWrapper> - Interface in dev.jorel.commandapi.nms
- none(String) - Static method in class dev.jorel.commandapi.StringTooltip
-
Constructs a StringTooltip with a suggestion and no tooltip
- none(S) - Static method in class dev.jorel.commandapi.Tooltip
-
Constructs a
Tooltip<S>with a suggestion and no tooltip - NONE - Static variable in class dev.jorel.commandapi.CommandPermission
-
Command can be run with no permissions
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
- ObjectiveArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the name of a scoreboard objective
- ObjectiveArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ObjectiveArgument
-
An Objective argument.
- ObjectiveCriteriaArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the name of an objective criteria
- ObjectiveCriteriaArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ObjectiveCriteriaArgument
-
An Objective criteria argument.
- of(String, String) - Static method in class dev.jorel.commandapi.StringTooltip
-
Constructs a StringTooltip with a suggestion and a tooltip
- of(DisplaySlot) - Static method in class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Constructs a ScoreboardSlot from a DisplaySlot
- of(S, String) - Static method in class dev.jorel.commandapi.Tooltip
-
Constructs a
Tooltip<S>with a suggestion and a tooltip - OFFLINE_PLAYER - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The OfflinePlayerArgument
- OfflinePlayerArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Player object
- OfflinePlayerArgument(String) - Constructor for class dev.jorel.commandapi.arguments.OfflinePlayerArgument
-
A Player argument.
- ofTeamColor(ChatColor) - Static method in class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Constructs a ScoreboardSlot from a ChatColor
- onDisable() - Static method in class dev.jorel.commandapi.CommandAPI
-
Unloads the CommandAPI.
- ONE_ENTITY - Enum constant in enum class dev.jorel.commandapi.arguments.EntitySelector
-
A single entity.
- ONE_PLAYER - Enum constant in enum class dev.jorel.commandapi.arguments.EntitySelector
-
A single player.
- onEnable(Plugin) - Static method in class dev.jorel.commandapi.CommandAPI
-
Enables the CommandAPI.
- onLoad(CommandAPIConfig) - Static method in class dev.jorel.commandapi.CommandAPI
-
Initializes the CommandAPI for loading.
- OP - Static variable in class dev.jorel.commandapi.CommandPermission
-
A player that has to be an operator to run a command
- override() - Method in class dev.jorel.commandapi.CommandAPICommand
-
Overrides a command.
P
- PaperAdventureNotFoundException - Exception 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 dev.jorel.commandapi.exceptions.PaperAdventureNotFoundException
-
Creates a PaperAdventureNotFoundException
- PaperImplementations - Class in dev.jorel.commandapi
- PaperImplementations(boolean, NMS<?>) - Constructor for class dev.jorel.commandapi.PaperImplementations
-
Constructs a PaperImplementations object
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.AdventureChatArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.AdventureChatComponentArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.AngleArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.AxisArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.BiomeArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.BlockPredicateArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.BlockStateArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.BooleanArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ChatArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ChatColorArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ChatComponentArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.CustomArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.DoubleArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.EnchantmentArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.EntitySelectorArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.EntityTypeArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.EnvironmentArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.FloatArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.FloatRangeArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.FunctionArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.GreedyStringArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.IntegerArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.IntegerRangeArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ItemStackArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ItemStackPredicateArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ListArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.LiteralArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.Location2DArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.LocationArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.LongArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.LootTableArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.MathOperationArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.MultiLiteralArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.NamespacedKeyArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.NBTCompoundArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ObjectiveArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ObjectiveCriteriaArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.OfflinePlayerArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ParticleArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.PlayerArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.PotionEffectArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.RecipeArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.RotationArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ScoreboardSlotArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.ScoreHolderArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.SoundArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.StringArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.TeamArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.TextArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.TimeArgument
- parseArgument(NMS<CommandListenerWrapper>, CommandContext<CommandListenerWrapper>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.UUIDArgument
- parseArgument(NMS<CommandSourceStack>, CommandContext<CommandSourceStack>, String, Object[]) - Method in class dev.jorel.commandapi.arguments.Argument
-
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
parsedInputrecord component. - particle() - Method in record class dev.jorel.commandapi.wrappers.ParticleData
-
Returns the value of the
particlerecord component. - PARTICLE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The ParticleArgument
- ParticleArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Particle object
- ParticleArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ParticleArgument
-
A Particle argument.
- ParticleData<T> - Record Class in dev.jorel.commandapi.wrappers
-
A data structure that stores a particle and its corresponding data (or null if no data is present)
- ParticleData(Particle, T) - Constructor for record class dev.jorel.commandapi.wrappers.ParticleData
-
Creates an instance of a
ParticleDatarecord class. - permission() - Method in record class dev.jorel.commandapi.RegisteredCommand
-
Returns the value of the
permissionrecord component. - player() - Method in record class dev.jorel.commandapi.arguments.PreviewInfo
-
Returns the value of the
playerrecord 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
- PlayerArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Player object
- PlayerArgument(String) - Constructor for class dev.jorel.commandapi.arguments.PlayerArgument
-
A Player argument.
- PlayerCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for a Player
- PlayerResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for a Player
- POTION_EFFECT - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The PotionEffectArgument
- PotionEffectArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit PotionEffectType object
- PotionEffectArgument(String) - Constructor for class dev.jorel.commandapi.arguments.PotionEffectArgument
-
A PotionEffect argument.
- 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)
- Preview - Interface in dev.jorel.commandapi.wrappers
- PreviewableFunction<T> - Interface in dev.jorel.commandapi.wrappers
- PreviewInfo<T> - Record Class in dev.jorel.commandapi.arguments
- PreviewInfo(Player, String, String, T) - Constructor for record class dev.jorel.commandapi.arguments.PreviewInfo
-
Creates an instance of a
PreviewInforecord class. - PreviewLegacy - Interface in dev.jorel.commandapi.wrappers
- previousArgs() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
previousArgsrecord component. - previousArgs() - Method in record class dev.jorel.commandapi.SuggestionInfo
-
Returns the value of the
previousArgsrecord 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 dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- printStackTrace(PrintStream) - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- printStackTrace(PrintWriter) - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- PROXY - Enum constant in enum class dev.jorel.commandapi.executors.ExecutorType
-
An executor where the CommandSender is a NativeProxyCommandSender
- ProxyCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A normal command executor for a NativeProxyCommandSender
- ProxyResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for a NativeProxyCommandSender
R
- recalculatePermissions() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Recalculates the permissions for this object, if the attachments have changed values.
- recipe() - Method in record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
Returns the value of the
reciperecord component. - RECIPE - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The RecipeArgument
- 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.
- RECIPES - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders
-
A suggestion provider for the RecipeArgument
- register() - Method in class dev.jorel.commandapi.CommandAPICommand
- register() - Method in class dev.jorel.commandapi.CommandTree
-
Registers the command
- registerCommand(Class<?>) - Static method in class dev.jorel.commandapi.CommandAPI
-
Registers a command.
- 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>, Optional<String>, Optional<String>, String[], CommandPermission) - Constructor for record class dev.jorel.commandapi.RegisteredCommand
-
Creates an instance of a
RegisteredCommandrecord class. - registerReloadHandler(Plugin) - Method in class dev.jorel.commandapi.PaperImplementations
-
Hooks into Paper's
ServerResourcesReloadedEventto detect if/minecraft:reloadis called, and registers a reload handler that automatically calls the CommandAPI's internal datapack reloading function - reloadDatapacks() - Static method in class dev.jorel.commandapi.CommandAPI
-
Reloads all of the datapacks that are on the server.
- reloadDataPacks() - Method in interface dev.jorel.commandapi.nms.NMS
-
Reloads the datapacks by using the updated the commandDispatcher tree
- removeAttachment(PermissionAttachment) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Removes the given PermissionAttachment from this object
- replaceSafeSuggestions(SafeSuggestions<S>) - Method in class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Replaces the suggestions with a safe
SafeSuggestionsobject. - replaceSuggestions(ArgumentSuggestions) - Method in class dev.jorel.commandapi.arguments.Argument
-
Replace the suggestions of this argument.
- replaceSuggestions(Function<SuggestionInfo, String[]>) - Method in class dev.jorel.commandapi.arguments.Argument
-
Deprecated, for removal: This API element is subject to removal in a future version.use
Argument.replaceSuggestions(ArgumentSuggestions)instead - replaceSuggestionsT(Function<SuggestionInfo, IStringTooltip[]>) - Method in class dev.jorel.commandapi.arguments.Argument
-
Deprecated, for removal: This API element is subject to removal in a future version.use
Argument.replaceSuggestions(ArgumentSuggestions)instead - replaceWithSafeSuggestions(Function<SuggestionInfo, S[]>) - Method in class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Deprecated, for removal: This API element is subject to removal in a future version.
- replaceWithSafeSuggestionsT(Function<SuggestionInfo, Tooltip<S>[]>) - Method in class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Deprecated, for removal: This API element is subject to removal in a future version.
- resendPackets(Player) - Method in interface dev.jorel.commandapi.nms.NMS
-
Resends the command dispatcher's set of commands to a player.
- ResultingCommandExecutor - Interface in dev.jorel.commandapi.executors
-
A resulting command executor for a CommandSender
- Rotation - Class in dev.jorel.commandapi.wrappers
-
A class to represent the pitch and yaw rotation in degrees
- Rotation(float, float) - Constructor for class dev.jorel.commandapi.wrappers.Rotation
-
Constructs a Rotation with a given pitch and yaw
- ROTATION - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The RotationArgument
- RotationArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents rotation as pitch and yaw
- RotationArgument(String) - Constructor for class dev.jorel.commandapi.arguments.RotationArgument
-
A Rotation argument.
- run() - Method in class dev.jorel.commandapi.wrappers.FunctionWrapper
-
Executes this function as the executor of the command.
- run(NativeProxyCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.NativeCommandExecutor
-
The code to run when this command is performed
- run(NativeProxyCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.NativeResultingCommandExecutor
-
The code to run when this command is performed
- run(NativeProxyCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.ProxyCommandExecutor
-
The code to run when this command is performed
- run(NativeProxyCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.ProxyResultingCommandExecutor
-
The code to run when this command is performed
- run(BlockCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.CommandBlockCommandExecutor
-
The code to run when this command is performed
- run(BlockCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.CommandBlockResultingCommandExecutor
-
The code to run when this command is performed
- run(CommandSender) - Method in class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Runs this function with a given CommandSender
- run(CommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.CommandExecutor
-
The code to run when this command is performed
- run(CommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.ResultingCommandExecutor
-
The code to run when this command is performed
- run(ConsoleCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.ConsoleCommandExecutor
-
The code to run when this command is performed
- run(ConsoleCommandSender, Object[]) - Method in interface dev.jorel.commandapi.executors.ConsoleResultingCommandExecutor
-
The code to run when this command is performed
- run(Entity, Object[]) - Method in interface dev.jorel.commandapi.executors.EntityCommandExecutor
-
The code to run when this command is performed
- run(Entity, Object[]) - Method in interface dev.jorel.commandapi.executors.EntityResultingCommandExecutor
-
The code to run when this command is performed
- run(Player, Object[]) - Method in interface dev.jorel.commandapi.executors.PlayerCommandExecutor
-
The code to run when this command is performed
- run(Player, Object[]) - Method in interface dev.jorel.commandapi.executors.PlayerResultingCommandExecutor
-
The code to run when this command is performed
- run(T, Object[]) - Method in interface dev.jorel.commandapi.executors.IExecutorNormal
-
Executes the command.
- run(T, Object[]) - Method in interface dev.jorel.commandapi.executors.IExecutorResulting
-
Executes the command.
- runAs(Entity) - Method in class dev.jorel.commandapi.wrappers.FunctionWrapper
-
Executes this function as an entity.
S
- SafeOverrideableArgument<T,
S> - Class in dev.jorel.commandapi.arguments -
An interface declaring methods required to override argument suggestions
- SafeOverrideableArgument(String, ArgumentType<?>, Function<S, String>) - Constructor for class dev.jorel.commandapi.arguments.SafeOverrideableArgument
-
Instantiates this argument and assigns the mapper to the provided mapper
- SafeSuggestions<S> - Interface in dev.jorel.commandapi.arguments
-
This class represents safe suggestions.
- 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
- ScoreboardSlot - Class in dev.jorel.commandapi.wrappers
-
A representation of scoreboard display slots, as well as team colors for the sidebar
- ScoreboardSlot(int) - Constructor for class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Determines the scoreboard slot value based on an internal Minecraft integer
- ScoreboardSlotArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit ScoreboardSlot object
- ScoreboardSlotArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ScoreboardSlotArgument
-
A Display slot argument.
- ScoreHolderArgument<T> - Class in dev.jorel.commandapi.arguments
-
An argument that represents a scoreholder's name, or a collection of scoreholder names
- ScoreHolderArgument(String) - Constructor for class dev.jorel.commandapi.arguments.ScoreHolderArgument
-
A Score Holder argument.
- ScoreHolderArgument(String, ScoreHolderArgument.ScoreHolderType) - Constructor for class dev.jorel.commandapi.arguments.ScoreHolderArgument
-
A Score Holder argument.
- ScoreHolderArgument.ScoreHolderType - Enum Class in dev.jorel.commandapi.arguments
-
An enum specifying whether a score holder consists of a single score holder or a collection of score holders
- seconds(int) - Static method in class dev.jorel.commandapi.wrappers.Time
-
Create a Time object with a given number of seconds
- sender() - Method in record class dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentInfo
-
Returns the value of the
senderrecord component. - sender() - Method in record class dev.jorel.commandapi.SuggestionInfo
-
Returns the value of the
senderrecord component. - sendMessage(String) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Sends this sender a message
- sendMessage(String...) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Sends this sender multiple messages
- sendMessage(UUID, String) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Sends this sender a message
- sendMessage(UUID, String...) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Sends this sender multiple messages
- setAliases(String[]) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the aliases for this command
- setArguments(List<Argument<?>>) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the arguments that this command has
- setCustomNMS(NMS<?>) - Method in class dev.jorel.commandapi.CommandAPIConfig
-
Internal.
- setExecutor(CustomCommandExecutor<? extends CommandSender>) - Method in class dev.jorel.commandapi.arguments.AdvancementArgument
-
Sets the executors for this command
- setListed(boolean) - Method in class dev.jorel.commandapi.arguments.Argument
-
Sets whether this argument will be listed in the Object args[] of the command executor
- setNormalExecutors(List<IExecutorNormal<T>>) - Method in class dev.jorel.commandapi.CustomCommandExecutor
- setOp(boolean) - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Sets the operator status of this object
- setPermission(CommandPermission) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the permission required to run this command
- setRequirements(Predicate<CommandSender>) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the requirements that must be satisfied to run this command
- setResultingExecutors(List<IExecutorResulting<T>>) - Method in class dev.jorel.commandapi.CustomCommandExecutor
- setStackTrace(StackTraceElement[]) - Method in exception dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
- setSubcommands(List<CommandAPICommand>) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the list of subcommands that this command has
- setY(double) - Method in class dev.jorel.commandapi.wrappers.Location2D
-
Throws a Location2DException
- shortDescription() - Method in record class dev.jorel.commandapi.RegisteredCommand
-
Returns the value of the
shortDescriptionrecord component. - shouldSkipSenderProxy(String) - Method in class dev.jorel.commandapi.InternalConfig
- shouldSkipSenderProxy(Plugin) - 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.
- SimpleFunctionWrapper - Class in dev.jorel.commandapi.wrappers
-
A wrapper class for Minecraft 1.12's functions
- SimpleFunctionWrapper(NamespacedKey, ToIntFunction, String[]) - Constructor for class dev.jorel.commandapi.wrappers.SimpleFunctionWrapper
-
Creates a SimpleFunctionWrapper
- SINGLE - Enum constant in enum class dev.jorel.commandapi.arguments.ScoreHolderArgument.ScoreHolderType
-
A single score holder name
- SOUND - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The SoundArgument
- SoundArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the Bukkit Sound object
- SoundArgument(String) - Constructor for class dev.jorel.commandapi.arguments.SoundArgument
-
A Sound argument.
- SOUNDS - Enum constant in enum class dev.jorel.commandapi.arguments.SuggestionProviders
-
A suggestion provider for the SoundArgument
- spigot() - Method in class dev.jorel.commandapi.wrappers.NativeProxyCommandSender
-
Returns a Spigot instance of this object
- SpigotNotFoundException - Exception in dev.jorel.commandapi.exceptions
-
An exception that occurs when Spigot is not present and Spigot is required
- SpigotNotFoundException(Class<?>) - Constructor for exception dev.jorel.commandapi.exceptions.SpigotNotFoundException
-
Creates a SpigotNotFoundException
- StringArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a simple String
- StringArgument(String) - Constructor for class dev.jorel.commandapi.arguments.StringArgument
-
A string argument for one word
- strings(String...) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Suggest hardcoded strings
- strings(Function<SuggestionInfo, String[]>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Suggest strings as the result of a function
- stringsAsync(Function<SuggestionInfo, CompletableFuture<String[]>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Suggest strings asynchronously
- stringsWithTooltips(IStringTooltip...) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Suggest hardcoded strings with tooltips
- stringsWithTooltips(Function<SuggestionInfo, IStringTooltip[]>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Suggest strings with tooltips as the result of a function
- stringsWithTooltipsAsync(Function<SuggestionInfo, CompletableFuture<IStringTooltip[]>>) - Static method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Suggest strings with tooltips asynchronously
- StringTooltip - Class in dev.jorel.commandapi
-
Represents a suggestion for an argument with a hover tooltip text for that suggestion.
- SUBTRACT - Enum constant in enum class dev.jorel.commandapi.wrappers.MathOperation
-
Subtraction of a value by another value (-=)
- suggest(SuggestionInfo, SuggestionsBuilder) - Method in interface dev.jorel.commandapi.arguments.ArgumentSuggestions
-
Create a
CompletableFutureresolving onto a brigadierSuggestionsobject. - suggest(Function<SuggestionInfo, T[]>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Suggest values as the result of a function
- suggest(T...) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Hardcode values to suggest
- suggestAsync(Function<SuggestionInfo, CompletableFuture<T[]>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Suggest values provided asynchronously
- SuggestionInfo - Record Class in dev.jorel.commandapi
-
A class that represents information which you can use to generate suggestions.
- SuggestionInfo(CommandSender, Object[], String, String) - Constructor for record class dev.jorel.commandapi.SuggestionInfo
-
Creates an instance of a
SuggestionInforecord class. - SuggestionProviders - Enum Class in dev.jorel.commandapi.arguments
-
An enum representing the different suggestion providers for arguments based on Minecraft namespaced keys
- 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
- TeamArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents the name of a scoreboard Team
- TeamArgument(String) - Constructor for class dev.jorel.commandapi.arguments.TeamArgument
-
A Team argument.
- TextArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents text, encased in quotes
- TextArgument(String) - Constructor for class dev.jorel.commandapi.arguments.TextArgument
-
A string argument for one word, or multiple words encased in quotes
- then(ArgumentTree) - Method in class dev.jorel.commandapi.ArgumentTree
-
Create a child branch on this node
- then(ArgumentTree) - Method in class dev.jorel.commandapi.CommandTree
-
Create a child branch on the tree
- 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
- TimeArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a duration of time in ticks
- TimeArgument(String) - Constructor for class dev.jorel.commandapi.arguments.TimeArgument
-
A Time argument.
- TimeArgumentException - Exception in dev.jorel.commandapi.exceptions
-
An exception that occurs when trying to use the TimeArgument on Minecraft version < 1.14
- TimeArgumentException() - Constructor for exception dev.jorel.commandapi.exceptions.TimeArgumentException
-
Creates a TimeArgumentException
- toCommandSyntax(String, CommandContext<?>) - Method in exception dev.jorel.commandapi.arguments.CustomArgument.CustomArgumentException
-
Converts this CustomArgumentException into a CommandSyntaxException
- Tooltip<S> - Class in dev.jorel.commandapi
-
This class represents a suggestion for an argument with a hover tooltip text for that suggestion.
- tooltips(Tooltip<T>...) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Suggest hardcoded values with tooltips
- tooltips(Function<SuggestionInfo, Tooltip<T>[]>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Suggest values with tooltips as the result of a function
- tooltipsAsync(Function<SuggestionInfo, CompletableFuture<Tooltip<T>[]>>) - Static method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Suggest values with tooltips asynchronously
- 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.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.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 record class dev.jorel.commandapi.wrappers.ComplexRecipeImpl
-
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 record class dev.jorel.commandapi.wrappers.ParticleData
-
Returns a string representation of this record class.
- toString() - Method in class dev.jorel.commandapi.wrappers.Rotation
-
Returns the Minecraft string value of this Rotation
- toString() - Method in class dev.jorel.commandapi.wrappers.ScoreboardSlot
-
Returns the Minecraft string representation of this scoreboard slot
- toString() - Method in class dev.jorel.commandapi.wrappers.Time
-
Returns the Minecraft argument representation of this Time object
- toSuggestions(String, List<Argument>) - Static method in class dev.jorel.commandapi.Brigadier
-
Converts an argument name and a list of arguments to a Brigadier SuggestionProvider
- toSuggestions(Function<S, String>) - Method in interface dev.jorel.commandapi.arguments.SafeSuggestions
-
Convert this
SafeSuggestionsobject into anArgumentSuggestionsby mapping the values with a string mapping function.
U
- unhookChatPreview(Player) - Method in interface dev.jorel.commandapi.nms.NMS
-
Unhooks a player from the chat previewing system for 1.19+.
- 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, by force (removes all instances of that command)
- updateRequirements(Player) - Static method in class dev.jorel.commandapi.CommandAPI
-
Updates the requirements required for a given player to execute a command.
- 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.
- usePreview(boolean) - Method in class dev.jorel.commandapi.arguments.AdventureChatArgument
- usePreview(boolean) - Method in class dev.jorel.commandapi.arguments.ChatArgument
- usePreview(boolean) - Method in interface dev.jorel.commandapi.arguments.IPreviewable
-
Whether this argument should use the preview result as the argument value for execution.
- UUID - Enum constant in enum class dev.jorel.commandapi.arguments.CommandAPIArgumentType
-
The UUIDArgument
- UUIDArgument - Class in dev.jorel.commandapi.arguments
-
An argument that represents a UUID
- UUIDArgument(String) - Constructor for class dev.jorel.commandapi.arguments.UUIDArgument
-
A UUID argument.
- UUIDArgumentException - Exception in dev.jorel.commandapi.exceptions
-
An exception that occurs when trying to use the UUIDArgumentException on Minecraft version < 1.16
- UUIDArgumentException() - Constructor for exception dev.jorel.commandapi.exceptions.UUIDArgumentException
-
Creates a UUIDArgumentException
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.EntitySelector
-
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.ScoreHolderArgument.ScoreHolderType
-
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.EntitySelector
-
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.ScoreHolderArgument.ScoreHolderType
-
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
- withAliases(String...) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Adds an array of aliases to the current command builder
- withArguments(Argument<?>...) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Appends the argument(s) to the current command builder
- withArguments(List<Argument<?>>) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Appends the arguments to the current command builder
- withFullDescription(String) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the full description for this command.
- withHelp(String, String) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the short and full description for this command.
- withList(Collection<T>) - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder
-
Specifies the list to use to generate suggestions for the list argument
- withList(Function<CommandSender, Collection<T>>) - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder
-
Specifies the list to use to generate suggestions for the list argument
- withList(Supplier<Collection<T>>) - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder
-
Specifies the list to use to generate suggestions for the list argument
- withMapper(Function<T, String>) - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder.ListArgumentBuilderSuggests
-
Specifies the mapping function of the specific type
Tto aStringso an element can be shown to a user as suggestions. - withoutPermission(CommandPermission) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Applies a permission to the current command builder
- withoutPermission(String) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Applies a permission to the current command builder
- withPermission(CommandPermission) - Method in class dev.jorel.commandapi.arguments.Argument
-
Assigns the given permission as a requirement to execute this command.
- withPermission(CommandPermission) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Applies a permission to the current command builder
- withPermission(String) - Method in class dev.jorel.commandapi.arguments.Argument
-
Assigns the given permission as a requirement to execute this command.
- withPermission(String) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Applies a permission to the current command builder
- withPreview(PreviewableFunction<A>) - Method in interface dev.jorel.commandapi.arguments.IPreviewable
-
Sets the
PreviewableFunctionfor this argument. - withPreview(PreviewableFunction<Component>) - Method in class dev.jorel.commandapi.arguments.AdventureChatArgument
- withPreview(PreviewableFunction<BaseComponent[]>) - Method in class dev.jorel.commandapi.arguments.ChatArgument
- withRequirement(Predicate<CommandSender>) - Method in class dev.jorel.commandapi.arguments.Argument
-
Adds a requirement that has to be satisfied to use this argument.
- withRequirement(Predicate<CommandSender>) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Adds a requirement that has to be satisfied to use this command.
- withShortDescription(String) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Sets the short description for this command.
- withStringMapper() - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder.ListArgumentBuilderSuggests
-
Specifies that the mapping function for this argument calls the
toString()method. - withStringTooltipMapper(Function<T, IStringTooltip>) - Method in class dev.jorel.commandapi.arguments.ListArgumentBuilder.ListArgumentBuilderSuggests
-
Specifies the mapping function of the specific type
Tto aIStringTooltipso an element can be shown to a user as a suggestion with a tooltip. - withSubcommand(CommandAPICommand) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Adds a subcommand to this command builder
- withSubcommands(CommandAPICommand...) - Method in class dev.jorel.commandapi.CommandAPICommand
-
Adds subcommands to this command builder
- WrapperCommandSyntaxException - Exception 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 dev.jorel.commandapi.exceptions.WrapperCommandSyntaxException
-
Creates a WrapperCommandSyntaxException
_
- _ArgumentAngle() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentAxis() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentBlockPredicate() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentBlockState() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentChat() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentChatComponent() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentChatFormat() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentDimension() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentEnchantment() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentEntity(EntitySelector) - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentEntitySummon() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentFloatRange() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentIntRange() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentItemPredicate() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentItemStack() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentMathOperation() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentMinecraftKeyRegistered() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentMobEffect() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentNBTCompound() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentParticle() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentPosition() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentPosition2D() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentProfile() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentRotation() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentScoreboardCriteria() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentScoreboardObjective() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentScoreboardSlot() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentScoreboardTeam() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentScoreholder(boolean) - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentSyntheticBiome() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentTag() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentTime() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentUUID() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentVec2() - Method in interface dev.jorel.commandapi.nms.NMS
- _ArgumentVec3() - Method in interface dev.jorel.commandapi.nms.NMS
All Classes and Interfaces|All Packages|Serialized Form
CustomArgument(Argument, CustomArgumentInfoParser)withTextArgumentinstead