Package net.kyori.adventure.text

Interface TranslatableComponent

All Superinterfaces:

Buildable<TranslatableComponent,TranslatableComponent.Builder>, BuildableComponent<TranslatableComponent,TranslatableComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, ScopedComponent<TranslatableComponent>

public interface TranslatableComponent
extends BuildableComponent<TranslatableComponent,TranslatableComponent.Builder>, ScopedComponent<TranslatableComponent>

A translatable component.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TranslatableComponent.Builder	A text component builder.

Method Summary

Modifier and Type	Method	Description
@NonNull List<Component>	args()	Gets the unmodifiable list of translation arguments.
@NonNull TranslatableComponent	args(@NonNull List<? extends ComponentLike> args)	Sets the translation arguments for this component.
@NonNull TranslatableComponent	args(@NonNull ComponentLike @NonNull ... args)	Sets the translation arguments for this component.
@NonNull String	key()	Gets the translation key.
@NonNull TranslatableComponent	key(@NonNull String key)	Sets the translation key.

Methods inherited from interface net.kyori.adventure.text.BuildableComponent

toBuilder

Methods inherited from interface net.kyori.adventure.text.Component

asComponent, asHoverEvent, children, clickEvent, color, componentBuilderApply, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, style, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface net.kyori.adventure.text.ScopedComponent

append, append, append, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, style, style, style

Method Details

key

@NonNull String key()

Gets the translation key.

Returns:

the translation key

Since:

4.0.0

key

@NonNull TranslatableComponent key(@NonNull String key)

Sets the translation key.

Parameters:

key - the translation key

Returns:

a translatable component

Since:

4.0.0

args

@NonNull List<Component> args()

Gets the unmodifiable list of translation arguments.

Returns:

the unmodifiable list of translation arguments

Since:

4.0.0

args

@NonNull TranslatableComponent args(@NonNull ComponentLike @NonNull ... args)

Sets the translation arguments for this component.

Parameters:

args - the translation arguments

Returns:

a translatable component

Since:

4.0.0

args

@NonNull TranslatableComponent args(@NonNull List<? extends ComponentLike> args)

Sets the translation arguments for this component.

Parameters:

args - the translation arguments

Returns:

a translatable component

Since:

4.0.0