Index (cloud-brigadier 2.0.0-beta.2 API)

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

A

apply(ArgumentType<T>, StringReader) - Method in interface org.incendo.cloud.brigadier.parser.WrappedBrigadierParser.ParseFunction: Apply the parse function.
ArgumentTypeFactory<T> - Interface in org.incendo.cloud.brigadier.argument

B

BRIGADIER_SUGGESTIONS - Enum constant in enum org.incendo.cloud.brigadier.suggestion.SuggestionsType: Brigadier will be invoked for suggestions.
brigadierManager() - Method in interface org.incendo.cloud.brigadier.BrigadierManagerHolder: Get the CloudBrigadierManager used by this command manager.
BrigadierManagerHolder<C,S> - Interface in org.incendo.cloud.brigadier: Interface implemented by command managers that are capable of registering commands to Brigadier using CloudBrigadierManager.
BrigadierManagerHolder.BrigadierManagerNotPresent - Exception in org.incendo.cloud.brigadier: Exception thrown when BrigadierManagerHolder.brigadierManager() is called and BrigadierManagerHolder.hasBrigadierManager() is false.
BrigadierManagerNotPresent(String) - Constructor for exception org.incendo.cloud.brigadier.BrigadierManagerHolder.BrigadierManagerNotPresent: Creates a new BrigadierManagerHolder.BrigadierManagerNotPresent exception.
BrigadierMapping<C,K extends org.incendo.cloud.parser.ArgumentParser<C,?>,S> - Class in org.incendo.cloud.brigadier.argument
BrigadierMappingBuilder<K extends org.incendo.cloud.parser.ArgumentParser<?,?>,S> - Interface in org.incendo.cloud.brigadier.argument: A builder for a mapping between a Cloud parser and a Brigadier ArgumentType
BrigadierMappingBuilder.SuggestionProviderSupplier<K extends org.incendo.cloud.parser.ArgumentParser<?,?>,S> - Interface in org.incendo.cloud.brigadier.argument
BrigadierMappings<C,S> - Interface in org.incendo.cloud.brigadier.argument
BrigadierNodeFactory<C,S,N extends com.mojang.brigadier.tree.CommandNode<S>> - Interface in org.incendo.cloud.brigadier.node
BrigadierPermissionChecker<C> - Interface in org.incendo.cloud.brigadier.permission
BrigadierPermissionPredicate<C,S> - Class in org.incendo.cloud.brigadier.permission
BrigadierPermissionPredicate(SenderMapper<S, C>, BrigadierPermissionChecker<C>, CommandNode<?>) - Constructor for class org.incendo.cloud.brigadier.permission.BrigadierPermissionPredicate: Returns a new predicate that uses the given permissionChecker to evaluate the permission attached to the given node.
BrigadierSetting - Enum in org.incendo.cloud.brigadier: Configurable options that determine how CloudBrigadierManager behaves.
BrigadierSuggestionFactory<C,S> - Class in org.incendo.cloud.brigadier.suggestion: Produces Brigadier suggestions by invoking the Cloud suggestion provider.
BrigadierSuggestionFactory(CloudBrigadierManager<C, S>, CommandManager<C>, Supplier<CommandContext<C>>, SuggestionFactory<C, ? extends TooltipSuggestion>) - Constructor for class org.incendo.cloud.brigadier.suggestion.BrigadierSuggestionFactory: Creates a new suggestion factory.
BrigadierUtil - Class in org.incendo.cloud.brigadier.util
build() - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Builds the mapping.
builder() - Static method in class org.incendo.cloud.brigadier.argument.BrigadierMapping: Returns a new mapping builder.
buildRedirect(String, CommandNode<S>) - Static method in class org.incendo.cloud.brigadier.util.BrigadierUtil: Returns a literal node that redirects its execution to the given destination node.
buildSuggestions(CommandContext<S>, CommandNode<C>, CommandComponent<C>, SuggestionsBuilder) - Method in class org.incendo.cloud.brigadier.suggestion.BrigadierSuggestionFactory: Builds suggestions for the given component.

C

