Index (adventure-text-minimessage 4.14.0 API)

A B C D E F G H I K L M N O P R S T U V
All Classes All Packages

A

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.
ArgumentQueue - Interface in net.kyori.adventure.text.minimessage.tag.resolver: A queue of Tag arguments.
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.

B

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.

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 interface net.kyori.adventure.text.minimessage.tree.Node: Get children of this node.
choice(String, Number) - Static method in class net.kyori.adventure.text.minimessage.tag.resolver.Formatter: Creates a replacement that inserts a choice formatted text.
clickEvent() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "click" tag.
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.
Context - Interface in net.kyori.adventure.text.minimessage: Parser context for use within transformations.

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.
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, 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.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.
deserializeToTree(String) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage: Deserializes a string into a tree of parsed elements, This is intended for inspecting the output of the parser for debugging purposes.
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 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.
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 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.tag.standard.TransitionTag
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.
examinableProperties() - Method in class net.kyori.adventure.text.minimessage.tag.standard.TransitionTag

F

font() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "font" tag.
Formatter - Class in net.kyori.adventure.text.minimessage.tag.resolver: Tag resolvers producing tags that insert formatted values.

G

gradient() - Static method in class net.kyori.adventure.text.minimessage.tag.standard.StandardTags: Get a resolver for the "gradient" tag.

H

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.tag.standard.TransitionTag
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() - 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.

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

LOCATION_UNKNOWN - Static variable in exception 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

miniMessage() - Static method in interface net.kyori.adventure.text.minimessage.MiniMessage: Gets a simple instance with default settings.
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.
Modifying - Interface in net.kyori.adventure.text.minimessage.tag: A tag that can transform a whole subtree of nodes.

N

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 - package net.kyori.adventure.text.minimessage: MiniMessage, a friendly text format for representing chat components.
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.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, ArgumentQueue) - Method in interface net.kyori.adventure.text.minimessage.Context: Create a new parsing exception.
newException(String, Throwable, 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.
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.

O

originalText() - Method in exception net.kyori.adventure.text.minimessage.ParsingException: Get the input message which caused this exception.

P

parent() - Method in interface net.kyori.adventure.text.minimessage.tree.Node: Get the parent of this node.
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.
ParsingException - Exception in net.kyori.adventure.text.minimessage: An exception thrown when an error occurs while parsing a MiniMessage string.
ParsingException(String) - Constructor for exception net.kyori.adventure.text.minimessage.ParsingException: Create a new parsing exception with only a message.
ParsingException(String, Throwable) - Constructor for exception 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 net.kyori.adventure.text.minimessage.ParsingException: Create a new parsing exception with a message and an optional cause.
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.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.

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.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, 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
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.

S

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.
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 net.kyori.adventure.text.minimessage.ParsingException: Get the start index of the location which caused this exception.
strict(boolean) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Enables strict mode (disabled by default).
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.
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(StyleBuilderApplicable...) - Static method in interface net.kyori.adventure.text.minimessage.tag.Tag: Create a tag that will apply certain styles to components.
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.

T

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, 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(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 - Interface in net.kyori.adventure.text.minimessage.tag: A tag definition for the MiniMessage language.
Tag.Argument - Interface in net.kyori.adventure.text.minimessage.tag: An argument that can be passed to a tag, after the first :.
TagPattern - Annotation Type in net.kyori.adventure.text.minimessage.tag: A Tag name must match this pattern.
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(TagResolver) - Method in interface net.kyori.adventure.text.minimessage.MiniMessage.Builder: Set the known tags to the provided tag resolver.
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.
TRANSITION - Static variable in class net.kyori.adventure.text.minimessage.tag.standard.TransitionTag
TransitionTag - Class in net.kyori.adventure.text.minimessage.tag.standard: Changes the color based on a phase param.
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.

U

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.

V

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 class net.kyori.adventure.text.minimessage.tag.standard.TransitionTag
value() - Method in interface net.kyori.adventure.text.minimessage.tag.Tag.Argument: Returns the value of this argument.
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 K L M N O P R S T U V
All Classes All Packages