Uses of Class
dev.jorel.commandapi.arguments.Argument

Packages that use Argument

Package	Description
dev.jorel.commandapi
dev.jorel.commandapi.arguments	Classes to be used as arguments for commands
dev.jorel.commandapi.exceptions	Classes which are the exceptions raised during the execution of the Command API

Uses of Argument in dev.jorel.commandapi

Methods in dev.jorel.commandapi that return types with arguments of type Argument

Modifier and Type	Method	Description
List<Argument<?>>	CommandAPICommand.getArguments()	Returns the list of arguments that this command has

Methods in dev.jorel.commandapi with parameters of type Argument

Modifier and Type	Method	Description
static void	Converter.convert(org.bukkit.plugin.java.JavaPlugin plugin, String cmdName, Argument<?>... arguments)	Convert a command stated in Plugin's plugin.yml file into CommandAPI-compatible commands
static com.mojang.brigadier.builder.RequiredArgumentBuilder	Brigadier.fromArgument(Argument argument)	Constructs a RequiredArgumentBuilder from a given argument
CommandAPICommand	CommandAPICommand.withArguments(Argument<?>... args)	Appends the argument(s) to the current command builder

Method parameters in dev.jorel.commandapi with type arguments of type Argument

Modifier and Type	Method	Description
static void	Converter.convert(String cmdName, List<Argument<?>> arguments)	Convert the provided command name with its list of arguments into a CommandAPI-compatible command
static void	Converter.convert(org.bukkit.plugin.java.JavaPlugin plugin, String cmdName, List<Argument<?>> arguments)	Convert a command stated in Plugin's plugin.yml file into CommandAPI-compatible commands
static com.mojang.brigadier.builder.RequiredArgumentBuilder	Brigadier.fromArgument(List<Argument> args, String nodeName)	Constructs a RequiredArgumentBuilder from a given argument within a command declaration.
static com.mojang.brigadier.RedirectModifier	Brigadier.fromPredicate(BiPredicate<org.bukkit.command.CommandSender,Object[]> predicate, List<Argument> args)	Constructs a RedirectModifier from a predicate that uses a command sender and some arguments.
static Object[]	Brigadier.parseArguments(com.mojang.brigadier.context.CommandContext cmdCtx, List<Argument> args)	Parses arguments into their respective objects with a given command context.
void	CommandAPICommand.setArguments(List<Argument<?>> args)	Sets the arguments that this command has
static com.mojang.brigadier.suggestion.SuggestionProvider	Brigadier.toSuggestions(String nodeName, List<Argument> args)	Converts an argument name and a list of arguments to a Brigadier SuggestionProvider
CommandAPICommand	CommandAPICommand.withArguments(List<Argument<?>> args)	Appends the arguments to the current command builder

Constructors in dev.jorel.commandapi with parameters of type Argument

Modifier	Constructor	Description
	ArgumentTree(Argument<?> argument)	Instantiates an ArgumentTree with an underlying argument.

Uses of Argument in dev.jorel.commandapi.arguments

Classes in dev.jorel.commandapi.arguments with type parameters of type Argument

Modifier and Type	Interface	Description
interface	IPreviewable<T extends Argument<?>,A>	An interface representing that the argument can be previewed using Minecraft's chat preview feature.

Subclasses of Argument in dev.jorel.commandapi.arguments

Modifier and Type	Class	Description
class	AdvancementArgument	An argument that represents the Bukkit Advancement object
class	AdventureChatArgument	An argument that represents chat with entity selectors
class	AdventureChatComponentArgument	An argument that represents raw JSON text
class	AngleArgument	An argument that represents a yaw angle, measured in degrees with float number.
class	AxisArgument	An argument that represents x, y and z axes as an EnumSet of Axis
class	BiomeArgument	An argument that represents the Bukkit Biome object
class	BlockPredicateArgument	An argument that represents a Predicate<Block>
class	BlockStateArgument	An argument that represents the Bukkit BlockData object
class	BooleanArgument	An argument that represents primitive Java booleans
class	ChatArgument	An argument that represents chat with entity selectors
class	ChatColorArgument	An argument that represents the Bukkit ChatColor object
class	ChatComponentArgument	An argument that represents raw JSON text
class	CustomArgument<T,B>	An argument that represents any custom object
class	DoubleArgument	An argument that represents primitive Java doubles
class	EnchantmentArgument	An argument that represents the Bukkit Enchantment object
class	EntitySelectorArgument<T>	An argument that represents a selection of entities
class	EntityTypeArgument	An argument that represents the Bukkit EntityType object
class	EnvironmentArgument	An argument that represents the Bukkit Environment object
class	FloatArgument	An argument that represents primitive Java floats
class	FloatRangeArgument	An argument that represents a range of float values
class	FunctionArgument	An argument that represents Minecraft functions and tags
class	GreedyStringArgument	An argument that represents arbitrary strings
class	IntegerArgument	An argument that represents primitive Java ints
class	IntegerRangeArgument	An argument that represents a range of integer values
class	ItemStackArgument	An argument that represents the Bukkit ItemStack object
class	ItemStackPredicateArgument	An argument that represents a Predicate<ItemStack>
class	ListArgument<T>	An argument that accepts a list of objects
class	LiteralArgument	A pseudo-argument representing a single literal string
class	Location2DArgument	An argument that represents the Bukkit Location object in x and z directions
class	LocationArgument	An argument that represents the Bukkit Location object
class	LongArgument	An argument that represents primitive Java longs
class	LootTableArgument	An argument that represents the Bukkit LootTable object
class	MathOperationArgument	An argument that represents Minecraft scoreboard math operations
class	MultiLiteralArgument	An argument that represents multiple LiteralArguments
class	NamespacedKeyArgument	An argument that represents a Minecraft resource location (or namespaced key) in the form namespace:key.
class	NBTCompoundArgument<NBTContainer>	An argument that represents an NBTContainer from the NBT API
class	ObjectiveArgument	An argument that represents the name of a scoreboard objective
class	ObjectiveCriteriaArgument	An argument that represents the name of an objective criteria
class	OfflinePlayerArgument	An argument that represents the Bukkit Player object
class	ParticleArgument	An argument that represents the Bukkit Particle object
class	PlayerArgument	An argument that represents the Bukkit Player object
class	PotionEffectArgument	An argument that represents the Bukkit PotionEffectType object
class	RecipeArgument	An argument that represents the Bukkit Recipe object
class	RotationArgument	An argument that represents rotation as pitch and yaw
class	SafeOverrideableArgument<T,S>	An interface declaring methods required to override argument suggestions
class	ScoreboardSlotArgument	An argument that represents the Bukkit ScoreboardSlot object
class	ScoreHolderArgument<T>	An argument that represents a scoreholder's name, or a collection of scoreholder names
class	SoundArgument	An argument that represents the Bukkit Sound object
class	StringArgument	An argument that represents a simple String
class	TeamArgument	An argument that represents the name of a scoreboard Team
class	TextArgument	An argument that represents text, encased in quotes
class	TimeArgument	An argument that represents a duration of time in ticks
class	UUIDArgument	An argument that represents a UUID

