Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- accent() - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.HelpColors
-
Returns the configured accent color.
- alternateHighlight() - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.HelpColors
-
Returns the configured alternate highlight color.
- apply(C) - Method in interface org.incendo.cloud.minecraft.extras.AudienceProvider
-
Convert a command sender to an
Audience - asComponent() - Method in interface org.incendo.cloud.minecraft.extras.caption.RichVariable
- audience(C) - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Maps a command sender to an
Audience - audienceProvider() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the audience provider that was used to create this instance.
- audienceProvider() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the audience provider that was used to create this instance.
- audienceProvider(AudienceProvider<C>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.AudienceProviderBuildStage
-
Initializes the value for the
audienceProviderattribute. - audienceProvider(AudienceProvider<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
audienceProviderattribute. - AudienceProvider<C> - Interface in org.incendo.cloud.minecraft.extras
-
Function that maps the command sender type to an adventure
Audience
B
- build() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Builds a new
ImmutableMinecraftHelp. - build() - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Builds a new
ImmutableMinecraftHelp. - builder() - Static method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Creates a builder for
ImmutableMinecraftHelp. - builder() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns a new
MinecraftHelpbuilder.
C
- captionFormatter(ComponentCaptionFormatter<C>) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Sets the caption formatter that is responsible for turning
captionsinto Adventurecomponents. - captionMessageProvider(CaptionRegistry<C>, ComponentCaptionFormatter<C>) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Creates a
MinecraftHelp.MessageProviderthat delegates to the providedCaptionRegistryandComponentCaptionFormatter. - colors() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the colors used for help messages.
- colors() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the colors used for help messages.
- colors(MinecraftHelp.HelpColors) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
colorsattribute. - colors(MinecraftHelp.HelpColors) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Initializes the value for the
colorsattribute. - commandFilter() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the filter that determines what commands are visible inside the help menu.
- commandFilter() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the filter that determines what commands are visible inside the help menu.
- commandFilter(CommandPredicate<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
commandFilterattribute. - commandFilter(CommandPredicate<C>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Initializes the value for the
commandFilterattribute. - commandManager() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the command manager instance.
- commandManager() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the command manager instance.
- commandManager(CommandManager<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
commandManagerattribute. - commandManager(CommandManager<C>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.CommandManagerBuildStage
-
Initializes the value for the
commandManagerattribute. - commandPrefix() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the command prefix.
- commandPrefix() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the command prefix.
- commandPrefix(String) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
commandPrefixattribute. - commandPrefix(String) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.CommandPrefixBuildStage
-
Initializes the value for the
commandPrefixattribute. - component() - Method in interface org.incendo.cloud.minecraft.extras.caption.RichVariable
-
Returns the variable value as a component.
- COMPONENT_DECODER - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftExtrasParserParameters
- ComponentBrigadierContributor - Class in org.incendo.cloud.minecraft.extras.parser
- ComponentBrigadierContributor() - Constructor for class org.incendo.cloud.minecraft.extras.parser.ComponentBrigadierContributor
- ComponentCaptionFormatter<C> - Interface in org.incendo.cloud.minecraft.extras.caption
- componentComponent(Function<String, ? extends Component>, StringParser.StringMode) - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new command component builder for the provided component decoder using the provided string mode.
- componentDecoder() - Method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Returns the component decoder used by this parser.
- componentParser(Function<String, ? extends Component>) - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new parser descriptor for the provided component decoder using the
StringParser.StringMode.QUOTEDmode. - componentParser(Function<String, ? extends Component>, StringParser.StringMode) - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new parser descriptor for the provided component decoder using the provided string mode.
- componentParser(ComponentSerializer<?, ? extends Component, String>) - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new parser descriptor for the provided component decoder using the
StringParser.StringMode.QUOTEDmode. - componentParser(ComponentSerializer<?, ? extends Component, String>, StringParser.StringMode) - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new parser descriptor for the provided component decoder using the provided string mode.
- ComponentParser<C> - Class in org.incendo.cloud.minecraft.extras.parser
-
Parser for components.
- ComponentParser(Function<String, ? extends Component>, StringParser.StringMode) - Constructor for class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Construct a new component parser.
- ComponentParserContributor - Class in org.incendo.cloud.minecraft.extras.parser
- ComponentParserContributor() - Constructor for class org.incendo.cloud.minecraft.extras.parser.ComponentParserContributor
- ComponentTooltipSuggestion - Interface in org.incendo.cloud.minecraft.extras.suggestion
- contents() - Method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Returns the contents of this description.
- contribute(CommandManager<C>, CloudBrigadierManager<C, S>) - Method in class org.incendo.cloud.minecraft.extras.parser.ComponentBrigadierContributor
- contribute(ParserRegistry<C>) - Method in class org.incendo.cloud.minecraft.extras.parser.ComponentParserContributor
- contribute(ParserRegistry<C>) - Method in class org.incendo.cloud.minecraft.extras.parser.TextColorParser.Contributor
- Contributor() - Constructor for class org.incendo.cloud.minecraft.extras.parser.TextColorParser.Contributor
- converter(MinecraftExceptionHandler.ComponentMessageThrowableConverter) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler.ComponentMessageThrowableConverterHolder
-
Replaces the converter.
- copyOf(MinecraftHelp<C>) - Static method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Creates an immutable copy of a
MinecraftHelpvalue. - create(String, CommandManager<C>, AudienceProvider<C>) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Constructs a new Minecraft help instance using the default values.
- create(AudienceProvider<C>) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Create a new
MinecraftExceptionHandlerusingaudienceProvider. - createDefaultArgumentParsingHandler() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
The default
ArgumentParseExceptionhandler. - createDefaultCommandExecutionHandler() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
The default
CommandExecutionExceptionhandler, usingMinecraftExceptionHandler.createDefaultCommandExecutionLogger(). - createDefaultCommandExecutionHandler(Consumer<ExceptionContext<C, CommandExecutionException>>) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
The default
CommandExecutionExceptionhandler, with a specific logger. - createDefaultCommandExecutionLogger() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Default logger for
MinecraftExceptionHandler.createDefaultCommandExecutionHandler(Consumer), usingThrowable.printStackTrace()on theCommandExecutionException's cause. - createDefaultInvalidSenderHandler() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
The default
InvalidCommandSenderExceptionhandler. - createDefaultInvalidSyntaxHandler() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
The default
InvalidSyntaxExceptionhandler. - createDefaultNoPermissionHandler() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
The default
NoPermissionExceptionhandler. - createNative() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Create a new
MinecraftExceptionHandlerusingAudienceProvider.nativeAudience(). - createNative(String, CommandManager<C>) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Constructs a new Minecraft help instance for a sender type which is an
Audience.
D
- decoder(TypeToken<?>) - Method in interface org.incendo.cloud.minecraft.extras.annotation.specifier.Decoder.Provider
-
Returns a decoder function to convert a string into a component.
- Decoder - Annotation Type in org.incendo.cloud.minecraft.extras.annotation.specifier
-
Annotation used to specify a decoder for converting a string into a component.
- Decoder.Json - Annotation Type in org.incendo.cloud.minecraft.extras.annotation.specifier
-
Annotation to specify to use a json decoder.
- Decoder.Legacy - Annotation Type in org.incendo.cloud.minecraft.extras.annotation.specifier
-
Annotation to specify to use a legacy decoder.
- Decoder.MiniMessage - Annotation Type in org.incendo.cloud.minecraft.extras.annotation.specifier
-
Annotation to specify to use a MiniMessage decoder.
- Decoder.Provider - Interface in org.incendo.cloud.minecraft.extras.annotation.specifier
-
A provider of a decoder.
- decorate(C, String) - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.DescriptionDecorator
-
Turns the given
descriptioninto an adventureComponent. - decorate(ComponentCaptionFormatter<C>, ExceptionContext<C, ?>, Component) - Method in interface org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler.Decorator
-
Decorates a message before sending.
- decorator(Function<Component, ComponentLike>) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Sets the decorator that acts on a component before it's sent to the sender.
- decorator(MinecraftExceptionHandler.Decorator<C>) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Sets the decorator that acts on a component before it's sent to the sender.
- DEFAULT_HEADER_FOOTER_LENGTH - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- DEFAULT_HELP_COLORS - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
The default color scheme for
MinecraftHelp - DEFAULT_MAX_RESULTS_PER_PAGE - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- defaultArgumentParsingHandler() - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use the default
ArgumentParseExceptionhandler. - defaultCaptionsProvider() - Static method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns a
CaptionProviderfor the default messages. - defaultCommandExecutionHandler() - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use the default
CommandExecutionExceptionhandler withMinecraftExceptionHandler.createDefaultCommandExecutionLogger(). - defaultCommandExecutionHandler(Consumer<ExceptionContext<C, CommandExecutionException>>) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use the default
CommandExecutionExceptionhandler with a custom logger. - defaultHandlers() - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use all the default exception handlers.
- defaultInvalidSenderHandler() - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use the default
InvalidCommandSenderExceptionhandler. - defaultInvalidSyntaxHandler() - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use the default
InvalidSyntaxExceptionhandler. - defaultNoPermissionHandler() - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Use the default
NoPermissionExceptionhandler. - descriptionDecorator() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the description decorator which turns descriptions into components.
- descriptionDecorator() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the description decorator which turns descriptions into components.
- descriptionDecorator(MinecraftHelp.DescriptionDecorator<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
descriptionDecoratorattribute. - descriptionDecorator(MinecraftHelp.DescriptionDecorator<C>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Initializes the value for the
descriptionDecoratorattribute. - downsampleColors() - Element in annotation type org.incendo.cloud.minecraft.extras.annotation.specifier.Decoder.Json
-
Whether to downsample colors.
E
- empty() - Static method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Get an empty description.
- equals(Object) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
This instance is equal to all instances of
ImmutableMinecraftHelpthat have equal attribute values. - equals(Object) - Method in class org.incendo.cloud.minecraft.extras.RichDescription
H
- handler(Class<T>, MinecraftExceptionHandler.MessageFactory<C, T>) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Sets the exception handler for the given
type. - hashCode() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Computes a hash code from attributes:
commandManager,audienceProvider,commandPrefix,helpHandler,commandFilter,descriptionDecorator,messages,messageProvider,colors,headerFooterLength,maxResultsPerPage. - hashCode() - Method in class org.incendo.cloud.minecraft.extras.RichDescription
- headerFooterLength() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the length of the header/footer of help menus.
- headerFooterLength() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the length of the header/footer of help menus.
- headerFooterLength(int) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
headerFooterLengthattribute. - headerFooterLength(int) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Initializes the value for the
headerFooterLengthattribute. - helpColors(TextColor, TextColor, TextColor, TextColor, TextColor) - Static method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Creates a new
MinecraftHelp.HelpColorsinstance. - helpHandler() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the help handler.
- helpHandler() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the help handler.
- highlight() - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.HelpColors
-
Returns the configured highlight color.
I
- ImmutableMinecraftHelp<C> - Class in org.incendo.cloud.minecraft.extras
-
Immutable implementation of
MinecraftHelp. - ImmutableMinecraftHelp.AudienceProviderBuildStage<C> - Interface in org.incendo.cloud.minecraft.extras
- ImmutableMinecraftHelp.Builder<C> - Class in org.incendo.cloud.minecraft.extras
-
Builds instances of type
ImmutableMinecraftHelp. - ImmutableMinecraftHelp.BuildFinal<C> - Interface in org.incendo.cloud.minecraft.extras
- ImmutableMinecraftHelp.CommandManagerBuildStage<C> - Interface in org.incendo.cloud.minecraft.extras
- ImmutableMinecraftHelp.CommandPrefixBuildStage<C> - Interface in org.incendo.cloud.minecraft.extras
- isEmpty() - Method in class org.incendo.cloud.minecraft.extras.RichDescription
K
- key() - Method in interface org.incendo.cloud.minecraft.extras.caption.RichVariable
- key() - Method in class org.incendo.cloud.minecraft.extras.caption.TranslatableCaption
M
- maxResultsPerPage() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the maximum number of help results to display on a page.
- maxResultsPerPage() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the maximum number of help results to display on a page.
- maxResultsPerPage(int) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
maxResultsPerPageattribute. - maxResultsPerPage(int) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Initializes the value for the
maxResultsPerPageattribute. - maybeConvert(Throwable) - Method in interface org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler.ComponentMessageThrowableConverter
-
Converts a Throwable to a ComponentMessageThrowable if possible.
- maybeConvert(Throwable) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler.ComponentMessageThrowableConverterHolder
- message(ComponentCaptionFormatter<C>, ExceptionContext<C, T>) - Method in interface org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler.MessageFactory
-
Formats the exception info into a
Componentmessage, ornullto send no message. - MESSAGE_ARGUMENTS - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_AVAILABLE_COMMANDS - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_CLICK_FOR_NEXT_PAGE - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_CLICK_FOR_PREVIOUS_PAGE - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_CLICK_TO_SHOW_HELP - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_COMMAND - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_DESCRIPTION - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_HELP_TITLE - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_NO_DESCRIPTION - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_NO_RESULTS_FOR_QUERY - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_OPTIONAL - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_PAGE_OUT_OF_RANGE - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- MESSAGE_SHOWING_RESULTS_FOR_QUERY - Static variable in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- messageOrDefault(String) - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
- messageProvider() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the message provider which is used to retrieve messages from message keys.
- messageProvider() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the message provider which is used to retrieve messages from message keys.
- messageProvider(MinecraftHelp.MessageProvider<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Initializes the value for the
messageProviderattribute. - messageProvider(MinecraftHelp.MessageProvider<C>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Initializes the value for the
messageProviderattribute. - messages() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Returns the messages which are used by the default
MinecraftHelp.MessageProvider. - messages() - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Returns the messages which are used by the default
MinecraftHelp.MessageProvider. - messages(String, String) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Put one entry to the
messagesmap. - messages(String, String) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Put one entry to the
messagesmap. - messages(Map.Entry<String, ? extends String>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Put one entry to the
messagesmap. - messages(Map.Entry<String, ? extends String>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Put one entry to the
messagesmap. - messages(Map<String, ? extends String>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.Builder
-
Put all mappings from the specified map as entries to
messagesmap. - messages(Map<String, ? extends String>) - Method in interface org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp.BuildFinal
-
Put all mappings from the specified map as entries to
messagesmap. - MinecraftExceptionHandler<C> - Class in org.incendo.cloud.minecraft.extras
-
Creates and registers
ExceptionHandlersthat send aComponentto the command sender. - MinecraftExceptionHandler.ComponentMessageThrowableConverter - Interface in org.incendo.cloud.minecraft.extras
-
Converts Throwables to ComponentMessageThrowables when possible.
- MinecraftExceptionHandler.ComponentMessageThrowableConverterHolder - Class in org.incendo.cloud.minecraft.extras
-
Default implementation and holder for
MinecraftExceptionHandler.ComponentMessageThrowableConverter. - MinecraftExceptionHandler.Decorator<C> - Interface in org.incendo.cloud.minecraft.extras
- MinecraftExceptionHandler.MessageFactory<C,
T> - Interface in org.incendo.cloud.minecraft.extras - MinecraftExtrasParserParameters - Class in org.incendo.cloud.minecraft.extras
-
ParserParameterkeys for cloud-minecraft-extras - MinecraftHelp<C> - Class in org.incendo.cloud.minecraft.extras
-
Opinionated extension of
HelpRendererfor Minecraft. - MinecraftHelp.DescriptionDecorator<C> - Interface in org.incendo.cloud.minecraft.extras
- MinecraftHelp.HelpColors - Interface in org.incendo.cloud.minecraft.extras
-
Class for holding the
TextColorsused for help menus - MinecraftHelp.MessageProvider<C> - Interface in org.incendo.cloud.minecraft.extras
- miniMessage() - Static method in interface org.incendo.cloud.minecraft.extras.caption.ComponentCaptionFormatter
-
Create a MiniMessage formatter with the
default MiniMessage instanceand no extraTagResolvers. - miniMessage(MiniMessage) - Static method in interface org.incendo.cloud.minecraft.extras.caption.ComponentCaptionFormatter
-
Create a MiniMessage formatter with the provided MiniMessage instance and no extra
TagResolvers. - miniMessage(MiniMessage, TagResolver...) - Static method in interface org.incendo.cloud.minecraft.extras.caption.ComponentCaptionFormatter
-
Create a MiniMessage formatter with the provided MiniMessage instance and no extra
TagResolvers. - miniMessageParser() - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new parser descriptor for the default MiniMessage serializer using the
StringParser.StringMode.QUOTEDmode. - miniMessageParser(StringParser.StringMode) - Static method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Create a new parser descriptor for the default MiniMessage serializer using the provided string mode.
N
- nativeAudience() - Static method in interface org.incendo.cloud.minecraft.extras.AudienceProvider
-
Get an audience provider for sender types which are already an
Audience.
O
- of(String, Component) - Static method in interface org.incendo.cloud.minecraft.extras.caption.RichVariable
-
Creates a new rich variable.
- of(ComponentLike) - Static method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Create a new rich description from the provided component.
- of(CommandManager<C>, AudienceProvider<C>, String, CommandPredicate<C>, MinecraftHelp.DescriptionDecorator<C>, Map<String, ? extends String>, MinecraftHelp.MessageProvider<C>, MinecraftHelp.HelpColors, int, int) - Static method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Construct a new immutable
MinecraftHelpinstance. - org.incendo.cloud.minecraft.extras - package org.incendo.cloud.minecraft.extras
-
Minecraft extras
- org.incendo.cloud.minecraft.extras.annotation.specifier - package org.incendo.cloud.minecraft.extras.annotation.specifier
-
Annotations for cloud-minecraft-extras.
- org.incendo.cloud.minecraft.extras.caption - package org.incendo.cloud.minecraft.extras.caption
-
minecraft-extras caption utilities.
- org.incendo.cloud.minecraft.extras.parser - package org.incendo.cloud.minecraft.extras.parser
-
Adventure argument parsers.
- org.incendo.cloud.minecraft.extras.suggestion - package org.incendo.cloud.minecraft.extras.suggestion
-
minecraft-extras suggestion classes.
P
- parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
- parse(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.minecraft.extras.parser.TextColorParser
- patternReplacing(Pattern) - Static method in interface org.incendo.cloud.minecraft.extras.caption.ComponentCaptionFormatter
-
Returns a caption formatter that replaces the results from the given
patternwith the values from the caption variables. - placeholderReplacing() - Static method in interface org.incendo.cloud.minecraft.extras.caption.ComponentCaptionFormatter
-
Returns a caption formatter that replaces placeholders in the form of
<placeholder>with the caption variables. - primary() - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.HelpColors
-
Returns the configured primary color.
- provide(C, String) - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.MessageProvider
-
Creates a component from a command sender and key.
- provide(C, String, Map<String, String>) - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.MessageProvider
-
Creates a component from a command sender, key, and arguments
Q
- queryCommands(String, C) - Method in class org.incendo.cloud.minecraft.extras.MinecraftHelp
-
Queries commands and send the results to the recipient.
R
- registerTo(CommandManager<C>) - Method in class org.incendo.cloud.minecraft.extras.MinecraftExceptionHandler
-
Registers configured handlers to the
ExceptionController. - richDescription(ComponentLike) - Static method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Create a new rich description from the provided component.
- RichDescription - Class in org.incendo.cloud.minecraft.extras
-
A description implementation that uses Adventure components.
- RichVariable - Interface in org.incendo.cloud.minecraft.extras.caption
-
A
CaptionVariableimplementation that uses Adventure components.
S
- stringMode() - Method in class org.incendo.cloud.minecraft.extras.parser.ComponentParser
-
Returns the string mode used by this parser.
- stringSuggestions(CommandContext<C>, CommandInput) - Method in class org.incendo.cloud.minecraft.extras.parser.TextColorParser
- suggestion() - Method in interface org.incendo.cloud.minecraft.extras.suggestion.ComponentTooltipSuggestion
- suggestion(String) - Static method in interface org.incendo.cloud.minecraft.extras.suggestion.ComponentTooltipSuggestion
-
Returns a new
ComponentTooltipSuggestionwith no tooltip. - suggestion(String, Component) - Static method in interface org.incendo.cloud.minecraft.extras.suggestion.ComponentTooltipSuggestion
-
Returns a new
ComponentTooltipSuggestionwith the provided tooltip.
T
- text() - Static method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.DescriptionDecorator
-
Returns a description decorator that turns the description into a text component without any style.
- text() - Method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.HelpColors
-
Returns the configured text color.
- textColorComponent() - Static method in class org.incendo.cloud.minecraft.extras.parser.TextColorParser
-
Returns a
CommandComponent.BuilderusingTextColorParser.textColorParser()as the parser. - textColorParser() - Static method in class org.incendo.cloud.minecraft.extras.parser.TextColorParser
-
Creates a new text color parser.
- TextColorParser<C> - Class in org.incendo.cloud.minecraft.extras.parser
-
Parser for color codes.
- TextColorParser() - Constructor for class org.incendo.cloud.minecraft.extras.parser.TextColorParser
- TextColorParser.Contributor - Class in org.incendo.cloud.minecraft.extras.parser
- textDescription() - Method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Deprecated.
- tooltip() - Method in interface org.incendo.cloud.minecraft.extras.suggestion.ComponentTooltipSuggestion
-
Returns the
Componenttooltip ornullif there is no tooltip. - toString() - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Prints the immutable value
MinecraftHelpwith attribute values. - translatable() - Static method in interface org.incendo.cloud.minecraft.extras.caption.ComponentCaptionFormatter
-
Caption formatter for
translatable components. - translatable(String) - Static method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Create a rich description pointing to a translation key.
- translatable(String, ComponentLike...) - Static method in class org.incendo.cloud.minecraft.extras.RichDescription
-
Create a rich description pointing to a translation key.
- translatableCaption(String) - Static method in class org.incendo.cloud.minecraft.extras.caption.TranslatableCaption
-
Creates a new
TranslatableCaption. - TranslatableCaption - Class in org.incendo.cloud.minecraft.extras.caption
- translatableCaptionProvider() - Static method in class org.incendo.cloud.minecraft.extras.caption.TranslatableCaption
-
Caption provider mapping
TranslatableCaptiondirectly to it's key, for use withComponentCaptionFormatter.translatable()or similar.
V
- value() - Element in annotation type org.incendo.cloud.minecraft.extras.annotation.specifier.Decoder.Legacy
-
The character to use for legacy formatting.
- value() - Element in annotation type org.incendo.cloud.minecraft.extras.annotation.specifier.Decoder
-
The class for a provider of a decoder.
- value() - Method in interface org.incendo.cloud.minecraft.extras.caption.RichVariable
W
- withAudienceProvider(AudienceProvider<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
audienceProviderattribute. - withColors(MinecraftHelp.HelpColors) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
colorsattribute. - withCommandFilter(CommandPredicate<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
commandFilterattribute. - withCommandManager(CommandManager<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
commandManagerattribute. - withCommandPrefix(String) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
commandPrefixattribute. - withDescriptionDecorator(MinecraftHelp.DescriptionDecorator<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
descriptionDecoratorattribute. - withHeaderFooterLength(int) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
headerFooterLengthattribute. - withMaxResultsPerPage(int) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
maxResultsPerPageattribute. - withMessageProvider(MinecraftHelp.MessageProvider<C>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by setting a value for the
messageProviderattribute. - withMessages(Map<String, ? extends String>) - Method in class org.incendo.cloud.minecraft.extras.ImmutableMinecraftHelp
-
Copy the current immutable object by replacing the
messagesmap with the specified map. - withSuggestion(String) - Method in interface org.incendo.cloud.minecraft.extras.suggestion.ComponentTooltipSuggestion
- wrap(Function<String, Component>) - Static method in interface org.incendo.cloud.minecraft.extras.MinecraftHelp.DescriptionDecorator
-
Return a description decorator that wraps the given
function.
All Classes and Interfaces|All Packages|Constant Field Values
RichDescription.contents()instead.