CLOUD_SUGGESTIONS - Enum constant in enum org.incendo.cloud.brigadier.suggestion.SuggestionsType: Cloud will be invoked for suggestions.
CloudBrigadierCommand<C,S> - Class in org.incendo.cloud.brigadier: Brigadier Command implementation that delegates to cloud.
CloudBrigadierCommand(CommandManager<C>, CloudBrigadierManager<C, S>) - Constructor for class org.incendo.cloud.brigadier.CloudBrigadierCommand: Creates a new CloudBrigadierCommand.
CloudBrigadierManager<C,S> - Class in org.incendo.cloud.brigadier: Manager used to map cloud Command
CloudBrigadierManager(CommandManager<C>, Supplier<CommandContext<C>>, SenderMapper<S, C>) - Constructor for class org.incendo.cloud.brigadier.CloudBrigadierManager: Create a new cloud brigadier manager
CloudDelegatingSuggestionProvider<C,S> - Class in org.incendo.cloud.brigadier.suggestion: Brigadier suggestion provider that delegates to Cloud's suggestion provider.
CloudDelegatingSuggestionProvider(BrigadierSuggestionFactory<C, S>, CommandNode<C>) - Constructor for class org.incendo.cloud.brigadier.suggestion.CloudDelegatingSuggestionProvider: Creates a new suggestion provider.
cloudSuggestions() - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Use the suggestions from Cloud's parser for this argument type.
COMMAND_CONTEXT_BRIGADIER_NATIVE_SENDER - Static variable in class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser
create() - Method in interface org.incendo.cloud.brigadier.argument.ArgumentTypeFactory: Creates the argument type.
create() - Static method in interface org.incendo.cloud.brigadier.argument.BrigadierMappings: Returns a new instance of the default implementation.
createNode(String, Command<C>, Command<S>) - Method in interface org.incendo.cloud.brigadier.node.BrigadierNodeFactory: Creates a Brigadier command node.
createNode(String, Command<C>, Command<S>) - Method in class org.incendo.cloud.brigadier.node.LiteralBrigadierNodeFactory
createNode(String, Command<C>, Command<S>, BrigadierPermissionChecker<C>) - Method in interface org.incendo.cloud.brigadier.node.BrigadierNodeFactory: Creates a Brigadier command node.
createNode(String, Command<C>, Command<S>, BrigadierPermissionChecker<C>) - Method in class org.incendo.cloud.brigadier.node.LiteralBrigadierNodeFactory
createNode(String, CommandNode<C>, Command<S>, BrigadierPermissionChecker<C>) - Method in interface org.incendo.cloud.brigadier.node.BrigadierNodeFactory: Creates a Brigadier command node.
createNode(String, CommandNode<C>, Command<S>, BrigadierPermissionChecker<C>) - Method in class org.incendo.cloud.brigadier.node.LiteralBrigadierNodeFactory

D

defaultArgumentTypeFactories() - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Returns the default argument type factories.
delegateSuggestions() - Static method in class org.incendo.cloud.brigadier.argument.BrigadierMapping: Returns a sentinel value for declaring that suggestions should be delegated to cloud.

F

FORCE_EXECUTABLE - Enum constant in enum org.incendo.cloud.brigadier.BrigadierSetting: Makes each constructed CommandNode executable, which allows Cloud to display errors for partially completed command input.

G

getSuggestions(CommandContext<S>, SuggestionsBuilder) - Method in class org.incendo.cloud.brigadier.suggestion.CloudDelegatingSuggestionProvider

H

hasBrigadierManager() - Method in interface org.incendo.cloud.brigadier.BrigadierManagerHolder: Returns whether the CloudBrigadierManager is present and active.
hasPermission(C, Permission) - Method in interface org.incendo.cloud.brigadier.permission.BrigadierPermissionChecker: Returns whether the given Brigadier sender has the given permission.

L

literalBrigadierNodeFactory() - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Returns a factory that creates literal command nodes from Cloud commands.
LiteralBrigadierNodeFactory<C,S> - Class in org.incendo.cloud.brigadier.node
LiteralBrigadierNodeFactory(CloudBrigadierManager<C, S>, CommandManager<C>, Supplier<CommandContext<C>>, SuggestionFactory<C, ? extends TooltipSuggestion>) - Constructor for class org.incendo.cloud.brigadier.node.LiteralBrigadierNodeFactory: Creates a new factory that produces literal command nodes.

M