Methods in dev.jorel.commandapi.arguments that return Argument

Modifier and Type	Method	Description
final Argument<T>	SafeOverrideableArgument.includeSafeSuggestions(SafeSuggestions<S> suggestions)	Includes the suggestions provided with the existing suggestions for this argument.
Argument<T>	Argument.includeSuggestions(ArgumentSuggestions suggestions)	Include suggestions to add to the list of default suggestions represented by this argument.
Argument<T>	Argument.includeSuggestions(Function<SuggestionInfo,String[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use includeSuggestions(ArgumentSuggestions) instead
Argument<T>	Argument.includeSuggestionsT(Function<SuggestionInfo,IStringTooltip[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use includeSuggestions(ArgumentSuggestions) instead
final Argument<T>	SafeOverrideableArgument.includeWithSafeSuggestions(Function<SuggestionInfo,S[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use SafeOverrideableArgument.includeSafeSuggestions(SafeSuggestions)
final Argument<T>	SafeOverrideableArgument.includeWithSafeSuggestionsT(Function<SuggestionInfo,Tooltip<S>[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use SafeOverrideableArgument.includeSafeSuggestions(SafeSuggestions)
final Argument<T>	SafeOverrideableArgument.replaceSafeSuggestions(SafeSuggestions<S> suggestions)	Replaces the suggestions with a safe SafeSuggestions object.
Argument<T>	Argument.replaceSuggestions(ArgumentSuggestions suggestions)	Replace the suggestions of this argument.
Argument<T>	Argument.replaceSuggestions(Function<SuggestionInfo,String[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use replaceSuggestions(ArgumentSuggestions) instead
Argument<T>	Argument.replaceSuggestionsT(Function<SuggestionInfo,IStringTooltip[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use replaceSuggestions(ArgumentSuggestions) instead
final Argument<T>	SafeOverrideableArgument.replaceWithSafeSuggestions(Function<SuggestionInfo,S[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use SafeOverrideableArgument.replaceSafeSuggestions(SafeSuggestions)
final Argument<T>	SafeOverrideableArgument.replaceWithSafeSuggestionsT(Function<SuggestionInfo,Tooltip<S>[]> suggestions)	Deprecated, for removal: This API element is subject to removal in a future version. use SafeOverrideableArgument.replaceSafeSuggestions(SafeSuggestions)
Argument<T>	Argument.setListed(boolean listed)	Sets whether this argument will be listed in the Object args[] of the command executor
final Argument<T>	Argument.withPermission(CommandPermission permission)	Assigns the given permission as a requirement to execute this command.
final Argument<T>	Argument.withPermission(String permission)	Assigns the given permission as a requirement to execute this command.
final Argument<T>	Argument.withRequirement(Predicate<org.bukkit.command.CommandSender> requirement)	Adds a requirement that has to be satisfied to use this argument.

Constructors in dev.jorel.commandapi.arguments with parameters of type Argument

Modifier	Constructor	Description
	CustomArgument(Argument<B> base, CustomArgument.CustomArgumentInfoParser<T,B> parser)	Creates a CustomArgument with a valid parser, with an underlying base argument as its parsing implementation.

Uses of Argument in dev.jorel.commandapi.exceptions

Constructors in dev.jorel.commandapi.exceptions with parameters of type Argument

Modifier	Constructor	Description
	GreedyArgumentException(Argument<?>[] arguments)	Creates a GreedyArgumentException