Uses of Interface
net.kyori.adventure.text.ComponentLike

Packages that use ComponentLike

Package	Description
net.kyori.adventure.audience	A receiver of Minecraft media.
net.kyori.adventure.bossbar	Boss bars.
net.kyori.adventure.chat	Chat-related data.
net.kyori.adventure.text	Data for controlling components, their styles, and events.
net.kyori.adventure.text.event	Events that occur when players interact with components.

Uses of ComponentLike in net.kyori.adventure.audience

Methods in net.kyori.adventure.audience with parameters of type ComponentLike

Modifier and Type	Method	Description
default void	Audience.sendActionBar(ComponentLike message)	Sends a message on the action bar.
static Consumer<? super Audience>	Audiences.sendingMessage(ComponentLike message)	Creates an action to send a message.
default void	Audience.sendMessage(ComponentLike message)	Sends a system chat message to this Audience.
default void	Audience.sendMessage(ComponentLike message, ChatType.Bound boundChatType)	Sends a message to this Audience with the provided bound chat type.
default void	Audience.sendPlayerListFooter(ComponentLike footer)	Sends the player list footer.
default void	Audience.sendPlayerListHeader(ComponentLike header)	Sends the player list header.
default void	Audience.sendPlayerListHeaderAndFooter(ComponentLike header, ComponentLike footer)	Sends the player list header and footer.

Uses of ComponentLike in net.kyori.adventure.bossbar

Methods in net.kyori.adventure.bossbar with parameters of type ComponentLike

Modifier and Type	Method	Description
static BossBar	BossBar.bossBar(ComponentLike name, float progress, BossBar.Color color, BossBar.Overlay overlay)	Creates a new bossbar.
static BossBar	BossBar.bossBar(ComponentLike name, float progress, BossBar.Color color, BossBar.Overlay overlay, Set<BossBar.Flag> flags)	Creates a new bossbar.
default BossBar	BossBar.name(ComponentLike name)	Sets the name.

Uses of ComponentLike in net.kyori.adventure.chat

Methods in net.kyori.adventure.chat with parameters of type ComponentLike

Modifier and Type	Method	Description
default ChatType.Bound	ChatType.bind(ComponentLike name)	Creates a bound chat type with a name Component.
default ChatType.Bound	ChatType.bind(ComponentLike name, @Nullable ComponentLike target)	Creates a bound chat type with a name and target Component.
static SignedMessage	SignedMessage.system(String message, @Nullable ComponentLike unsignedContent)	Creates a system SignedMessage.

Uses of ComponentLike in net.kyori.adventure.text

Subinterfaces of ComponentLike in net.kyori.adventure.text

Modifier and Type	Interface	Description
interface	BlockNBTComponent	Given an in-game position, this component reads the NBT of the associated block and displays that information.
static interface	BlockNBTComponent.Builder	An NBT component builder.
interface	BuildableComponent<C extends Component,B extends ComponentBuilder<C,?>>	Deprecated, for removal: This API element is subject to removal in a future version. For removal in 6.0, since 4.26 with no replacement.
interface	Component	A Component is an immutable object that represents how text is displayed Minecraft clients.
interface	ComponentBuilder<C extends Component,B extends ComponentBuilder<C,B>>	A component builder.
interface	EntityNBTComponent	Given a Minecraft selector, this component reads the NBT of the associated entity and displays that information.
static interface	EntityNBTComponent.Builder	An entity NBT component builder.
interface	KeybindComponent	A Component that displays the client's current keybind for the supplied action.
static interface	KeybindComponent.Builder	A keybind component builder.
interface	NBTComponent<C extends NBTComponent<C>>	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.
interface	NBTComponentBuilder<C extends NBTComponent<C>,B extends NBTComponentBuilder<C,B>>	An NBT component builder.
interface	ObjectComponent	Displays a non-text object.
static interface	ObjectComponent.Builder	An object component builder.
interface	ScopedComponent<C extends Component>	Some magic to change return types.
interface	ScoreComponent	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.
static interface	ScoreComponent.Builder	A score component builder.
interface	SelectorComponent	A component that can display the name of entities found with a given selector.
static interface	SelectorComponent.Builder	A selector component builder.
interface	StorageNBTComponent	Given a Key, this component reads the NBT of the associated command storage and displays that information.
static interface	StorageNBTComponent.Builder	A command storage NBT component builder.
interface	TextComponent	A component that displays a string.
static interface	TextComponent.Builder	A text component builder.
interface	TranslatableComponent	A component that can display translated text.
static interface	TranslatableComponent.Builder	A text component builder.
interface	TranslationArgument	An argument that can be part of a TranslatableComponent.
interface	TranslationArgumentLike	Represents anything that can be represented as a non-Component TranslationArgument.
interface	VirtualComponent	A virtual component.

Methods in net.kyori.adventure.text that return ComponentLike

Modifier and Type	Method	Description
@UnknownNullability ComponentLike	VirtualComponentRenderer.apply(C context)	Gets the value by rendering using context.

Methods in net.kyori.adventure.text that return types with arguments of type ComponentLike

