All Classes and Interfaces
Class
Description
A builder.
An abstract implementation of a component renderer.
An abstraction to ease the construction of translation stores with generic values.
An abstract, string-based translation store.
We're going on an Adventure!
Adventure properties.
A service provider that allows default property values to be overridden.
A property.
A serializer which emits ANSI escape sequences.
A builder for the ANSI component serializer.
A
ANSIComponentSerializer service provider.Something that can provide red, green, and blue, and alpha colour components.
A utility class to create arguments for
translatable components.A queue of
Tag arguments.An array binary tag.
A receiver of Minecraft media.
Audience-related utilities.A binary tag.
Holds a compound binary tag.
Serialization operations for binary tags.
Compression types.
CompoundBinaryTag reader.CompoundBinaryTag writer.Something that can be represented as a binary tag.
A binary tag type.
A binary tag reader.
A binary tag writer.
All known binary tag types.
Given an in-game position, this component reads the NBT of the associated block and displays that information.
An NBT component builder.
A local position.
A position.
A world position.
A coordinate component within a
BlockNBTComponent.WorldPos.The type of a coordinate.
Represents the in-game interface of a book.
A builder for a
Book.Something that can be represented as a
Book.Represents an in-game bossbar which can be shown to the client.
One of the colors the bar component of a
BossBar.Flags to control toggleable effects of a bossbar.
A listener for changes that happen on a
BossBar.An overlay on the bar component of a bossbar.
BossBar internal implementation.A
BossBarImplementation service provider.Something that can view a
BossBar.Something that can be built.
A binary tag holding a
byte-array value.A binary tag holding a
byte value.A combination of a
character, a TextFormat, and if the character is CharacterAndFormat.caseInsensitive().A type of chat.
A bound
ChatType.A consumer of serialization claims.
A handler for callback click events.
Options to configure how a callback can be executed.
A builder for callback options.
A provider for actually producing click callbacks.
A click event.
An enumeration of click event actions.
Changes the page of a book.
Copies text to the clipboard.
Sends a custom event to the server.
Opens a file when clicked.
Opens a url when clicked.
Runs a command when clicked.
Shows a dialog.
Suggests a command.
An action with a text payload.
A payload for a click event.
A payload with a key and optional custom NBT data.
A payload that holds a dialog.
A payload that holds an integer.
A payload that holds a string.
A combination encoder and decoder.
A decoder.
An encoder.
A Component is an immutable object that represents how text
is displayed Minecraft clients.
Something that can be applied to a
Component.A component builder.
Something that can be applied to a
ComponentBuilder.A
Component decoder, which provides deserialization, but without serialization.A
Component encoder, which provides serialization, but without deserialization.A 'flattener' to convert a component tree to a linear string for display.
A builder for a component flattener.
Flags to modify the behaviour of a component iterator.
The iterator types.
Something that can be represented as a
Component.An extended type of Logger capable of logging formatted components to the console.
A service interface for platforms to provide their own component logger implementations.
A factory for default implementations of component loggers.
A builder for logging events that accepts
Component messages and arguments.A component renderer.
A
Component serializer and deserializer.Constants to aid in the creation and testing of tree-based component serializers.
Binary tag holding a mapping of string keys to
BinaryTag values.A compound tag builder.
Common methods between
CompoundBinaryTag and CompoundBinaryTag.Builder.A serializer that will output to Configurate
ConfigurationNodes.A builder for a configurate serializer instance.
A data component value that can integrate with configuration nodes.
Parser context for use within transformations.
A holder for the value of an item's data component.
Only valid in a patch-style usage, indicating that the data component with a certain key should be removed.
Represent an
DataComponentValue that can be represented as a binary tag.A registry for conversions between different data component value holder classes.
A single conversion that may be provided by a provider.
A provider for data component value converters.
Something that can be represented as a Dialog.
A binary tag holding a
double value.Represents a node in the tree.
Something that holds data representable as MiniMessage tags.
An end tag.
Given a Minecraft selector, this component reads the NBT of the associated entity and displays that information.
An entity NBT component builder.
A listener accepting styled information from flattened components.
A binary tag holding a
float value.Tag resolvers producing tags that insert formatted values.
A receiver that wraps one or more receivers.
An audience that forwards everything to a single other audience.
An iterable that forwards the
ForwardingIterator.iterator() and ForwardingIterator.spliterator() calls to some suppliers.A global source of translations.
A gson component serializer.
A builder for
GsonComponentSerializer.A
GsonComponentSerializer service provider.An
DataComponentValue implementation that holds a JsonElement.A provider for Gson's implementations of data component value converters.
A hover event.
An enumeration of hover event actions.
Type-specific renderer.
The value of a
show_entity hover event.The value of a
show_item hover event.Something that can provide a
HoverEvent.Something that can provide hue, saturation, and value color components.
Something that can be identified by an
Identity.An identity used to track the sender of messages for the social interaction features
introduced in Minecraft: Java Edition 1.16.4.
A bidirectional map in which keys and values must be unique.
A map type that will traverse class hierarchy to find a value for a key.
A builder for inheritance-aware maps.
A tag that inserts a
Component into the output.A binary tag holding an
int-array value.A binary tag holding an
int value.A function that takes two
ints as input and produces a R result.This exception is thrown when an invalid namespace and/or value has been detected while creating a
Key.A configuration for how a series of components can be joined.
A builder for join configurations.
A JSON component serializer.
A builder for
JSONComponentSerializer instances that delegates to the active serializer.A
JSONComponentSerializer service provider.Implementation of the JSON component serializer provider.
Options that can apply to JSON serializers.
Configure how to emit click event values.
Configure how to emit hover event values.
How text shadow colors should be emitted.
Configure how to emit show_item hovers.
An identifying object used to fetch and/or store unique objects.
A
Component that displays the client's current keybind for the supplied action.A keybind component builder.
Something that can provide a keybind identifier.
Something that has an associated
Key.A
T value with an associated Key.An annotation used to annotate elements that must match against a valid
Key pattern.A legacy component serializer.
A builder for
LegacyComponentSerializer.A
LegacyComponentSerializer service provider.A legacy format.
Adapter to convert between modern and legacy hover event formats.
A utility class that allows
components to be created where styles can be specified inline.A list of a single tag type.
A list tag builder.
Something that has listeners.
Common methods between
ListBinaryTag and ListBinaryTag.Builder.A binary tag holding a
long-array value.A binary tag holding a
long value.A consumer of a region of a string that was identified as a token.
MiniMessage is a textual representation of components.
A builder for
MiniMessage.A variety of presets for configuring MiniMessage.
A MiniMessage translation store.
A
Translator implementation that translates strings using MiniMessage.A tag that can transform a whole subtree of nodes.
Collection related utilities.Writes style properties to a mutable object.
A nag.
The named text colours in Minecraft: Java Edition.
Something that has a namespace.
A component that can display NBT fetched from different locations, optionally trying to interpret the NBT as JSON
using the
net.kyori.adventure.text.serializer.gson.GsonComponentSerializer to convert the JSON to a Component.An NBT component builder.
A legacy
HoverEvent serializer.A node in the MiniMessage parse tree.
The root node of a parse.
A numeric binary tag.
Displays a non-text object.
An object component builder.
An object component contents.
Tags implementing this interface are used to provide directives, or instructions, to the parser directly.
An exception thrown when an error occurs while parsing a MiniMessage string.
An exception that happens while parsing.
A result for
Component.replaceText(TextReplacementConfig) pattern-based replacements}.Something that has permissions.
Tag resolvers producing tags that insert fixed values.
A plain-text component serializer.
A builder for the plain-text component serializer.
A
PlainTextComponentSerializer service provider.Elements annotated with the
PlatformAPI annotation are intended for platform implementations of the Adventure API
only and should not be used by standard developers.A player head contents.
A builder for a
PlayerHeadObjectContents.A player profile property value with an optional signature.
A source of player skin data.
A pointer to a resource.
Something that can retrieve values based on a given
Pointer.A collection of
pointers.A builder of pointers.
A supplier of
Pointers that allows for the implementation of pointers
in a static context without having to manually create a new pointers instance for
each instance of a given type.A builder for
PointersSupplier.A tag that is applied at the tokenization stage, before the tree is constructed.
The preferred style of argument quoting for a specific argument.
The reset directive.
A callback for a resource pack application operation.
Represents information about a resource pack that can be sent to players.
A builder for resource pack requests.
Something that can be represented as a
ResourcePackInfo.A request to apply one or more resource packs to a client.
A builder for resource pack requests.
Something that can be represented as a
ResourcePackRequest.Resource pack application state.
Something that can provide red, green, and blue colour components.
Represents the root node of a tree.
Some magic to change return types.
A component that can display a player's score from a scoreboard objective,
with an optional fallback value if the search for the score fails.
A score component builder.
A component that can display the name of entities found with a given selector.
A selector component builder.
A specific
TagResolver that can process serialization requests for a component.A subinterface for resolvers that only handle one single tag.
Tools for working with
ServiceLoaders.A fallback service.
A shadow color which may be applied to a
Style.Various utilities.
A binary tag holding a
short value.A signed chat message.
A signature wrapper type.
Represents an in-game sound which can be played to the client.
A builder for sound instances.
An emitter of sounds.
The sound source.
A provider of sound sources.
A sound type.
A sound and/or a sound source, used for stopping in-game sounds that
are being played on a game client matching the given sound and/or sound source.
A sprite contents.
Tag types distributed with MiniMessage.
Given a
Key, this component reads the NBT of the associated command storage and displays that information.A command storage NBT component builder.
A binary tag holding a
String value.A matched token consumer that produces a string and returns a copy of the string with
PreProcess tags resolved.A style applies visual effects or extra functionality to
Components,
such as TextColors, TextDecorations, ClickEvents etc.A style builder.
A merge choice.
A merge strategy.
Something that can be applied to a
Style.A claim of a single style element.
Reads style properties from an object.
Writes style properties to an object.
A tag definition for the MiniMessage language.
An argument that can be passed to a tag, after the first
:.Utility class for tag naming.
Node that represents a tag.
Represents an inner part of a tag.
A
Tag name must match this pattern.A collection of known tags.
A builder to gradually construct tag resolvers.
A resolver that only handles a single tag key.
A tag resolver that only handles tags which do not take arguments.
A holder for string tag format options.
Builder for a SNBT I/O handler.
A color which may be applied to a
Style.A component that displays a string.
A text component builder.
An enumeration of decorations which may be applied to a
Component.A state that a
TextDecoration can be in.A combination of a
TextDecoration and a TextDecoration.State.A format which may be applied to a
Component.Represents a string of chars.
A configuration for how text can be replaced in a component.
A builder for replacement configurations.
A function determining whether a certain match should be replaced.
Standard game tick utilities.
Represents an in-game title, which can be displayed across the centre of the screen.
Title times.
A part of a title.
Represents a token for the lexer.
A consumer of tokens used to generate MiniMessage output.
A matched token consumer that produces a list of matched tokens.
Handles parsing a string into a list of tokens and then into a tree of nodes.
Normalizing provider for tag information.
Represents the type of a token.
Something that has a translation key.
A component that can display translated text.
A text component builder.
A component renderer that does server-side translation rendering.
An argument that can be part of a
TranslatableComponent.Represents anything that can be represented as a non-
Component TranslationArgument.A store of translation values.
An abstract, string-based translation store.
A message translator.
Similar to a
boolean but with three states.Represents a node in the tree which has a text value.
A virtual component.
A holder for a value.