Index (grenadier 2.0.6 API)

A B C D E F G H I K L M N O P R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractCommand - Class in net.forthecrown.grenadier: An abstract class that can be easily extended to create commands.
AbstractCommand(String) - Constructor for class net.forthecrown.grenadier.AbstractCommand: Creates a new abstract command instance.
acceptsFailureMessage() - Method in interface net.forthecrown.grenadier.CommandSource: Checks whether this source accepts command failure messages
acceptsSuccessMessage() - Method in interface net.forthecrown.grenadier.CommandSource: Checks whether this source accepts command success messages
addCallback(ResultConsumer<CommandSource>) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source with the given callback added to it.
addFlag(FlagOption) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.Builder: Adds a flag option
addLabel(String...) - Method in interface net.forthecrown.grenadier.types.options.Option.OptionBuilder: Adds a label
addOption(ArgumentOption<T>, boolean) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.Builder: Adds an argument option
addOptional(ArgumentOption<T>) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.Builder: Delegate for OptionsArgument.Builder.addOption(ArgumentOption, boolean) with false for the 'required' parameter
addRequired(ArgumentOption<T>) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.Builder: Delegate for OptionsArgument.Builder.addOption(ArgumentOption, boolean) with true for the 'required' parameter
ADMINS - Enum constant in enum class net.forthecrown.grenadier.PermissionLevel: Admins
ALL - Enum constant in enum class net.forthecrown.grenadier.PermissionLevel: Level held by all players
allowsMultiple() - Method in interface net.forthecrown.grenadier.types.EntityArgument: Gets whether the resulting selector is allowed to select more than 1 entity
apply(double) - Method in record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Applies this coordinate to the specified base
apply(CommandSource) - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Applies this position's data to the anchored location of the specified source
apply(Location) - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Applies this parsed position's data onto the specified base
applySuggestions(SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.CoordinateSuggestion
argument(ArgumentType<T>) - Static method in class net.forthecrown.grenadier.types.options.Options: Creates a new argument option builder
argument(ArgumentType<T>, String) - Static method in class net.forthecrown.grenadier.types.options.Options: Creates an argument option with a single label
argument(String, ArgumentType<T>) - Static method in class net.forthecrown.grenadier.Nodes: Creates a required argument builder
ArgumentOption<T> - Interface in net.forthecrown.grenadier.types.options: An option that requires an argument value
ArgumentOption.Builder<T> - Interface in net.forthecrown.grenadier.types.options: Argument option builder
ArgumentTypes - Class in net.forthecrown.grenadier.types: Static factory and instance provider methods for argument types
array(ArgumentType<T>) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Creates an array argument for the specified type
ArrayArgument<T> - Interface in net.forthecrown.grenadier.types: Argument type that parses a list of specific types.
as(Class<T>) - Method in interface net.forthecrown.grenadier.CommandSource: Gets the sender as the specified type
asBukkit() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the normal Bukkit CommandSender
asEntity() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the source as an entity
asEntityOrNull() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the source as an entity, or null
asOrNull(Class<T>) - Method in interface net.forthecrown.grenadier.CommandSource: Similar to CommandSource.as(Class) however it won't throw an exception if the sender is not of the given type, rather it just returns null
asPlayer() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the source as a player
asPlayerOrNull() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the source as a player, or null
audience() - Method in interface net.forthecrown.grenadier.CommandSource
AXIS_X - Static variable in interface net.forthecrown.grenadier.types.ParsedPosition: Index used to access the X coordinate in ParsedPosition.getCoordinates()
AXIS_Y - Static variable in interface net.forthecrown.grenadier.types.ParsedPosition: Index used to access the Y coordinate in ParsedPosition.getCoordinates()
AXIS_Z - Static variable in interface net.forthecrown.grenadier.types.ParsedPosition: Index used to access the Z coordinate in ParsedPosition.getCoordinates()

B

binaryTag() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the binary tag argument
block() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the block argument
BlockArgument - Interface in net.forthecrown.grenadier.types: Parses a BlockData instance along with optional NBT data
BlockArgument.Result - Interface in net.forthecrown.grenadier.types: Parsed block state result
blockFilter() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the block filter argument
BlockFilterArgument - Interface in net.forthecrown.grenadier.types: Parses either a block or a block tag, along with some block state data and an optional NBT Tag.
BlockFilterArgument.Result - Interface in net.forthecrown.grenadier.types: Parsed predicate result
blockPosition() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an argument that parses a 3D integer position
blockPosition2d() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an argument that parses a 2D integer position
broadcastAdmin(Component) - Method in interface net.forthecrown.grenadier.CommandSource: Broadcasts a message to other admins.
build() - Method in class net.forthecrown.grenadier.GrenadierCommand
build() - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption.Builder: Creates the argument option
build() - Method in interface net.forthecrown.grenadier.types.options.FlagOption.Builder: Builds the flag option
build() - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.Builder: Creates the options argument
builder() - Static method in interface net.forthecrown.grenadier.types.options.OptionsArgument: Creates a new options argument builder
BY_LABEL - Static variable in interface net.forthecrown.grenadier.types.GameModeArgument: Label to Gamemode map.

C

canSee(Entity) - Method in interface net.forthecrown.grenadier.CommandSource: Tests if this source can see the specified entity
canUse(CommandSource) - Method in class net.forthecrown.grenadier.AbstractCommand: Tests if the specified source can use this command.
canUse(CommandSource) - Method in class net.forthecrown.grenadier.GrenadierCommandNode
canUse(CommandSender) - Method in class net.forthecrown.grenadier.AbstractCommand: Delegate for AbstractCommand.canUse(CommandSource).
character() - Method in enum class net.forthecrown.grenadier.types.ParsedPosition.Type
checkAccess(CommandSource) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions.ParsedOption: Tests if the specified source is allowed to access this option.
CommandBroadcastEvent - Class in net.forthecrown.grenadier
CommandBroadcastEvent(CommandSource, Component, Set<Audience>) - Constructor for class net.forthecrown.grenadier.CommandBroadcastEvent
CommandBroadcastEvent.Formatter - Interface in net.forthecrown.grenadier: Formatter for a command broadcast
CommandContexts - Class in net.forthecrown.grenadier: Utility class for CommandContext instances.
CommandExceptionHandler - Interface in net.forthecrown.grenadier: An interface that handles exceptions when they're thrown during command execution or during suggestion creation
CommandSource - Interface in net.forthecrown.grenadier: The source of command execution.
CommandTreeBuilder - Interface in net.forthecrown.grenadier: A functional interface denoting an object that takes a literal argument builder and builds a tree on that builder
Completions - Class in net.forthecrown.grenadier: Utility class for command suggestions
component() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the chat component argument
ComponentArgument - Interface in net.forthecrown.grenadier.types: Parses a chat Component from JSON
compoundTag() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the compound tag argument
contains(double) - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Tests if this range contains the specified value
contains(int) - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Tests if this range contains the specified value
Coordinate(double, boolean) - Constructor for record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Creates an instance of a Coordinate record class.
CoordinateSuggestion - Interface in net.forthecrown.grenadier.types
CoordinateSuggestions - Class in net.forthecrown.grenadier.types
copy(StringReader) - Static method in class net.forthecrown.grenadier.Readers: Creates a copy of the specified reader
copy(StringReader, int) - Static method in class net.forthecrown.grenadier.Readers: Copies the input from another reader and sets the cursor offset.
create(double, double) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(double, double, double) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(int, boolean) - Method in interface net.forthecrown.grenadier.types.ItemArgument.Result: Creates a new ItemStack from this parsed data
create(Component, double, double) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(Component, double, double, double) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(Component, String, String) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(Component, String, String, String) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(StringReader, NamespacedKey) - Method in interface net.forthecrown.grenadier.types.RegistryArgument.UnknownFactory
create(String, int) - Static method in class net.forthecrown.grenadier.Readers: Creates a new StringReader with the specified input and offset
create(String, Object...) - Method in interface net.forthecrown.grenadier.ExceptionProvider
create(String, String) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(String, String, String) - Static method in class net.forthecrown.grenadier.types.CoordinateSuggestions
create(Component) - Method in interface net.forthecrown.grenadier.ExceptionProvider
createCommand(String) - Static method in class net.forthecrown.grenadier.Grenadier: Creates a grenadier command builder
createCommand(GrenadierCommand) - Method in interface net.forthecrown.grenadier.CommandTreeBuilder: Creates a command node tree for the specified command
createFiltered(String) - Static method in class net.forthecrown.grenadier.Readers: Creates a filtered reader.
createSource(CommandSender) - Static method in class net.forthecrown.grenadier.Grenadier: Creates a command source for the specified sender
createSource(CommandSender) - Method in interface net.forthecrown.grenadier.GrenadierProvider
createSource(CommandSender, GrenadierCommandNode) - Static method in class net.forthecrown.grenadier.Grenadier: Creates a command source for the specified sender and then calls CommandSource.setCurrentNode(GrenadierCommandNode) with the specified node
createWithContext(String, ImmutableStringReader, Object...) - Method in interface net.forthecrown.grenadier.ExceptionProvider
createWithContext(Component, ImmutableStringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider

D

DAYS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
DEFAULT - Static variable in interface net.forthecrown.grenadier.CommandBroadcastEvent.Formatter: Default broadcast formatter
DEFAULT_LOCAL_2 - Static variable in class net.forthecrown.grenadier.types.CoordinateSuggestions
DEFAULT_LOCAL_3 - Static variable in class net.forthecrown.grenadier.types.CoordinateSuggestions
DEFAULT_WORLD_2 - Static variable in class net.forthecrown.grenadier.types.CoordinateSuggestions
DEFAULT_WORLD_3 - Static variable in class net.forthecrown.grenadier.types.CoordinateSuggestions
dispatcher() - Static method in class net.forthecrown.grenadier.Grenadier: Gets the command dispatcher.
displayName() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the display name of this source
doubleRange() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the double range argument.
DoubleRangeArgument - Interface in net.forthecrown.grenadier.types: Argument type that returns a range between 2 double values.
DoubleRangeArgument.DoubleRange - Interface in net.forthecrown.grenadier.types: Range between double values

E

EMPTY - Static variable in class net.forthecrown.grenadier.Readers: An empty input string reader
EMPTY - Static variable in interface net.forthecrown.grenadier.types.options.ParsedOptions: Parsed options instance with no options
EMPTY_COORDINATE - Static variable in interface net.forthecrown.grenadier.types.ParsedPosition: Empty coordinate which always returns the base coordinate in ParsedPosition.Coordinate.apply(double)
enchantment() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Delegate for ArgumentTypes.registry(Registry, String) with Registry.ENCHANTMENT
ensureValidLabel(String) - Static method in class net.forthecrown.grenadier.Grenadier: Ensures a specified command label is valid.
entities() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an entity selector argument that allows for multiple entities to be returned
entity() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an entity selector argument that is allowed to only return 1 entity
EntityArgument - Interface in net.forthecrown.grenadier.types: Parses an entity selector
EntitySelector - Interface in net.forthecrown.grenadier.types: Parsed representation of an entity selector.
EnumArgument<E extends Enum<E>> - Interface in net.forthecrown.grenadier.types: Parses an enum value by its name.
enumType(Class<E>) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Creates an enum argument for the specified enumType
equals(Object) - Method in record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Indicates whether some other object is "equal to" this one.
ERROR_MESSAGE_STYLE - Static variable in class net.forthecrown.grenadier.SyntaxExceptions: The default style of the error messages, red by default
ExceptionProvider - Interface in net.forthecrown.grenadier
exceptions() - Static method in class net.forthecrown.grenadier.Grenadier: Gets the exception factory
executes(Command<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommand

F

facing(Block) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source facing the given block
facing(Entity) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source facing the given entity's location
facing(LivingEntity, LookAnchor) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source facing the given entity's anchor look point.
facing(Location) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source facing the given location.
facing(Vector) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source that's facing the given vector.
fallbackPrefix() - Static method in class net.forthecrown.grenadier.Grenadier: Gets the command fallback prefix, this is prepended onto command labels to prevent commands from overriding eachother.
findEntities(CommandSource) - Method in interface net.forthecrown.grenadier.types.EntitySelector: Finds multiple entities
findEntity(CommandSource) - Method in interface net.forthecrown.grenadier.types.EntitySelector: Finds a single entity
findPlayer(CommandSource) - Method in interface net.forthecrown.grenadier.types.EntitySelector: Finds a single player.
findPlayers(CommandSource) - Method in interface net.forthecrown.grenadier.types.EntitySelector: Finds multiple players
flag() - Static method in class net.forthecrown.grenadier.types.options.Options: Creates a new flag builder
flag(String) - Static method in class net.forthecrown.grenadier.types.options.Options: Creates a flag option with a single label
flagAlreadySet(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
FlagOption - Interface in net.forthecrown.grenadier.types.options: An option that doesn't require a value.
FlagOption.Builder - Interface in net.forthecrown.grenadier.types.options: Flag builder
forEachLabel(Consumer<String>) - Method in class net.forthecrown.grenadier.GrenadierCommandNode
fork(CommandNode<CommandSource>, RedirectModifier<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommand
FORMAT - Static variable in interface net.forthecrown.grenadier.types.LocalDateArgument
formatCommandException(CommandSyntaxException) - Static method in class net.forthecrown.grenadier.SyntaxExceptions: Formats a command exception into a single formatted text.
formatExceptionContext(CommandSyntaxException) - Static method in class net.forthecrown.grenadier.SyntaxExceptions: Formats a command syntax exception's context into a single text.
formatMessage(Audience, Component, CommandSource) - Method in interface net.forthecrown.grenadier.CommandBroadcastEvent.Formatter: Formats a broadcast message
forSuggestions(SuggestionsBuilder) - Static method in class net.forthecrown.grenadier.Readers: Creates a reader with the specified builder's input and SuggestionsBuilder.getStart() as the reader's cursor
forward(CommandNode<CommandSource>, RedirectModifier<CommandSource>, boolean) - Method in class net.forthecrown.grenadier.GrenadierCommand
fromMessage(Message) - Static method in class net.forthecrown.grenadier.Grenadier: Converts a Brigadier message to a component.
fromMessage(Message) - Method in interface net.forthecrown.grenadier.GrenadierProvider

G

GAME_MASTERS - Enum constant in enum class net.forthecrown.grenadier.PermissionLevel: Game masters
gameMode() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the gamemode argument
GameModeArgument - Interface in net.forthecrown.grenadier.types: Argument type that parses a gamemode.
getAliases() - Method in class net.forthecrown.grenadier.AbstractCommand
getAliases() - Method in class net.forthecrown.grenadier.GrenadierCommand
getAliases() - Method in class net.forthecrown.grenadier.GrenadierCommandNode
getAnchor() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the source's anchor point, either their feet or eyes.
getAnchoredLocation() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the location of the source with the CommandSource.getAnchor() vertical offset applied.
getArguments(CommandContext<S>) - Static method in class net.forthecrown.grenadier.CommandContexts: Gets all parsed arguments in the specified context.
getArgumentType() - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption: Gets the option's argument type.
getBuiltNode() - Method in class net.forthecrown.grenadier.AbstractCommand: Gets the built grenadier command node.
getCommand() - Method in class net.forthecrown.grenadier.AbstractCommand
getCondition() - Method in interface net.forthecrown.grenadier.types.options.Option: Gets the condition that must be passed in order to use this option and to later access it in ParsedOptions
getCoordinates() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Gets all the coordinates of this parsed position.
getCurrentNode() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the current command the sender is using, null if no command is currently in use
getDefaultValue() - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption: Gets the option's default value.
getDescription() - Method in class net.forthecrown.grenadier.AbstractCommand
getDescription() - Method in class net.forthecrown.grenadier.GrenadierCommand
getDescription() - Method in class net.forthecrown.grenadier.GrenadierCommandNode
getDispatcher() - Method in interface net.forthecrown.grenadier.GrenadierProvider
getDuration(CommandContext<?>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a parsed duration
getEntities(CommandContext<CommandSource>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a list of entities from a parsed entity selector
getEntity(CommandContext<CommandSource>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a single entity from parsed a entity selector
getEntitySuggestions() - Method in interface net.forthecrown.grenadier.CommandSource: Gets all entities this source may be looking at and returns their UUIDs for suggestions.
getEntries() - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument: Gets an unmodifiable collection of all argument entries
getEntry(ArgumentOption<T>) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument: Gets an argument entry
getEnumType() - Method in interface net.forthecrown.grenadier.types.EnumArgument: Gets the enum class
getExceptionFactory() - Method in interface net.forthecrown.grenadier.types.RegistryArgument
getExceptionHandler() - Method in interface net.forthecrown.grenadier.GrenadierProvider
getExceptionProvider() - Method in interface net.forthecrown.grenadier.GrenadierProvider
getFormatter() - Method in class net.forthecrown.grenadier.CommandBroadcastEvent: Gets the broadcast message formatter
getHandlerList() - Static method in class net.forthecrown.grenadier.CommandBroadcastEvent
getHandlers() - Method in class net.forthecrown.grenadier.CommandBroadcastEvent
getInput(CommandContext<?>, String) - Static method in class net.forthecrown.grenadier.CommandContexts: Gets the input for a specific node in a command context
getLabels() - Method in interface net.forthecrown.grenadier.types.options.Option: Gets labels that can be used to parse this option
getLocation() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the sender's location
getLocation(CommandContext<CommandSource>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a parsed location.
getMaterial() - Method in interface net.forthecrown.grenadier.types.ItemArgument.Result: Gets the Material of the item that was parsed
getMaterials() - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument.Result: Gets all materials that are valid for this result
getMaterials() - Method in interface net.forthecrown.grenadier.types.ItemFilterArgument.Result: Gets an unmodifiable list of all materials that are valid for this result
getMaxResults() - Method in interface net.forthecrown.grenadier.types.EntitySelector: Gets the maximum amount of results
getMessage() - Method in class net.forthecrown.grenadier.CommandBroadcastEvent: Gets the message of the announcement
getMillis(CommandContext<?>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a parsed duration, in milliseconds
getName() - Method in class net.forthecrown.grenadier.AbstractCommand: Gets the command's name.
getNodeRange(CommandContext<?>, String) - Static method in class net.forthecrown.grenadier.CommandContexts: Gets the input range of the specified nodeName within the specified context.
getOption(String) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument: Gets an option in this argument by its label
getOptions() - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument: Gets an unmodifiable set of all options added to this argument
getParsedOption(String) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Gets a parsed option by one of its labels
getParsedOption(Option) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Gets a parsed option
getParsedProperties() - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Gets a name to value map of all block properties that were explicitly parsed.
getParsedProperties() - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument.Result: Gets a name to value map of all explicitly parsed properties
getParsedState() - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Gets the parsed block state
getParsedValue(ArgumentOption<T>) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Gets a parsed value
getPermission() - Method in class net.forthecrown.grenadier.AbstractCommand
getPermission() - Method in class net.forthecrown.grenadier.GrenadierCommand
getPermission() - Method in class net.forthecrown.grenadier.GrenadierCommandNode
getPermissionLevel() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the source's permission level
getPlayer(CommandContext<CommandSource>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a single player from a parsed entity selector
getPlayers(CommandContext<CommandSource>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a list of players from a parsed entity selector
getPlugin() - Method in interface net.forthecrown.grenadier.GrenadierProvider
getProvider() - Static method in class net.forthecrown.grenadier.Grenadier: Gets or creates the grenadier provider
getRegistry() - Method in interface net.forthecrown.grenadier.types.RegistryArgument
getRelevant2DCords() - Method in interface net.forthecrown.grenadier.CommandSource: Gets a coordinate suggestion relevant to this source, or null, if no relevant cords were found in a 5 block distance
getRelevant3DCords() - Method in interface net.forthecrown.grenadier.CommandSource: Gets a coordinate suggestion relevant to this source, or null, if no relevant cords were found in a 5 block distance
getSelector(CommandContext<?>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an entity selector from a specified context
getServer() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the server
getSource() - Method in class net.forthecrown.grenadier.CommandBroadcastEvent: Gets the source of the broadcast
getSuggester() - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption: Gets the suggestion provider for this option.
getSuggestions(CommandContext<CommandSource>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption
getSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.Suggester
getTag() - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Gets the NBT tag that was parsed
getTag() - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument.Result: Gets the parsed NBT tag
getTag() - Method in interface net.forthecrown.grenadier.types.ItemArgument.Result: Gets the NBT tag of the item that was parsed.
getTag() - Method in interface net.forthecrown.grenadier.types.ItemFilterArgument.Result: Gets a copy of the parsed NBT tag
getThis() - Method in class net.forthecrown.grenadier.GrenadierCommand
getTicks(CommandContext<?>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets a parsed duration, in game ticks
getTooltip() - Method in interface net.forthecrown.grenadier.types.options.Option: Gets the tooltip shown when hovering over the option's labels in command suggestions
getType() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Gets the parsed location's type.
getValue(ArgumentOption<T>) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Gets an argument option's parsed value.
getValue(ArgumentOption<T>, CommandSource) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Gets an argument option's parsed value and tests if the specified source is allowed to access its value.
getValueOptional(ArgumentOption<T>) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Delegate for ParsedOptions.getValue(ArgumentOption) that wraps the result in an optional
getValueOptional(ArgumentOption<T>, CommandSource) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Delegate for ParsedOptions.getValue(ArgumentOption, CommandSource) that wraps the result in an optional
getViewers() - Method in class net.forthecrown.grenadier.CommandBroadcastEvent: Gets a mutable set of broadcast viewers.
getVisiblePlayers() - Method in interface net.forthecrown.grenadier.CommandSource: Gets all players visible to this source
getWorld() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the world the sender is in
getXCoordinate() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Gets the X coordinate
getYCoordinate() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Gets the Y coordinate
getZCoordinate() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Gets the Z coordinate
GRAY_CONTEXT_STYLE - Static variable in class net.forthecrown.grenadier.SyntaxExceptions: The style of the text in the context, gray by default
Grenadier - Class in net.forthecrown.grenadier: Grenadier singleton access
GrenadierCommand - Class in net.forthecrown.grenadier: Grenadier command builder
GrenadierCommand(String) - Constructor for class net.forthecrown.grenadier.GrenadierCommand
GrenadierCommandNode - Class in net.forthecrown.grenadier
GrenadierCommandNode(String, Command<CommandSource>, Predicate<CommandSource>, CommandNode<CommandSource>, RedirectModifier<CommandSource>, boolean, String, String, List<String>) - Constructor for class net.forthecrown.grenadier.GrenadierCommandNode
GrenadierProvider - Interface in net.forthecrown.grenadier

H

handle(CommandSyntaxException, CommandSource) - Static method in class net.forthecrown.grenadier.SyntaxExceptions: Handles a syntax exception
has(Option) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Tests if the specified option is present
hasFlag(FlagOption, CommandSource) - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions: Tests if the specified flag option is present and that the specified source is allowed to access it.
hashCode() - Method in record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Returns a hash code value for this object.
hasPermission(String) - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the sender has the given permission
hasPermission(String, PermissionLevel) - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the sender has both the bukkit permission and the OP permission level
hasPermission(PermissionLevel) - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the sender has the vanilla OP level
hasPermission(Permission) - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the sender has the given permission
HERE_POINTER_STYLE - Static variable in class net.forthecrown.grenadier.SyntaxExceptions: The style of the <--[HERE] pointer, italic red by default
HOURS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit

I

IDENTITY - Static variable in interface net.forthecrown.grenadier.types.ParsedPosition: Empty position that always returns the input in ParsedPosition.apply(Location)
includesEntities() - Method in interface net.forthecrown.grenadier.types.EntityArgument: Gets whether the resulting selector is allowed to include entities or is limited to just players
includesEntities() - Method in interface net.forthecrown.grenadier.types.EntitySelector: Tests if this selector includes all entities, or only players
intRange() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the double range argument.
IntRangeArgument - Interface in net.forthecrown.grenadier.types: Argument type that returns a range between 2 integer values.
IntRangeArgument.IntRange - Interface in net.forthecrown.grenadier.types: Range between integer values
invalidEnum(Class<E>, String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
invalidKey(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
invalidTimeUnit(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
is(Class<T>) - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the sender is of the type
isCancelled() - Method in class net.forthecrown.grenadier.CommandBroadcastEvent
isEntity() - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the source is an entity
isExact() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Tests if this range is exact
isExact() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Tests if this range is exact
isIdentity() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Tests if this position will return the input in ParsedPosition.apply(Location)
isMaxLimited() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Tests if this range has a maximum limit
isMaxLimited() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Tests if this range has a maximum limit
isMinLimited() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Tests if this range has a minimum limit
isMinLimited() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Tests if this range has a minimum limit
isOp() - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the sender is opped
isPlayer() - Method in interface net.forthecrown.grenadier.CommandSource: Checks if the source is a player
isSelfSelector() - Method in interface net.forthecrown.grenadier.types.EntitySelector: Tests if this selector is a self selector
isSilent() - Method in interface net.forthecrown.grenadier.CommandSource: Checks if this source is 'silent', meaning it doesn't accept any messages
isTwoDimensional() - Method in interface net.forthecrown.grenadier.types.CoordinateSuggestion
isTwoDimensional() - Method in interface net.forthecrown.grenadier.types.ParsedPosition: Tests if this position is two-dimensional
isUnlimited() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Tests if this range is unlimited.
isUnlimited() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Tests if this range is unlimited.
isValidInput(String) - Method in class net.forthecrown.grenadier.GrenadierCommandNode
isWorldLimited() - Method in interface net.forthecrown.grenadier.types.EntitySelector: Tests if this selector is limited by world
item() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the item argument
ItemArgument - Interface in net.forthecrown.grenadier.types: Argument type that parses item data like an the material the item is made of and NBT data.
ItemArgument.Result - Interface in net.forthecrown.grenadier.types: Parsed item result, contains the data that was parsed which can be used to create an itemstack instance
itemFilter() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the item filter argument
ItemFilterArgument - Interface in net.forthecrown.grenadier.types: Parses a similar result to ItemArgument, with the difference that this argument type allows item tags, allowing this to match several materials at once.
ItemFilterArgument.Result - Interface in net.forthecrown.grenadier.types: Parsed predicate result

K

key() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the namespaced key argument
KeyArgument - Interface in net.forthecrown.grenadier.types

L

labels() - Method in class net.forthecrown.grenadier.GrenadierCommandNode
listSuggestions(CommandContext<CommandSource>, SuggestionsBuilder) - Method in class net.forthecrown.grenadier.GrenadierCommandNode
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.ArrayArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.BlockArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.EntityArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.EnumArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.GameModeArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.ItemArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.ItemFilterArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.LocalDateArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.LootTableArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.MapArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.ObjectiveArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.ParticleArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.PositionArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.RegistryArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.TeamArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.TimeArgument
listSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in interface net.forthecrown.grenadier.types.WorldArgument
listType() - Method in interface net.forthecrown.grenadier.types.ArrayArgument: Gets the base argument type
literal(String) - Static method in class net.forthecrown.grenadier.Nodes: Creates a literal argument builder
LOCAL - Enum constant in enum class net.forthecrown.grenadier.types.ParsedPosition.Type: Position is local to the direction a command source is facing
localDate() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the local date argument
LocalDateArgument - Interface in net.forthecrown.grenadier.types
LOOKUP - Static variable in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
lootTable() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the loot table argument
LootTableArgument - Interface in net.forthecrown.grenadier.types

M

map(ArgumentType<F>, Function<F, T>) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Maps one argument types results to another type.
map(Map<String, T>) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Creates a map-based argument type with the specified backing map.
MapArgument<T> - Interface in net.forthecrown.grenadier.types
matches(String, String) - Static method in class net.forthecrown.grenadier.Completions: Checks if the given string starts with the given token
matches(String, Key) - Static method in class net.forthecrown.grenadier.Completions: Tests if the given key is a valid suggestion for the given token
max() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Gets the maximum value
max() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Gets the maximum value
MILLIS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
min() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Gets the minimum value
min() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Gets the minimum value
MINUTES - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
missingOption(ArgumentOption<?>) - Method in interface net.forthecrown.grenadier.ExceptionProvider
mixedPosition(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
MODERATORS - Enum constant in enum class net.forthecrown.grenadier.PermissionLevel: Moderators
MONTHS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit

N

NbtArgument<T extends BinaryTag> - Interface in net.forthecrown.grenadier.types
net.forthecrown.grenadier - package net.forthecrown.grenadier: Main Grenadier package, see below for use guides.
net.forthecrown.grenadier.types - package net.forthecrown.grenadier.types: Contains the various built-in argument types Grenadier has.
net.forthecrown.grenadier.types.options - package net.forthecrown.grenadier.types.options: The OptionsArgument allows for the parsing of a list of options and flags.
Nodes - Class in net.forthecrown.grenadier: Utility class for creating argument builder specific to grenadier
Nodes() - Constructor for class net.forthecrown.grenadier.Nodes
noEntityFound() - Method in interface net.forthecrown.grenadier.ExceptionProvider
noPlayerFound() - Method in interface net.forthecrown.grenadier.ExceptionProvider

O

objective() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the scoreboard objective argument
ObjectiveArgument - Interface in net.forthecrown.grenadier.types
onCommandException(StringReader, Throwable, CommandSource) - Method in interface net.forthecrown.grenadier.CommandExceptionHandler: Handles an exception thrown during command execution
onSuggestionException(String, Throwable, CommandSource) - Method in interface net.forthecrown.grenadier.CommandExceptionHandler: Handles an exception thrown during command suggestion creation
option() - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.ArgumentEntry: Gets the option
option() - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions.ParsedOption: Gets the option
option() - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions.ParsedValue: Gets the argument
Option - Interface in net.forthecrown.grenadier.types.options: An option within an OptionsArgument
Option.OptionBuilder<T extends Option.OptionBuilder<T>> - Interface in net.forthecrown.grenadier.types.options: Option builder
optionalAs(Class<T>) - Method in interface net.forthecrown.grenadier.CommandSource: Creates an optional that's empty if this source's backing CommandSender is not of the given type, if the sender is of the given type, then the optional will contain the sender casted to the given type
optionAlreadySet(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
Options - Class in net.forthecrown.grenadier.types.options: Static factory class for FlagOption and ArgumentOption instances and builders.
OptionsArgument - Interface in net.forthecrown.grenadier.types.options: Argument type that parses a list of options
OptionsArgument.ArgumentEntry<T> - Interface in net.forthecrown.grenadier.types.options: A single ArgumentOption entry
OptionsArgument.Builder - Interface in net.forthecrown.grenadier.types.options: Options argument builder
overrideSelectorPermissions() - Method in interface net.forthecrown.grenadier.CommandSource: Tests if this source has selector permission overriding enabled
overstacked(Material) - Method in interface net.forthecrown.grenadier.ExceptionProvider
OWNERS - Enum constant in enum class net.forthecrown.grenadier.PermissionLevel: Server owners

P

parse(StringReader) - Method in class net.forthecrown.grenadier.GrenadierCommandNode
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.ArrayArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.BlockArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.ComponentArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.EntityArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.EnumArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.GameModeArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.IntRangeArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.ItemArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.ItemFilterArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.KeyArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.LocalDateArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.LootTableArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.MapArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.NbtArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.ObjectiveArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.ParticleArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.PositionArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.RegistryArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.TagPathArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.TeamArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.TimeArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.UuidArgument
parse(StringReader) - Method in interface net.forthecrown.grenadier.types.WorldArgument
parse(StringReader, boolean) - Method in interface net.forthecrown.grenadier.types.EntityArgument
parse(StringReader, CommandContextBuilder<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommandNode
ParsedOptions - Interface in net.forthecrown.grenadier.types.options: Options that were parsed by OptionsArgument
ParsedOptions.ParsedOption - Interface in net.forthecrown.grenadier.types.options: Parse data about an option
ParsedOptions.ParsedValue<T> - Interface in net.forthecrown.grenadier.types.options: Parse data about a parsed value
ParsedPosition - Interface in net.forthecrown.grenadier.types
ParsedPosition.Coordinate - Record Class in net.forthecrown.grenadier.types: Single parsed coordinate
ParsedPosition.Type - Enum Class in net.forthecrown.grenadier.types: Position local coordinate type
particle() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the particle argument
ParticleArgument - Interface in net.forthecrown.grenadier.types
pathParseException(PathParseException, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
PermissionLevel - Enum Class in net.forthecrown.grenadier: Vanilla permission levels
place(Location) - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Delegate for BlockArgument.Result.place(World, int, int, int, boolean) where the world and coordinates are gotten from the specified location and where the 'updatePhysics' parameter is set to true
place(Location, boolean) - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Delegate for BlockArgument.Result.place(World, int, int, int, boolean) where the world and coordinates are gotten from the specified location
place(World, int, int, int) - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Delegate for BlockArgument.Result.place(World, int, int, int, boolean) with the 'updatePhysics' parameter set to true
place(World, int, int, int, boolean) - Method in interface net.forthecrown.grenadier.types.BlockArgument.Result: Places the parsed block in the specified world at the x, y, z coordinates and optionally sets any NBT that was parsed, if, the parsed block type is a tile entity.
player() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an entity selector argument that only allows a single player to be returned
players() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets and entity selector argument that is only allowed to return players
plugin() - Static method in class net.forthecrown.grenadier.Grenadier: Gets the plugin using grenadier.
plugin(Plugin) - Static method in class net.forthecrown.grenadier.Grenadier: Sets the plugin using grenadier
position() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an argument that parses a 3D floating point position
position2d() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets an argument that parses a 2D floating point position
PositionArgument - Interface in net.forthecrown.grenadier.types
posNotComplete(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
potionType() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Delegate for ArgumentTypes.registry(Registry, String) with Registry.POTION_EFFECT_TYPE
PRIMITIVE_TO_WRAPPER - Static variable in class net.forthecrown.grenadier.CommandContexts: Map of primitive classes to their Java Object wrappers, for example, this maps a byte primitive to Byte.

R

range() - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions.ParsedOption: Gets the string range that represents the start and end of this option's input
rangeEmpty(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
rangeInverted(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
Readers - Class in net.forthecrown.grenadier: Utility class for StringReader related things
readPositiveInt(StringReader, int, int) - Static method in class net.forthecrown.grenadier.Readers: Reads a positive integer from the input.
readUntilWhitespace(StringReader) - Static method in class net.forthecrown.grenadier.Readers: Reads until the next whitespace character or until the end of the input is reached
RED_CONTEXT_STYLE - Static variable in class net.forthecrown.grenadier.SyntaxExceptions: The style of the part of the context where you went wrong, underlined red by default
redirect(CommandNode<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommand
redirect(CommandNode<CommandSource>, SingleRedirectModifier<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommand
register() - Method in class net.forthecrown.grenadier.AbstractCommand: Builds the command tree using CommandTreeBuilder.createCommand(GrenadierCommand) and then registers it.
register() - Method in class net.forthecrown.grenadier.GrenadierCommand
registry(Registry<T>, String) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Creates a registry argument with the specified backing registry and specified name
registry(Registry<T>, RegistryArgument.UnknownFactory) - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Creates a registry argument with the specified backing registry and specified exception factory
RegistryArgument<T extends Keyed> - Interface in net.forthecrown.grenadier.types
RegistryArgument.UnknownFactory - Interface in net.forthecrown.grenadier.types
relative() - Method in record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Returns the value of the relative record component.
required() - Method in interface net.forthecrown.grenadier.types.options.OptionsArgument.ArgumentEntry: Gets if a value for the OptionsArgument.ArgumentEntry.option() is required
requires(Predicate<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommand

S

SECONDS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
selectorOnlyOneEntity(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
selectorOnlyOnePlayer(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
selectorOnlyPlayersAllowed(StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
sendFailure(Component) - Method in interface net.forthecrown.grenadier.CommandSource: Send a command failure message
sendFailure(Component, boolean) - Method in interface net.forthecrown.grenadier.CommandSource: Send a command failure message
sendMessage(String) - Method in interface net.forthecrown.grenadier.CommandSource: Sends a message to the sender
sendMessage(String...) - Method in interface net.forthecrown.grenadier.CommandSource: Sends several messages to the sender lol
sendSuccess(Component) - Method in interface net.forthecrown.grenadier.CommandSource: Sends a success message
sendSuccess(Component, boolean) - Method in interface net.forthecrown.grenadier.CommandSource: Send a command success message
setAliases(String...) - Method in class net.forthecrown.grenadier.AbstractCommand
setAliases(Collection<String>) - Method in class net.forthecrown.grenadier.AbstractCommand
setCancelled(boolean) - Method in class net.forthecrown.grenadier.CommandBroadcastEvent
setCondition(Predicate<CommandSource>) - Method in interface net.forthecrown.grenadier.types.options.Option.OptionBuilder: Sets the option's use condition
setCurrentNode(GrenadierCommandNode) - Method in interface net.forthecrown.grenadier.CommandSource: Sets the current command the sender is using
setDefaultValue(T) - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption.Builder: Sets the default value of the option
setDescription(String) - Method in class net.forthecrown.grenadier.AbstractCommand
setExceptionHandler(CommandExceptionHandler) - Method in interface net.forthecrown.grenadier.GrenadierProvider
setFormatter(CommandBroadcastEvent.Formatter) - Method in class net.forthecrown.grenadier.CommandBroadcastEvent: Sets the broadcast message formatter
setLabels(String...) - Method in interface net.forthecrown.grenadier.types.options.Option.OptionBuilder: Sets this option's labels
setMessage(Component) - Method in class net.forthecrown.grenadier.CommandBroadcastEvent: Sets the announcement message
setPermission(String) - Method in interface net.forthecrown.grenadier.types.options.Option.OptionBuilder: Sets the option's use condition to be a permission check for the specified permission
setPermission(Permission) - Method in interface net.forthecrown.grenadier.types.options.Option.OptionBuilder: Sets the option's use condition to be a permission check for the specified permission
setPermission(String) - Method in class net.forthecrown.grenadier.AbstractCommand
setPermission(Permission) - Method in class net.forthecrown.grenadier.AbstractCommand
setPlugin(Plugin) - Method in interface net.forthecrown.grenadier.GrenadierProvider
setSuggester(Suggester<CommandSource>) - Method in interface net.forthecrown.grenadier.types.options.ArgumentOption.Builder: Sets the suggestion provider.
setTooltip(Component) - Method in interface net.forthecrown.grenadier.types.options.Option.OptionBuilder: Sets the tooltip shown when hovering over the option's name in suggestions
shouldInformAdmins() - Method in interface net.forthecrown.grenadier.CommandSource: Gets if the sender should broadcast admin messages
silent() - Method in interface net.forthecrown.grenadier.CommandSource: Creates a silent command source
skipIrrelevantInput(StringReader) - Static method in class net.forthecrown.grenadier.Readers: Skips any 'irrelevant' input.
sourceMustBe(Class<T>) - Method in interface net.forthecrown.grenadier.ExceptionProvider
startsWith(StringReader, String) - Static method in class net.forthecrown.grenadier.Readers: Tests if the given reader starts with a specified string
startsWithArgument(StringReader, String) - Static method in class net.forthecrown.grenadier.Readers: Similar to Readers.startsWithIgnoreCase(StringReader, String), except that this method requires the specified literal be followed either by the end of the input, or a whitespace character
startsWithIgnoreCase(StringReader, String) - Static method in class net.forthecrown.grenadier.Readers: Same as Readers.startsWith(StringReader, String) except case is ignored
suggest(SuggestionsBuilder, Iterable<String>) - Static method in class net.forthecrown.grenadier.Completions: Suggest all matching strings into the given SuggestionsBuilder
suggest(SuggestionsBuilder, String...) - Static method in class net.forthecrown.grenadier.Completions: Suggest all matching strings into the given SuggestionsBuilder
suggest(SuggestionsBuilder, Stream<String>) - Static method in class net.forthecrown.grenadier.Completions: Suggest all matching strings into the given SuggestionsBuilder
suggestAllCommands() - Static method in class net.forthecrown.grenadier.Grenadier: Gets a suggestion provider that suggests all commands currently registered on the server.
suggestAllCommands() - Method in interface net.forthecrown.grenadier.GrenadierProvider
suggestCoordinates(SuggestionsBuilder, Collection<CoordinateSuggestion>) - Static method in class net.forthecrown.grenadier.Completions: Suggests a collection of coordinate suggestions
Suggester<S> - Interface in net.forthecrown.grenadier: An type of SuggestionProvider that is not allowed to throw CommandSyntaxExceptions
suggestKeyed(SuggestionsBuilder, Iterable<? extends Keyed>) - Static method in class net.forthecrown.grenadier.Completions: Suggests all input-matching keyed objects in the specified iterable.
suggestObjectives(SuggestionsBuilder) - Static method in class net.forthecrown.grenadier.Completions: Suggests scoreboard objectives
suggestTeams(SuggestionsBuilder) - Static method in class net.forthecrown.grenadier.Completions: Suggests scoreboard team names
suggestWorlds(SuggestionsBuilder) - Static method in class net.forthecrown.grenadier.Completions: Suggests all currently loaded worlds
SyntaxExceptions - Class in net.forthecrown.grenadier: Methods to handle and format CommandSyntaxException instances.

T

tagParseException(TagParseException, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
tagPath() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the NBT path argument
TagPathArgument - Interface in net.forthecrown.grenadier.types
team() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the scoreboard team argument
TeamArgument - Interface in net.forthecrown.grenadier.types
test(CommandSource) - Method in class net.forthecrown.grenadier.AbstractCommand
test(CommandSource) - Method in interface net.forthecrown.grenadier.types.options.Option: Tests if the source passes the Option.getCondition() test
test(Block) - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument.Result: Calls BlockFilterArgument.Result.test(BlockState) with Block.getState()
test(BlockState) - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument.Result: Tests the specified state against this result
test(BlockData) - Method in interface net.forthecrown.grenadier.types.BlockFilterArgument.Result: Tests the specified data against this result.
test(ItemStack) - Method in interface net.forthecrown.grenadier.types.ItemFilterArgument.Result: Tests an item against this predicate.
textName() - Method in interface net.forthecrown.grenadier.CommandSource: Gets the string representation of the display name
then(ArgumentBuilder<CommandSource, ?>) - Method in class net.forthecrown.grenadier.GrenadierCommand
then(CommandNode<CommandSource>) - Method in class net.forthecrown.grenadier.GrenadierCommand
TICKS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
time() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the time duration argument
TimeArgument - Interface in net.forthecrown.grenadier.types: Parses a duration
TimeArgument.Unit - Enum Class in net.forthecrown.grenadier.types: All supported time units that can be parsed
toMessage(Component) - Static method in class net.forthecrown.grenadier.Grenadier: Converts the adventure component to a message.
toMessage(Component) - Method in interface net.forthecrown.grenadier.GrenadierProvider
tooltip() - Method in interface net.forthecrown.grenadier.types.CoordinateSuggestion
toRange() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Translates this parsed range into a Guava range
toRange() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Translates this parsed range into a Guava range
toString() - Method in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Converts this range into a parse-able string
toString() - Method in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Converts this range into a parse-able string
toString() - Method in record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Returns a string representation of this record class.

U

unknownGamemode(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownLootTable(NamespacedKey, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownMapValue(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownObjective(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownOption(StringReader, String) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownResource(NamespacedKey, String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownTeam(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
unknownWorld(String, StringReader) - Method in interface net.forthecrown.grenadier.ExceptionProvider
UNLIMITED - Static variable in interface net.forthecrown.grenadier.types.DoubleRangeArgument.DoubleRange: Unlimited range
UNLIMITED - Static variable in interface net.forthecrown.grenadier.types.IntRangeArgument.IntRange: Unlimited range
usedLabel() - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions.ParsedOption: Gets the label that was used to identify the ParsedOptions.ParsedOption.option() during parsing
uuid() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the UUID argument
UuidArgument - Interface in net.forthecrown.grenadier.types: Parses a hexadecimal UUID

V

validateLabel(String) - Static method in class net.forthecrown.grenadier.types.options.Options: Tests if a specified label is a valid label for an option.
value() - Method in interface net.forthecrown.grenadier.types.options.ParsedOptions.ParsedValue: Gets the parsed value
value() - Method in record class net.forthecrown.grenadier.types.ParsedPosition.Coordinate: Returns the value of the value record component.
valueOf(String) - Static method in enum class net.forthecrown.grenadier.PermissionLevel: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.forthecrown.grenadier.types.ParsedPosition.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.forthecrown.grenadier.types.TimeArgument.Unit: Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.forthecrown.grenadier.PermissionLevel: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Method in interface net.forthecrown.grenadier.types.MapArgument
values() - Static method in enum class net.forthecrown.grenadier.types.ParsedPosition.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.forthecrown.grenadier.types.TimeArgument.Unit: Returns an array containing the constants of this enum class, in the order they are declared.

W

WEEKS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit
withAliases(String...) - Method in class net.forthecrown.grenadier.GrenadierCommand
withAliases(Collection<String>) - Method in class net.forthecrown.grenadier.GrenadierCommand
withDescription(String) - Method in class net.forthecrown.grenadier.GrenadierCommand
withLocation(Location) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source at the given location.
withMaximumLevel(PermissionLevel) - Method in interface net.forthecrown.grenadier.CommandSource: Returns either a new source with the specified permission level, or this source, if it already has the specified level
withOutput(CommandSender) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command sender with the given command sender.
withPermission(String) - Method in class net.forthecrown.grenadier.GrenadierCommand
withPermission(Permission) - Method in class net.forthecrown.grenadier.GrenadierCommand
withPermissionLevel(PermissionLevel) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a copy of this command source that has the specified level
withPosition(Vector) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source at the given position.
withRotation(float, float) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source that's rotated with the given yaw and pitch
withWorld(World) - Method in interface net.forthecrown.grenadier.CommandSource: Creates a command source in the given world.
WORD_PATTERN - Static variable in class net.forthecrown.grenadier.Readers
world() - Static method in class net.forthecrown.grenadier.types.ArgumentTypes: Gets the world argument
WORLD - Enum constant in enum class net.forthecrown.grenadier.types.ParsedPosition.Type: Position is local to a command source's world coordinates
WorldArgument - Interface in net.forthecrown.grenadier.types: Parses a world by its name or by its namespaced key.

X

x() - Method in interface net.forthecrown.grenadier.types.CoordinateSuggestion

Y

y() - Method in interface net.forthecrown.grenadier.types.CoordinateSuggestion
YEARS - Enum constant in enum class net.forthecrown.grenadier.types.TimeArgument.Unit

Z

z() - Method in interface net.forthecrown.grenadier.types.CoordinateSuggestion

A B C D E F G H I K L M N O P R S T U V W X Y Z
All Classes and Interfaces|All Packages|Constant Field Values