Modifier and Type	Method	Description
Function<ComponentLike,Component>	JoinConfiguration.convertor()	Gets the convertor of this join configuration.
Predicate<ComponentLike>	JoinConfiguration.predicate()	Gets the predicate of this join configuration.

Methods in net.kyori.adventure.text with parameters of type ComponentLike

Modifier and Type	Method	Description
default Component	Component.append(ComponentLike like)	Appends a component to this component.
default Component	Component.append(ComponentLike... components)	Appends components to this component.
default B	ComponentBuilder.append(ComponentLike component)	Appends a component to this component.
B	ComponentBuilder.append(ComponentLike... components)	Appends components to this component.
default C	ScopedComponent.append(ComponentLike like)
default C	ScopedComponent.append(ComponentLike... components)
TranslatableComponent	TranslatableComponent.arguments(ComponentLike... args)	Sets the translation arguments for this component.
TranslatableComponent.Builder	TranslatableComponent.Builder.arguments(ComponentLike... args)	Sets the translation args.
static BlockNBTComponent	Component.blockNBT(String nbtPath, boolean interpret, @Nullable ComponentLike separator, BlockNBTComponent.Pos pos)	Creates a block NBT component with a position.
static TranslationArgument	TranslationArgument.component(ComponentLike value)	Create a component argument.
ObjectComponent.Builder	ObjectComponent.Builder.fallback(@Nullable ComponentLike fallback)	Sets the fallback component of this object component builder.
ObjectComponent	ObjectComponent.fallback(@Nullable ComponentLike fallback)	Creates a copy of this object component with the given fallback.
static Component	Component.join(JoinConfiguration.Builder configBuilder, ComponentLike... components)	Joins components using the configuration in configBuilder.
static Component	Component.join(JoinConfiguration config, ComponentLike... components)	Joins components using the configuration in config.
JoinConfiguration.Builder	JoinConfiguration.Builder.lastSeparator(@Nullable ComponentLike lastSeparator)	Sets the last separator of this join configuration builder.
JoinConfiguration.Builder	JoinConfiguration.Builder.lastSeparatorIfSerial(@Nullable ComponentLike lastSeparatorIfSerial)	Sets the last separator that will be used instead of the normal last separator in the case where there are more than two components being joined.
JoinConfiguration.Builder	JoinConfiguration.Builder.prefix(@Nullable ComponentLike prefix)	Sets the prefix of this join configuration builder.
default TextReplacementConfig.Builder	TextReplacementConfig.Builder.replacement(@Nullable ComponentLike replacement)	Supply a literal replacement for the matched pattern.
static SelectorComponent	Component.selector(String pattern, @Nullable ComponentLike separator)	Creates a selector component with a pattern.
JoinConfiguration.Builder	JoinConfiguration.Builder.separator(@Nullable ComponentLike separator)	Sets the separator of this join configuration builder.
static JoinConfiguration	JoinConfiguration.separator(@Nullable ComponentLike separator)	Creates a join configuration with a separator and no prefix or suffix.
C	NBTComponent.separator(@Nullable ComponentLike separator)	Sets the separator.
B	NBTComponentBuilder.separator(@Nullable ComponentLike separator)	Sets the separator.
SelectorComponent.Builder	SelectorComponent.Builder.separator(@Nullable ComponentLike separator)	Sets the separator.
SelectorComponent	SelectorComponent.separator(@Nullable ComponentLike separator)	Sets the separator.
static JoinConfiguration	JoinConfiguration.separators(@Nullable ComponentLike separator, @Nullable ComponentLike lastSeparator)	Creates a join configuration with a separator and last separator but no prefix or suffix.
static StorageNBTComponent	Component.storageNBT(String nbtPath, boolean interpret, @Nullable ComponentLike separator, Key storage)	Creates a storage NBT component with a path and an storage ID.
JoinConfiguration.Builder	JoinConfiguration.Builder.suffix(@Nullable ComponentLike suffix)	Sets the suffix of this join configuration builder.
static TextComponent	Component.textOfChildren(ComponentLike... components)	Creates a text component with components as the children.
static TranslatableComponent	Component.translatable(String key, @Nullable String fallback, ComponentLike... args)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(String key, @Nullable String fallback, Style style, ComponentLike... args)	Creates a translatable component with a translation key, optional fallback string, and styling.
static TranslatableComponent	Component.translatable(String key, ComponentLike... args)	Creates a translatable component with a translation key and arguments.
static TranslatableComponent	Component.translatable(String key, @Nullable TextColor color, Set<TextDecoration> decorations, ComponentLike... args)	Creates a translatable component with a translation key, arguments, and optional color and decorations.
static TranslatableComponent	Component.translatable(String key, @Nullable TextColor color, ComponentLike... args)	Creates a translatable component with a translation key, arguments, and optional color.
static TranslatableComponent	Component.translatable(String key, Style style, ComponentLike... args)	Creates a translatable component with a translation key and styling.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable String fallback, ComponentLike... args)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable String fallback, Style style, ComponentLike... args)	Creates a translatable component with a translation key, optional fallback string, and styling.
static TranslatableComponent	Component.translatable(Translatable translatable, ComponentLike... args)	Creates a translatable component with a translation key and arguments.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable TextColor color, Set<TextDecoration> decorations, ComponentLike... args)	Creates a translatable component with a translation key, arguments, and optional color and decorations.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable TextColor color, ComponentLike... args)	Creates a translatable component with a translation key, arguments, and optional color.
static TranslatableComponent	Component.translatable(Translatable translatable, Style style, ComponentLike... args)	Creates a translatable component with a translation key and styling.
static @Nullable Component	ComponentLike.unbox(@Nullable ComponentLike like)	Fetches a Component from a ComponentLike.

