Interface TranslatableComponent.Builder

All Superinterfaces:

AbstractBuilder<TranslatableComponent>, ComponentBuilder<TranslatableComponent, TranslatableComponent.Builder>, ComponentBuilderApplicable, ComponentLike, MutableStyleSetter<TranslatableComponent.Builder>, StyleSetter<TranslatableComponent.Builder>

Enclosing interface:

TranslatableComponent

public static sealed interface TranslatableComponent.Builder
extends ComponentBuilder<TranslatableComponent, TranslatableComponent.Builder>

A text component builder.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
TranslatableComponent.Builder	arguments(List<? extends ComponentLike> args)	Sets the translation args.
TranslatableComponent.Builder	arguments(ComponentLike... args)	Sets the translation args.
TranslatableComponent.Builder	fallback(@Nullable String fallback)	Sets the translation fallback text.
TranslatableComponent.Builder	key(String key)	Sets the translation key.
default TranslatableComponent.Builder	key(Translatable translatable)	Sets the translation key.

Methods inherited from interface ComponentBuilder

append, append, append, append, append, append, appendNewline, appendSpace, applicableApply, apply, applyDeep, asComponent, build, children, clickEvent, color, colorIfAbsent, componentBuilderApply, decorate, decorate, decoration, decoration, decorationIfAbsent, decorations, decorations, font, hoverEvent, insertion, mapChildren, mapChildrenDeep, mergeStyle, mergeStyle, mergeStyle, resetStyle, style, style

Methods inherited from interface StyleSetter

shadowColor, shadowColorIfAbsent

Method Details

key

@Contract(pure=true)
default TranslatableComponent.Builder key(Translatable translatable)

Sets the translation key.

Parameters:

translatable - the translatable object to get the key from

Returns:

this builder

Since:

4.8.0

key

@Contract("_ -> this")
TranslatableComponent.Builder key(String key)

Sets the translation key.

Parameters:

key - the translation key

Returns:

this builder

Since:

4.0.0

arguments

@Contract("_ -> this")
TranslatableComponent.Builder arguments(ComponentLike... args)

Sets the translation args.

Non-Component arguments can be wrapped in TranslationArgument, or represented with a TranslationArgumentLike.

Parameters:

args - the translation args

Returns:

this builder

Since:

4.15.0

arguments

@Contract("_ -> this")
TranslatableComponent.Builder arguments(List<? extends ComponentLike> args)

Sets the translation args.

Non-Component arguments can be wrapped in TranslationArgument, or represented with a TranslationArgumentLike.

Parameters:

args - the translation args

Returns:

this builder

Since:

4.15.0

fallback

@Contract("_ -> this")
TranslatableComponent.Builder fallback(@Nullable String fallback)

Sets the translation fallback text. The fallback text will be shown when the client doesn't know the translation key used in the translatable component.

Parameters:

fallback - the fallback string

Returns:

this builder

Since:

4.13.0

Since Minecraft:

1.19.4