Index (adventure-text-minimessage 5.2.0 API)

A B C D E F G H I J K L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accept(int, int, TokenType) - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.MatchedTokenConsumer: Accepts a matched token.
accept(int, int, TokenType) - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.StringResolvingMatchedTokenConsumer
accept(int, int, TokenType) - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.TokenListProducingMatchedTokenConsumer
addChild(ElementNode) - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Adds a child to this node.
allowsChildren() - Method in interface net.kyori.adventure.text.minimessage.tag.Inserting: Get whether this tag allows children.
apply(Component, int) - Method in interface net.kyori.adventure.text.minimessage.tag.Modifying: Applies this transformation for the current component.
apply(Style) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.StyleClaim: Prepare an emitable to apply this claim based on the style.
argument(String) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Add a single argument to the current tag.
argument(String, QuotingOverride) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Add a single argument to the current tag.
argument(String, TranslationArgument) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named translation argument.
argument(String, TranslationArgumentLike) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named translation argument.
argument(Component) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Add a single argument to the current tag.
Argument - Class in net.kyori.adventure.text.minimessage.translation: A utility class to create arguments for translatable components.
ArgumentQueue - Interface in net.kyori.adventure.text.minimessage.tag.resolver: A queue of Tag arguments.
arguments(String...) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Add arguments to the current tag.
asDouble() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Try and parse this argument as a double.
asInt() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Try and parse this argument as an int.
assertValidTagName(String) - Static method in class net.kyori.adventure.text.minimessage.internal.TagInternals: Checks if a tag name matches the pattern for allowed tag names.

B

bool(String, boolean) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named boolean argument.
booleanChoice(String, boolean) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a choice tag.
build() - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Builds the serializer.
build() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Create a placeholder resolver based on the input.
builder() - Static method in interface net.kyori.adventure.text.minimessage.MiniMessage: Creates a new MiniMessage.Builder.
builder() - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Create a new builder for a tag resolver.
builder(MiniMessage.Preset) - Static method in interface net.kyori.adventure.text.minimessage.MiniMessage: Creates a new MiniMessage.Builder pre-configured for a specific preset.
buildToString(StringBuilder, int) - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Serializes this node to a string.
buildToString(StringBuilder, int) - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode
buildToString(StringBuilder, int) - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ValueNode

C

caching(TagResolver.WithoutArguments) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add a resolver that dynamically queries and caches based on the provided function.
caching(TagResolver.WithoutArguments) - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Constructs a tag resolver capable of caching resolved tags.
children() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Returns the children of this node.
children() - Method in interface net.kyori.adventure.text.minimessage.tree.Node: Get children of this node.
childTokens() - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token: Returns the children of this token.
childTokens(List<Token>) - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token: Sets the children of this token.
choice(String, Number) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a replacement that inserts a choice formatted text.
claim(String, Function<Style, T>, BiConsumer<T, TokenEmitter>) - Static method in interface net.kyori.adventure.text.minimessage.internal.serializer.StyleClaim: Create a new style claim that will emit content for any non-null value.
claim(String, Function<Style, T>, Predicate<T>, BiConsumer<T, TokenEmitter>) - Static method in interface net.kyori.adventure.text.minimessage.internal.serializer.StyleClaim: Create a new style claim that will emit content for any non-null value that passes the filter.
claimComponent(Component) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver.Single: Claim a full component for tag emission.
ClaimConsumer - Interface in net.kyori.adventure.text.minimessage.internal.serializer: A consumer of serialization claims.
claimingComponent(String, BiFunction<ArgumentQueue, Context, Tag>, Function<Component, Emitable>) - Static method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver: Create a tag resolver that only responds to a single tag name, and whose value does not depend on that name.
claimingComponent(Set<String>, BiFunction<ArgumentQueue, Context, Tag>, Function<Component, Emitable>) - Static method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver: Create a tag resolver that only responds to certain tag names, and whose value does not depend on that name.
claimingStyle(String, BiFunction<ArgumentQueue, Context, Tag>, StyleClaim<?>) - Static method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver: Create a tag resolver that only responds to a single tag name, and whose value does not depend on that name.
claimingStyle(Set<String>, BiFunction<ArgumentQueue, Context, Tag>, StyleClaim<?>) - Static method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver: Create a tag resolver that only responds to certain tag names, and whose value does not depend on that name.
claimKey() - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.StyleClaim: The key identifying this style element.
claimStyle() - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver.Single: Claim a style for tag emission.
clickEvent() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "click" tag.
CLOSE_TAG - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType
CLOSE_TAG - Static variable in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser
color() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "color" tags.
component(String, ComponentLike) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Placeholder: Creates a replacement that inserts a component.
component(String, ComponentLike) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named component argument.
component(Emitable) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.ClaimConsumer: Submit a component claim for the active component.
componentClaimed() - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.ClaimConsumer: Get whether a component has been claimed yet.
Context - Interface in net.kyori.adventure.text.minimessage: Parser context for use within transformations.
create(Key) - Static method in interface net.kyori.adventure.text.minimessage.translation.MiniMessageTranslationStore: Creates a MiniMessage translation store, backed by the default MiniMessage instance.
create(Key, MiniMessage) - Static method in interface net.kyori.adventure.text.minimessage.translation.MiniMessageTranslationStore: Creates a MiniMessage translation store.