Method parameters in net.kyori.adventure.text with type arguments of type ComponentLike

Modifier and Type	Method	Description
default Component	Component.append(List<? extends ComponentLike> components)	Appends a list of components to this component.
B	ComponentBuilder.append(Iterable<? extends ComponentLike> components)	Appends components to this component.
default C	ScopedComponent.append(List<? extends ComponentLike> components)
TranslatableComponent	TranslatableComponent.arguments(List<? extends ComponentLike> args)	Sets the translation arguments for this component.
TranslatableComponent.Builder	TranslatableComponent.Builder.arguments(List<? extends ComponentLike> args)	Sets the translation args.
static List<Component>	ComponentLike.asComponents(List<? extends ComponentLike> likes)	Converts a list of ComponentLikes to a list of Components.
static List<Component>	ComponentLike.asComponents(List<? extends ComponentLike> likes, @Nullable Predicate<? super Component> filter)	Converts a list of ComponentLikes to a list of Components.
Component	Component.children(List<? extends ComponentLike> children)	Sets the list of children.
C	ScopedComponent.children(List<? extends ComponentLike> children)
JoinConfiguration.Builder	JoinConfiguration.Builder.convertor(Function<ComponentLike,Component> convertor)	Sets the convertor of this join configuration builder.
static Component	Component.join(JoinConfiguration.Builder configBuilder, Iterable<? extends ComponentLike> components)	Joins components using the configuration in configBuilder.
static Component	Component.join(JoinConfiguration config, Iterable<? extends ComponentLike> components)	Joins components using the configuration in config.
JoinConfiguration.Builder	JoinConfiguration.Builder.predicate(Predicate<ComponentLike> predicate)	Sets the predicate of this join configuration builder.
TextReplacementConfig.Builder	TextReplacementConfig.Builder.replacement(BiFunction<MatchResult,TextComponent.Builder,@Nullable ComponentLike> replacement)	Supply a function that provides replacements for each match, with access to group information.
default TextReplacementConfig.Builder	TextReplacementConfig.Builder.replacement(Function<TextComponent.Builder,@Nullable ComponentLike> replacement)	Supply a function that provides replacements for each match.
static TranslatableComponent	Component.translatable(String key, @Nullable String fallback, List<? extends ComponentLike> args, Iterable<StyleBuilderApplicable> style)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(String key, @Nullable String fallback, List<? extends ComponentLike> args, StyleBuilderApplicable... style)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(String key, @Nullable String fallback, Style style, List<? extends ComponentLike> args)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(String key, List<? extends ComponentLike> args)	Creates a translatable component with a translation key and arguments.
static TranslatableComponent	Component.translatable(String key, @Nullable TextColor color, List<? extends ComponentLike> args)	Creates a translatable component with a translation key, arguments, and optional color.
static TranslatableComponent	Component.translatable(String key, @Nullable TextColor color, Set<TextDecoration> decorations, List<? extends ComponentLike> args)	Creates a translatable component with a translation key, arguments, and optional color and decorations.
static TranslatableComponent	Component.translatable(String key, Style style, List<? extends ComponentLike> args)	Creates a translatable component with a translation key and styling.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable String fallback, List<? extends ComponentLike> args, Iterable<StyleBuilderApplicable> style)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable String fallback, List<? extends ComponentLike> args, StyleBuilderApplicable... style)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable String fallback, Style style, List<? extends ComponentLike> args)	Creates a translatable component with a translation key, optional fallback string, and arguments.
static TranslatableComponent	Component.translatable(Translatable translatable, List<? extends ComponentLike> args)	Creates a translatable component with a translation key and arguments.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable TextColor color, List<? extends ComponentLike> args)	Creates a translatable component with a translation key, arguments, and optional color.
static TranslatableComponent	Component.translatable(Translatable translatable, @Nullable TextColor color, Set<TextDecoration> decorations, List<? extends ComponentLike> args)	Creates a translatable component with a translation key, arguments, and optional color and decorations.
static TranslatableComponent	Component.translatable(Translatable translatable, Style style, List<? extends ComponentLike> args)	Creates a translatable component with a translation key and styling.

Uses of ComponentLike in net.kyori.adventure.text.event

Methods in net.kyori.adventure.text.event with parameters of type ComponentLike

Modifier and Type	Method	Description
static HoverEvent<Component>	HoverEvent.showText(ComponentLike text)	Creates a hover event that shows text on hover.