Package dev.jorel.commandapi.arguments

Classes to be used as arguments for commands. More...

Classes
class	AbstractArgument
	The core abstract class for Command API arguments. More...
class	AdvancementArgument
	An argument that represents the Bukkit Advancement object. More...
class	AdventureChatArgument
	An argument that represents chat with entity selectors. More...
class	AdventureChatColorArgument
	An argument that represents the Bukkit ChatColor object. More...
class	AdventureChatComponentArgument
	An argument that represents raw JSON text. More...
class	AngleArgument
	An argument that represents a yaw angle, measured in degrees with float number. More...
class	Argument
	The core abstract class for Command API arguments. More...
enum	ArgumentSubType
	An enum that represents argument subtypes. More...
interface	ArgumentSuggestions
	This class represents suggestions for an argument. More...
class	AxisArgument
	An argument that represents x, y and z axes as an EnumSet of Axis. More...
class	BiomeArgument
	An argument that represents the Bukkit Biome object. More...
class	BlockPredicateArgument
	An argument that represents a Predicate<Block> More...
class	BlockStateArgument
	An argument that represents the Bukkit BlockData object. More...
class	BooleanArgument
	An argument that represents primitive Java booleans. More...
class	ChatArgument
	An argument that represents chat with entity selectors. More...
class	ChatColorArgument
	An argument that represents the Bukkit ChatColor object. More...
class	ChatComponentArgument
	An argument that represents raw JSON text. More...
enum	CommandAPIArgumentType
	An enum that represents the different arguments declared in the Command API. More...
class	CommandArgument
	An argument that represents a command. More...
class	CustomArgument
	An argument that represents any custom object. More...
interface	CustomProvidedArgument
	An interface allowing arguments to have built-in suggestion providers based on Minecraft namespaced keys. More...
class	DoubleArgument
	An argument that represents primitive Java doubles. More...
class	EnchantmentArgument
	An argument that represents the Bukkit Enchantment object. More...
class	EntitySelectorArgument
	An argument that represents a selection of entities. More...
class	EntityTypeArgument
	An argument that represents the Bukkit EntityType object. More...
class	FloatArgument
	An argument that represents primitive Java floats. More...
class	FloatRangeArgument
	An argument that represents a range of float values. More...
class	FunctionArgument
	An argument that represents Minecraft functions and tags. More...
interface	GreedyArgument
	An interface indicating that an argument consumes all available characters. More...
class	GreedyStringArgument
	An argument that represents arbitrary strings. More...
class	IntegerArgument
	An argument that represents primitive Java ints. More...
class	IntegerRangeArgument
	An argument that represents a range of integer values. More...
class	ItemStackArgument
	An argument that represents the Bukkit ItemStack object. More...
class	ItemStackPredicateArgument
	An argument that represents a Predicate<ItemStack> More...
class	ListArgument
	An argument that accepts a list of objects. More...
class	ListArgumentBuilder
	A builder to create a ListArgument. More...
class	ListArgumentCommon
	An argument that accepts a list of objects. More...
class	ListTextArgument
	An argument that accepts a list of objects. More...
interface	Literal
	An interface representing literal-based arguments. More...
class	LiteralArgument
	A pseudo-argument representing a single literal string. More...
class	Location2DArgument
	An argument that represents the Bukkit Location object in x and z directions. More...
class	LocationArgument
	An argument that represents the Bukkit Location object. More...
enum	LocationType
	An enum representing block position or precise position for location arguments. More...
class	LongArgument
	An argument that represents primitive Java longs. More...
class	LootTableArgument
	An argument that represents the Bukkit LootTable object. More...
class	MapArgument
	An argument that represents a key-value pair. More...
class	MapArgumentBuilder
	A builder to create a MapArgument. More...
class	MathOperationArgument
	An argument that represents Minecraft scoreboard math operations. More...
interface	MultiLiteral
	An interface representing arguments with multiple literal string definitions. More...
class	MultiLiteralArgument
	An argument that represents multiple LiteralArguments. More...
class	NamespacedKeyArgument
	An argument that represents a Minecraft resource location (or namespaced key) in the form namespace:key. More...
class	NBTCompoundArgument
	An argument that represents an NBTContainer from the NBT API. More...
class	ObjectiveArgument
	An argument that represents the name of a scoreboard objective. More...
class	ObjectiveCriteriaArgument
	An argument that represents the name of an objective criteria. More...
class	OfflinePlayerArgument
	An argument that represents the Bukkit Player object. More...
class	ParticleArgument
	An argument that represents the Bukkit Particle object. More...
class	PlayerArgument
	An argument that represents the Bukkit Player object. More...
class	PotionEffectArgument
	An argument that represents the Bukkit PotionEffectType object. More...
interface	Previewable
	An interface representing that the argument can be previewed using Minecraft's chat preview feature. More...
class	RecipeArgument
	An argument that represents the Bukkit Recipe object. More...
class	RotationArgument
	An argument that represents rotation as pitch and yaw. More...
interface	SafeOverrideable
class	SafeOverrideableArgument
	An interface declaring methods required to override argument suggestions. More...
interface	SafeSuggestions
	This class represents safe suggestions. More...
class	ScoreboardSlotArgument
	An argument that represents the Bukkit ScoreboardSlot object. More...
class	ScoreHolderArgument
	An argument that represents a scoreholder's name, or a collection of scoreholder names. More...
class	SoundArgument
	An argument that represents the Bukkit Sound object. More...
class	StringArgument
	An argument that represents a simple String. More...
interface	StringParser
	A class that represents a function that parses a String into another object. More...
enum	SuggestionProviders
	An enum representing the different suggestion providers for arguments based on Minecraft namespaced keys. More...
class	SuggestionsBranch
	This class represents a branch in the suggestions of an argument. More...
class	TeamArgument
	An argument that represents the name of a scoreboard Team. More...
class	TextArgument
	An argument that represents text, encased in quotes. More...
class	TimeArgument
	An argument that represents a duration of time in ticks. More...
class	UUIDArgument
	An argument that represents a UUID. More...
class	WorldArgument
	An argument that represents the Bukkit World object. More...

Functions
record	PreviewInfo< T > (AbstractPlayer<?> player, String input, String fullInput, T parsedInput)

Detailed Description

Classes to be used as arguments for commands.

Function Documentation

PreviewInfo< T >()

record dev.jorel.commandapi.arguments.PreviewInfo< T >	(	AbstractPlayer<?>	player,
		String	input,
		String	fullInput,
		T	parsedInput
	)

Parameters

player
player	the Player typing this command
input
input	the current partially typed argument. For example "/mycmd tes" will return "tes"
fullInput
fullInput	a string representing the full current input (including /)
parsedInput
parsedInput	the parsed input as a BaseComponent[] (spigot) or Component (paper)