makeSuggestionProvider(K) - Method in class org.incendo.cloud.brigadier.argument.BrigadierMapping: Creates a Brigadier suggestion provider for the given commandArgument.
mapper() - Method in class org.incendo.cloud.brigadier.argument.BrigadierMapping: Returns the mapping function.
mapping(Class<K>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappings: Returns the mapper for the given parserType.
mappings() - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Returns the mappings between Cloud and Brigadier types.

N

nativeArgumentType() - Method in class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser: Returns the backing Brigadier ArgumentType for this parser.
nativeSuggestions() - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Use the default brigadier suggestions for this argument type.

O

org.incendo.cloud.brigadier - package org.incendo.cloud.brigadier: Brigadier mappings.
org.incendo.cloud.brigadier.argument - package org.incendo.cloud.brigadier.argument: Support for wrapping brigadier ArgumentTypes as Cloud ArgumentParser.
org.incendo.cloud.brigadier.node - package org.incendo.cloud.brigadier.node: Tools for creating Brigadier nodes.
org.incendo.cloud.brigadier.parser - package org.incendo.cloud.brigadier.parser: Argument parsers available on Brigadier platforms.
org.incendo.cloud.brigadier.permission - package org.incendo.cloud.brigadier.permission: Brigadier permission helpers.
org.incendo.cloud.brigadier.suggestion - package org.incendo.cloud.brigadier.suggestion: Tools for mapping to Brigadier suggestions.
org.incendo.cloud.brigadier.util - package org.incendo.cloud.brigadier.util: Brigadier utils.

P

parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser
provide(K, SuggestionProvider<S>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder.SuggestionProviderSupplier: Create a new suggestion provider based on the provided argument.

R

registerDefaultArgumentTypeSupplier(Class<T>, ArgumentTypeFactory<T>) - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Register a default mapping to between a class and a Brigadier argument type
registerMapping(TypeToken<K>, Consumer<BrigadierMappingBuilder<K, S>>) - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Register a cloud-Brigadier mapping.
registerMapping(Class<K>, BrigadierMapping<?, K, S>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappings: Registers the mapping for the given parserType.
registerMappingUnsafe(Class<K>, BrigadierMapping<?, ?, S>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappings: Registers the mapping for the given parserType.
run(CommandContext<S>) - Method in class org.incendo.cloud.brigadier.CloudBrigadierCommand

S

senderMapper() - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager
setNativeNumberSuggestions(boolean) - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Sets whether Brigadier's native suggestions for number types will be used, or if cloud's number suggestions should be used instead.
setNativeSuggestions(TypeToken<K>, boolean) - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Set whether to use Brigadier's native suggestions for an argument type with an already registered mapper.
settings() - Method in class org.incendo.cloud.brigadier.CloudBrigadierManager: Returns a Configurable instance that can be used to modify the settings for this instance.
suggestedBy(BrigadierMappingBuilder.SuggestionProviderSupplier<K, S>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Use a custom Brigadier suggestion provider for this parser.
suggestedByConstant(SuggestionProvider<S>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Use a custom Brigadier suggestion provider for this parser.
suggestion() - Method in class org.incendo.cloud.brigadier.suggestion.TooltipSuggestion.TooltipSuggestionImpl
suggestionsFuture(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser
SuggestionsType - Enum in org.incendo.cloud.brigadier.suggestion: Determines how suggestions are retrieved for an argument.

T

test(S) - Method in class org.incendo.cloud.brigadier.permission.BrigadierPermissionPredicate
to(Function<K, ? extends ArgumentType<?>>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Map the cloud argument parser to a variable Brigadier ArgumentType.
toConstant(ArgumentType<?>) - Method in interface org.incendo.cloud.brigadier.argument.BrigadierMappingBuilder: Map the argument type parser to a constant Brigadier argument type instance.
tooltip() - Method in interface org.incendo.cloud.brigadier.suggestion.TooltipSuggestion: Returns the tooltip.
tooltip() - Method in class org.incendo.cloud.brigadier.suggestion.TooltipSuggestion.TooltipSuggestionImpl
tooltipSuggestion(String, Message) - Static method in interface org.incendo.cloud.brigadier.suggestion.TooltipSuggestion: Returns a new TooltipSuggestion with the given suggestion and tooltip.
tooltipSuggestion(Suggestion) - Static method in interface org.incendo.cloud.brigadier.suggestion.TooltipSuggestion: Returns a new TooltipSuggestion that uses the given suggestion and has a null tooltip.
TooltipSuggestion - Interface in org.incendo.cloud.brigadier.suggestion: Suggestion that has an optional Brigadier message tooltip.
TooltipSuggestion.TooltipSuggestionImpl - Class in org.incendo.cloud.brigadier.suggestion

V

valueOf(String) - Static method in enum org.incendo.cloud.brigadier.BrigadierSetting: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.incendo.cloud.brigadier.suggestion.SuggestionsType: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.incendo.cloud.brigadier.BrigadierSetting: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.incendo.cloud.brigadier.suggestion.SuggestionsType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withNativeSuggestions(boolean) - Method in class org.incendo.cloud.brigadier.argument.BrigadierMapping: Returns a new version of this mapping that uses native suggestions if nativeSuggestions is true, or cloud suggestions if it's false.
withSuggestion(String) - Method in interface org.incendo.cloud.brigadier.suggestion.TooltipSuggestion
withTooltip(Message) - Method in interface org.incendo.cloud.brigadier.suggestion.TooltipSuggestion: Returns a copy of this suggestion instance using the given tooltip
WrappedBrigadierParser<C,T> - Class in org.incendo.cloud.brigadier.parser: A wrapped argument parser adapting Brigadier argument types.
WrappedBrigadierParser(ArgumentType<T>) - Constructor for class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser: Create an argument parser from a Brigadier ArgumentType.
WrappedBrigadierParser(Supplier<ArgumentType<T>>) - Constructor for class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser: Create a WrappedBrigadierParser for the argument type.
WrappedBrigadierParser(Supplier<ArgumentType<T>>, WrappedBrigadierParser.ParseFunction<T>) - Constructor for class org.incendo.cloud.brigadier.parser.WrappedBrigadierParser: Create an argument parser from a Brigadier ArgumentType.
WrappedBrigadierParser.ParseFunction<T> - Interface in org.incendo.cloud.brigadier.parser: Function which can call ArgumentType.parse(StringReader) or another method.

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