D

date(String, TemporalAccessor) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a replacement that inserts a date or a time as a component.
debug(Consumer<String>) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Print debug information to the given output (disabled by default).
decorations() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for all decoration tags.
decorations(TextDecoration) - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for a specific text decoration.
DEFAULT - Enum constant in enum class net.kyori.adventure.text.minimessage.MiniMessage.Preset: The default preset, containing all features of MiniMessage.
defaults() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver that handles all default standard tags.
deserialize(String) - Method in interface net.kyori.adventure.text.minimessage.Context: Deserializes a MiniMessage string using all the settings of this context.
deserialize(String, Pointered) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a component, with a target.
deserialize(String, Pointered, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a component, with a tag resolver to parse tags of the form <key> and a target.
deserialize(String, Pointered, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a component, with tag resolvers to parse tags of the form <key> and a target.
deserialize(String, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.Context: Deserializes a MiniMessage string using all the settings of this context.
deserialize(String, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a component, with a tag resolver to parse tags of the form <key>.
deserialize(String, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.Context: Deserializes a MiniMessage string using all the settings of this context.
deserialize(String, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a component, with tag resolvers to parse tags of the form <key>.
deserializeToTree(String) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements.
deserializeToTree(String, Pointered) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements, with a target.
deserializeToTree(String, Pointered, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements, with a tag resolver to parse tags of the form <key> and a target.
deserializeToTree(String, Pointered, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements, with a tag resolver to parse tags of the form <key>.
deserializeToTree(String, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements, with a tag resolver to parse tags of the form <key>.
deserializeToTree(String, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements, with a tag resolver to parse tags of the form <key>.
detailMessage() - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl
detailMessage() - Method in exception class net.kyori.adventure.text.minimessage.ParsingException: Get the detail message optionally passed with this exception.

E

editTags(Consumer<TagResolver.Builder>) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Add to the set of known tags this MiniMessage instance can use.
ElementNode - Class in net.kyori.adventure.text.minimessage.internal.parser.node: Represents a node in the tree.
emit(TokenEmitter) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.Emitable: Emit tags based on this emitable's data.
Emitable - Interface in net.kyori.adventure.text.minimessage.internal.serializer: Something that holds data representable as MiniMessage tags.
emitVirtuals() - Method in interface net.kyori.adventure.text.minimessage.Context: Dictates if transformations may emit virtual components or not.
emitVirtuals(boolean) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Configures if MiniMessage should emit virtual components (enabled by default).
empty() - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: An empty tag resolver that will return null for all resolve attempts.
endIndex() - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl
endIndex() - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token: Returns the end index of this token.
endIndex() - Method in exception class net.kyori.adventure.text.minimessage.ParsingException: Get the end index of the location which caused this exception.
equals(Object) - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token
ESCAPE - Static variable in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser
escapeTags(String) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Escapes all known tags in the input message, so that they are ignored in deserialization.
escapeTags(String, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Escapes all known tags in the input message, so that they are ignored in deserialization.
escapeTags(String, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Escapes all known tags in the input message, so that they are ignored in deserialization.

F

font() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "font" tag.
FORMATTED_TEXT - Enum constant in enum class net.kyori.adventure.text.minimessage.MiniMessage.Preset: A preset that disables all non-text component types and only allows formatting text components (i.e., color, shadow, decorations, fonts).
Formatter - Class in net.kyori.adventure.text.minimessage.tag.resolver: Tag resolvers producing tags that insert formatted values.
forPreset(MiniMessage.Preset) - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver that handles all standard tags for a given preset.

G

get(CharSequence) - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token: Get the value of this token from the complete message.
getMessage() - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl
getMiniMessageString(String, Locale) - Method in class net.kyori.adventure.text.minimessage.translation.MiniMessageTranslator: Returns a raw MiniMessage string for the given key.
gradient() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "gradient" tag.

H

handle(Component, ClaimConsumer) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver: Attempt to process a component for serialization.
handle(Component, ClaimConsumer) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.SerializableResolver.Single
has(String) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Get whether this resolver handles tags with a certain name.
has(String) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Single
has(String) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.WithoutArguments: Check if this resolver knows of a tag.
hashCode() - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token
hasNext() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue: Get whether another argument is available to be popped.
hoverEvent() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "hover" tag.

I

input - Variable in class net.kyori.adventure.text.minimessage.internal.parser.match.MatchedTokenConsumer
input() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.RootNode
input() - Method in interface net.kyori.adventure.text.minimessage.tree.Node.Root: Get the original provided message which produced this node.
inserting(Component) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will insert a certain component into the output.
inserting(ComponentLike) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will insert a certain component into the output.
Inserting - Interface in net.kyori.adventure.text.minimessage.tag: A tag that inserts a Component into the output.
insertion() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "insert" tag.
isFalse() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Checks if this argument represents false.
isTrue() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Checks if this argument represents true.

J

joining(String, Iterable<? extends ComponentLike>) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a replacement that inserts a list of components.
joining(String, ComponentLike...) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a replacement that inserts a list of components.

K

key() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Single: The key this resolver matches.
keybind() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "key" tag.

L

lastEndIndex() - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.MatchedTokenConsumer: The last accepted end index, or -1 if no match has been accepted.
LOCATION_UNKNOWN - Static variable in exception class net.kyori.adventure.text.minimessage.ParsingException
lowerValue() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Returns the value of this argument, lower-cased in the root locale.

M

MatchedTokenConsumer<T> - Class in net.kyori.adventure.text.minimessage.internal.parser.match: A consumer of a region of a string that was identified as a token.
MatchedTokenConsumer(String) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.match.MatchedTokenConsumer: Creates a new matched token consumer.
miniMessage() - Static method in interface net.kyori.adventure.text.minimessage.MiniMessage: Gets a simple instance with default settings.
miniMessage(MiniMessage.Preset) - Static method in interface net.kyori.adventure.text.minimessage.MiniMessage: Gets an instance based on a specific preset.
MiniMessage - Interface in net.kyori.adventure.text.minimessage: MiniMessage is a textual representation of components.
MiniMessage.Builder - Interface in net.kyori.adventure.text.minimessage: A builder for MiniMessage.
MiniMessage.Preset - Enum Class in net.kyori.adventure.text.minimessage: A variety of presets for configuring MiniMessage.
MiniMessageTranslationStore - Interface in net.kyori.adventure.text.minimessage.translation: A MiniMessage translation store.
MiniMessageTranslator - Class in net.kyori.adventure.text.minimessage.translation: A Translator implementation that translates strings using MiniMessage.
MiniMessageTranslator() - Constructor for class net.kyori.adventure.text.minimessage.translation.MiniMessageTranslator: Constructor for a MiniMessageTranslator using the default MiniMessage instance.
MiniMessageTranslator(MiniMessage) - Constructor for class net.kyori.adventure.text.minimessage.translation.MiniMessageTranslator: Constructor for a MiniMessageTranslator using a specific MiniMessage instance.
Modifying - Interface in net.kyori.adventure.text.minimessage.tag: A tag that can transform a whole subtree of nodes.

N

name() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode: Returns the name of this tag.
NAMES - Static variable in enum class net.kyori.adventure.text.minimessage.MiniMessage.Preset: The name map.
nbt() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "nbt" tag.
net.kyori.adventure.text.minimessage - module net.kyori.adventure.text.minimessage: MiniMessage, a friendly text format for representing chat components.
net.kyori.adventure.text.minimessage - package net.kyori.adventure.text.minimessage: MiniMessage, a friendly text format for representing chat components.
net.kyori.adventure.text.minimessage.internal - package net.kyori.adventure.text.minimessage.internal: Internal API, not for public use.
net.kyori.adventure.text.minimessage.internal.parser - package net.kyori.adventure.text.minimessage.internal.parser: Parser.
net.kyori.adventure.text.minimessage.internal.parser.match - package net.kyori.adventure.text.minimessage.internal.parser.match: Token consumers.
net.kyori.adventure.text.minimessage.internal.parser.node - package net.kyori.adventure.text.minimessage.internal.parser.node: Parser nodes.
net.kyori.adventure.text.minimessage.internal.serializer - package net.kyori.adventure.text.minimessage.internal.serializer: Serializer for the MiniMessage language.
net.kyori.adventure.text.minimessage.tag - package net.kyori.adventure.text.minimessage.tag: Specification of the API for customizing tags understood by MiniMessage.
net.kyori.adventure.text.minimessage.tag.resolver - package net.kyori.adventure.text.minimessage.tag.resolver: Tools for resolving tags based on tag information.
net.kyori.adventure.text.minimessage.tag.standard - package net.kyori.adventure.text.minimessage.tag.standard: Built-in tags shipped with MiniMessage.
net.kyori.adventure.text.minimessage.translation - package net.kyori.adventure.text.minimessage.translation: Tools for working with Adventure's translation API.
net.kyori.adventure.text.minimessage.tree - package net.kyori.adventure.text.minimessage.tree: A stable representation of the MiniMessage parse tree.
newException(String) - Method in interface net.kyori.adventure.text.minimessage.Context: Create a new parsing exception without reference to a specific location.
newException(String, Throwable, ArgumentQueue) - Method in interface net.kyori.adventure.text.minimessage.Context: Create a new parsing exception.
newException(String, ArgumentQueue) - Method in interface net.kyori.adventure.text.minimessage.Context: Create a new parsing exception.
newline() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "newline" tag.
Node - Interface in net.kyori.adventure.text.minimessage.tree: A node in the MiniMessage parse tree.
Node.Root - Interface in net.kyori.adventure.text.minimessage.tree: The root node of a parse.
NON_INTERACTABLE - Enum constant in enum class net.kyori.adventure.text.minimessage.MiniMessage.Preset: A preset that disables all interactive features, such as hover and click events.
number(String, Number) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a replacement that inserts a number as a component.
numeric(String, Number) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named numeric argument.

O

OPEN_CLOSE_TAG - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType
OPEN_TAG - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType
originalText() - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl: Get the message which caused this exception.
originalText() - Method in exception class net.kyori.adventure.text.minimessage.ParsingException: Get the input message which caused this exception.

P

parent() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Returns the parent of this node, if present.
parent() - Method in interface net.kyori.adventure.text.minimessage.tree.Node: Get the parent of this node.
parse(TokenParser.TagProvider, Predicate<String>, String, String, boolean) - Static method in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser: Parse a minimessage string into a tree of nodes.
parsed(String, String) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Placeholder: Creates a placeholder that inserts a MiniMessage string.
ParserDirective - Interface in net.kyori.adventure.text.minimessage.tag: Tags implementing this interface are used to provide directives, or instructions, to the parser directly.
parseString(String, boolean, MatchedTokenConsumer<?>) - Static method in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser: Parses a string, providing information on matched tokens to the matched token consumer.
ParsingException - Exception Class in net.kyori.adventure.text.minimessage: An exception thrown when an error occurs while parsing a MiniMessage string.
ParsingException(String) - Constructor for exception class net.kyori.adventure.text.minimessage.ParsingException: Create a new parsing exception with only a message.
ParsingException(String, Throwable) - Constructor for exception class net.kyori.adventure.text.minimessage.ParsingException: Create a new parsing exception with a message and an optional cause.
ParsingException(String, Throwable, boolean, boolean) - Constructor for exception class net.kyori.adventure.text.minimessage.ParsingException: Create a new parsing exception with a message and an optional cause.
ParsingExceptionImpl - Exception Class in net.kyori.adventure.text.minimessage.internal.parser: An exception that happens while parsing.
ParsingExceptionImpl(String, String, Throwable, boolean, Token...) - Constructor for exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl: Create a new parsing exception.
ParsingExceptionImpl(String, String, Token...) - Constructor for exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl: Create a new parsing exception.
parts() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode: Returns the parts of this tag.
peek() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue: Peek at the next argument without advancing the iteration pointer.
Placeholder - Class in net.kyori.adventure.text.minimessage.tag.resolver: Tag resolvers producing tags that insert fixed values.
pop() - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Explicitly end a token, only needed if there are multiple tokens within an Emitable for some reason.
pop() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue: Pop an argument, throwing an exception if no argument was present.
popOr(String) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue: Pop an argument, throwing an exception if no argument was present.
popOr(Supplier<String>) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue: Pop an argument, throwing an exception if no argument was present.
postProcessor(UnaryOperator<Component>) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Specify a function that takes the component at the end of the parser process.
postVisit() - Method in interface net.kyori.adventure.text.minimessage.tag.Modifying: Called after the entire tree has been visited.
PreProcess - Interface in net.kyori.adventure.text.minimessage.tag: A tag that is applied at the tokenization stage, before the tree is constructed.
preProcessor(UnaryOperator<String>) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Specify a function that takes the string at the start of the parser process.
preProcessParsed(String) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that inserts the content literally into the parse string.
pride() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "pride" tag.

Q

QUOTED - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.serializer.QuotingOverride: Request that this argument is included quoted.
QuotingOverride - Enum Class in net.kyori.adventure.text.minimessage.internal.serializer: The preferred style of argument quoting for a specific argument.

R

rainbow() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "rainbow" tag.
reset() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue: Reset index to the beginning, to begin another attempt.
reset() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "reset" tag.
RESET - Static variable in interface net.kyori.adventure.text.minimessage.tag.ParserDirective: Instructs the parser to reset all style, events, insertions, etc.
resolve(String) - Method in interface net.kyori.adventure.text.minimessage.internal.parser.TokenParser.TagProvider: Resolve by sanitized name.
resolve(String) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Single
resolve(String) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.WithoutArguments: Resolve a tag based only on the provided name.
resolve(String, List<? extends Tag.Argument>, Token) - Method in interface net.kyori.adventure.text.minimessage.internal.parser.TokenParser.TagProvider: Look up a tag.
resolve(String, ArgumentQueue, Context) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Gets a tag from this resolver based on the current state.
resolve(String, ArgumentQueue, Context) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.WithoutArguments
resolve(TagNode) - Method in interface net.kyori.adventure.text.minimessage.internal.parser.TokenParser.TagProvider: Resolve by node.
resolvePreProcessTags(String, TokenParser.TagProvider) - Static method in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser: Resolves all pre-process tags in a string.
resolver(Iterable<? extends TagResolver>) - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Constructs a tag resolver capable of resolving from multiple sources.
resolver(String, BiFunction<ArgumentQueue, Context, Tag>) - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Create a tag resolver that only responds to a single tag name, and whose value does not depend on that name.
resolver(String, Tag) - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: A tag resolver that will resolve a single tag by a case-insensitive key.
resolver(Set<String>, BiFunction<ArgumentQueue, Context, Tag>) - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Create a tag resolver that only responds to certain tag names, and whose value does not depend on that name.
resolver(TagResolver) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add a placeholder resolver to those queried by the result of this builder.
resolver(TagResolver...) - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Constructs a tag resolver capable of resolving from multiple sources.
resolvers(Iterable<? extends TagResolver>) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add placeholder resolvers to those queried by the result of this builder.
resolvers(TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add placeholder resolvers to those queried by the result of this builder.
result() - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.MatchedTokenConsumer: Gets the result of this consumer, if any.
result() - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.StringResolvingMatchedTokenConsumer
result() - Method in class net.kyori.adventure.text.minimessage.internal.parser.match.TokenListProducingMatchedTokenConsumer
RootNode - Class in net.kyori.adventure.text.minimessage.internal.parser.node: Represents the root node of a tree.
RootNode(String, String) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.node.RootNode: Creates a new root node.

S

sanitizeAndAssertValidTagName(String) - Static method in class net.kyori.adventure.text.minimessage.internal.TagInternals: Checks if a tag name matches the pattern for allowed tag names, first sanitizing it by converting the tag name to lowercase.
sanitizeAndCheckValidTagName(String) - Static method in class net.kyori.adventure.text.minimessage.internal.TagInternals: Checks if a tag name matches the pattern for allowed tag names, first sanitizing it by converting the tag name to lowercase.
sanitizePlaceholderName(String) - Static method in interface net.kyori.adventure.text.minimessage.internal.parser.TokenParser.TagProvider: Sanitize placeholder names.
score() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "score" tag.
selector() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "selector" tag.
selfClosingInserting(Component) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will insert a certain component into the output.
selfClosingInserting(ComponentLike) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will insert a certain component into the output.
selfClosingTag(String) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Open a tag with or without arguments that cannot have children.
SEPARATOR - Static variable in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser
sequentialHead() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "head" tag.
SerializableResolver - Interface in net.kyori.adventure.text.minimessage.internal.serializer: A specific TagResolver that can process serialization requests for a component.
SerializableResolver.Single - Interface in net.kyori.adventure.text.minimessage.internal.serializer: A subinterface for resolvers that only handle one single tag.
shadowColor() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "shadow" tags.
sourceMessage() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Returns the source message of this node.
sprite() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "sprite" tag.
standard() - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: Get the tag resolver that resolves all standard tags.
StandardTags - Class in net.kyori.adventure.text.minimessage.tag.standard: Tag types distributed with MiniMessage.
startIndex() - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl
startIndex() - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token: Returns the start index of this token.
startIndex() - Method in exception class net.kyori.adventure.text.minimessage.ParsingException: Get the start index of the location which caused this exception.
strict() - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Returns if this MiniMessage instance is in strict mode.
strict(boolean) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Enables strict mode (disabled by default).
string(String, String) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named string argument.
StringResolvingMatchedTokenConsumer - Class in net.kyori.adventure.text.minimessage.internal.parser.match: A matched token consumer that produces a string and returns a copy of the string with PreProcess tags resolved.
StringResolvingMatchedTokenConsumer(String, TokenParser.TagProvider) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.match.StringResolvingMatchedTokenConsumer: Creates a string resolving matched token consumer.
stripTags(String) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Removes all supported tags in the input message.
stripTags(String, TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Removes all known tags in the input message, so that they are ignored in deserialization.
stripTags(String, TagResolver...) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Removes all known tags in the input message, so that they are ignored in deserialization.
style(String, Emitable) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.ClaimConsumer: Submit a style claim for the active component.
StyleClaim<V> - Interface in net.kyori.adventure.text.minimessage.internal.serializer: A claim of a single style element.
styleClaimed(String) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.ClaimConsumer: Get whether a style element has been claimed yet.
styling(String, StyleBuilderApplicable...) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Placeholder: Creates a style tag which will modify the style of the component.
styling(Consumer<Style.Builder>) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will apply a certain style to components.
styling(StyleBuilderApplicable...) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will apply certain styles to components.
substitute() - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.Emitable: Provide a substitute for this component's actual children.

T

tag() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode: Gets the tag attached to this tag node.
tag() - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Single: The tag returned by this resolver when the key is matching.
tag(String) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Open a tag with or without arguments.
tag(String, BiFunction<ArgumentQueue, Context, Tag>) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add a single dynamically created tag to this resolver.
tag(String, Tag) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add a single tag to this resolver.
tag(String, Tag) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates a named tag argument.
tag(Set<String>, BiFunction<ArgumentQueue, Context, Tag>) - Method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver.Builder: Add a single dynamically created tag to this resolver.
tag(Tag) - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode: Sets the tag logic that is represented by this tag node.
Tag - Interface in net.kyori.adventure.text.minimessage.tag: A tag definition for the MiniMessage language.
TAG_END - Static variable in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser
TAG_NAME_REGEX - Static variable in annotation interface net.kyori.adventure.text.minimessage.tag.TagPattern: The tag name regex.
TAG_START - Static variable in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser
TAG_VALUE - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType
Tag.Argument - Interface in net.kyori.adventure.text.minimessage.tag: An argument that can be passed to a tag, after the first :.
TagInternals - Class in net.kyori.adventure.text.minimessage.internal: Utility class for tag naming.
TagNode - Class in net.kyori.adventure.text.minimessage.internal.parser.node: Node that represents a tag.
TagNode(ElementNode, Token, String, TokenParser.TagProvider) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode: Creates a new element node.
TagPart - Class in net.kyori.adventure.text.minimessage.internal.parser.node: Represents an inner part of a tag.
TagPart(String, Token, TokenParser.TagProvider) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.node.TagPart: Constructs a new tag part.
TagPattern - Annotation Interface in net.kyori.adventure.text.minimessage.tag: A Tag name must match this pattern.
tagResolver(Iterable<TagResolver>) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates an argument used to add arbitrary tag resolvers to the deserialization process.
tagResolver(TagResolver) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates an argument used to add arbitrary tag resolvers to the deserialization process.
tagResolver(TagResolver...) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates an argument used to add arbitrary tag resolvers to the deserialization process.
TagResolver - Interface in net.kyori.adventure.text.minimessage.tag.resolver: A collection of known tags.
TagResolver.Builder - Interface in net.kyori.adventure.text.minimessage.tag.resolver: A builder to gradually construct tag resolvers.
TagResolver.Single - Interface in net.kyori.adventure.text.minimessage.tag.resolver: A resolver that only handles a single tag key.
TagResolver.WithoutArguments - Interface in net.kyori.adventure.text.minimessage.tag.resolver: A tag resolver that only handles tags which do not take arguments.
tags() - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Returns the base tag resolver of this MiniMessage instance.
tags(TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Set the known tags to the provided tag resolver.
target() - Method in interface net.kyori.adventure.text.minimessage.Context: The target of the parse context, if provided.
target(Pointered) - Static method in class net.kyori.adventure.text.minimessage.translation.Argument: Creates an argument used to set the target of the deserialization process.
targetAsType(Class<T>) - Method in interface net.kyori.adventure.text.minimessage.Context: The target of the parse context, casted to a provided type.
targetOrThrow() - Method in interface net.kyori.adventure.text.minimessage.Context: The target of the parse context.
text(String) - Method in interface net.kyori.adventure.text.minimessage.internal.serializer.TokenEmitter: Emit literal text.
TEXT - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType
TextNode - Class in net.kyori.adventure.text.minimessage.internal.parser.node: Represents a string of chars.
TextNode(ElementNode, Token, String) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.node.TextNode: Creates a new text node.
token() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Returns the token that lead to the creation of this token.
token() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagNode
token() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagPart: Returns the token that created this tag part.
token() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ValueNode
Token - Class in net.kyori.adventure.text.minimessage.internal.parser: Represents a token for the lexer.
Token(int, int, TokenType) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.Token: Creates a new token.
TokenEmitter - Interface in net.kyori.adventure.text.minimessage.internal.serializer: A consumer of tokens used to generate MiniMessage output.
tokenize(String, boolean) - Static method in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser: Tokenize a minimessage string into a list of tokens.
TokenListProducingMatchedTokenConsumer - Class in net.kyori.adventure.text.minimessage.internal.parser.match: A matched token consumer that produces a list of matched tokens.
TokenListProducingMatchedTokenConsumer(String) - Constructor for class net.kyori.adventure.text.minimessage.internal.parser.match.TokenListProducingMatchedTokenConsumer: Creates a new token list producing matched token consumer.
TokenParser - Class in net.kyori.adventure.text.minimessage.internal.parser: Handles parsing a string into a list of tokens and then into a tree of nodes.
TokenParser.TagProvider - Interface in net.kyori.adventure.text.minimessage.internal.parser: Normalizing provider for tag information.
tokens() - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl: Gets the tokens associated with this parsing error.
tokens(Token[]) - Method in exception class net.kyori.adventure.text.minimessage.internal.parser.ParsingExceptionImpl: Sets the tokens associated with this parsing error.
TokenType - Enum Class in net.kyori.adventure.text.minimessage.internal.parser: Represents the type of a token.
toString() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode
toString() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagPart
toString() - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token
toString() - Method in interface net.kyori.adventure.text.minimessage.tree.Node: Get a human-readable representation of this node and its descendants for debugging purposes.
toTagResolver() - Static method in interface net.kyori.adventure.text.minimessage.tag.resolver.TagResolver: A collector that will combine a stream of resolvers into one joined resolver.
transition() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "transition" tag.
translatable() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "translate" tag.
translatableFallback() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "translate_or" tag.
translate(String, Locale) - Method in class net.kyori.adventure.text.minimessage.translation.MiniMessageTranslator
translate(TranslatableComponent, Locale) - Method in class net.kyori.adventure.text.minimessage.translation.MiniMessageTranslator
type() - Method in class net.kyori.adventure.text.minimessage.internal.parser.Token: Returns the type of this token.

U

unescape(String, int, int, IntPredicate) - Static method in class net.kyori.adventure.text.minimessage.internal.parser.TokenParser: Removes escaping '\` characters from a substring where the subsequent character matches a given predicate.
unparsed(String, String) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Placeholder: Creates a placeholder that inserts a literal string, without attempting to parse any contained tags.
unquoteAndEscape(String, int, int) - Static method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagPart: Removes leading/trailing quotes from the given string, if necessary, and removes escaping '\' characters.
UNQUOTED - Enum constant in enum class net.kyori.adventure.text.minimessage.internal.serializer.QuotingOverride: Request that this argument is included unquoted.
unsafeChildren() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ElementNode: Returns an unsafe view of the children of this node.

V

value() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.TagPart: Returns the value of this tag part.
value() - Method in class net.kyori.adventure.text.minimessage.internal.parser.node.ValueNode: Returns the value of this text node.
value() - Method in interface net.kyori.adventure.text.minimessage.tag.Inserting: Returns the component this tag produces.
value() - Method in interface net.kyori.adventure.text.minimessage.tag.PreProcess: The value to insert at the pre-process phase.
value() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Returns the value of this argument.
ValueNode - Class in net.kyori.adventure.text.minimessage.internal.parser.node: Represents a node in the tree which has a text value.
valueOf(String) - Static method in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.kyori.adventure.text.minimessage.internal.serializer.QuotingOverride: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class net.kyori.adventure.text.minimessage.MiniMessage.Preset: Returns the enum constant of this class with the specified name.
values() - Static method in enum class net.kyori.adventure.text.minimessage.internal.parser.TokenType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.kyori.adventure.text.minimessage.internal.serializer.QuotingOverride: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class net.kyori.adventure.text.minimessage.MiniMessage.Preset: Returns an array containing the constants of this enum class, in the order they are declared.
visit(Node, int) - Method in interface net.kyori.adventure.text.minimessage.tag.Modifying: Method called once for every element in the subtree, allowing calculations to be made before application.

A B C D E F G H I J K L M N O P Q R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form