Module net.kyori.adventure.api

Package net.kyori.adventure.text.renderer

Class TranslatableComponentRenderer<C>

java.lang.Object

net.kyori.adventure.text.renderer.AbstractComponentRenderer<C>

net.kyori.adventure.text.renderer.TranslatableComponentRenderer<C>

Type Parameters:

C - the context type, usually Locale.

All Implemented Interfaces:

ComponentRenderer<C>

public abstract class TranslatableComponentRenderer<C>
extends AbstractComponentRenderer<C>

A component renderer that does server-side translation rendering.

Since:

4.0.0

Constructor Summary

Constructors

Constructor	Description
TranslatableComponentRenderer()	Constructs a new translatable component renderer.

Method Summary

Modifier and Type	Method	Description
protected <B extends ComponentBuilder<?, ?>> void	mergeStyle(Component component, B builder, C context)
protected <O extends Component, B extends ComponentBuilder<O, B>> O	mergeStyleAndOptionallyDeepRender(Component component, B builder, C context)
protected <O extends NBTComponent<O>, B extends NBTComponentBuilder<O, B>> B	nbt(C context, B builder, O oldComponent)
protected Component	optionallyRenderChildrenAndStyle(Component component, C context)
protected <O extends Component, B extends ComponentBuilder<O, B>> O	optionallyRenderChildrenAppendAndBuild(List<Component> children, B builder, C context)
protected Component	renderBlockNbt(BlockNBTComponent component, C context)	Renders a block NBT component.
protected Component	renderEntityNbt(EntityNBTComponent component, C context)	Renders an entity NBT component.
protected Component	renderKeybind(KeybindComponent component, C context)	Renders a keybind component.
protected Component	renderObject(ObjectComponent component, C context)	Renders an object component.
protected Component	renderScore(ScoreComponent component, C context)	Renders a score component.
protected Component	renderSelector(SelectorComponent component, C context)	Renders a selector component.
protected Component	renderStorageNbt(StorageNBTComponent component, C context)	Renders a storage NBT component.
protected Component	renderText(TextComponent component, C context)	Renders a text component.
protected Component	renderTranslatable(TranslatableComponent component, C context)	Renders a translatable component.
protected Component	renderTranslatableInner(TranslatableComponent component, C context)
protected @Nullable MessageFormat	translate(String key, C context)	Gets a message format from a key and context.
protected @Nullable MessageFormat	translate(String key, @Nullable String fallback, C context)	Gets a message format from a key, fallback string, and context.
static TranslatableComponentRenderer<Locale>	usingTranslationSource(Translator source)	Creates a TranslatableComponentRenderer using the Translator to translate.

Methods inherited from class net.kyori.adventure.text.renderer.AbstractComponentRenderer

render, render, renderVirtual

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.kyori.adventure.text.renderer.ComponentRenderer

mapContext

Constructor Details

TranslatableComponentRenderer

public TranslatableComponentRenderer()

Constructs a new translatable component renderer.

Since:

4.0.0

Method Details

usingTranslationSource

public static TranslatableComponentRenderer<Locale> usingTranslationSource(Translator source)

Creates a TranslatableComponentRenderer using the Translator to translate.

Alongside the standard MessageFormat-based translation, this will also allow the Translator to create a Component directly.

Parameters:

source - the translation source

Returns:

the renderer

Since:

4.0.0

translate

protected @Nullable MessageFormat translate(String key,
 C context)

Gets a message format from a key and context.

Parameters:

key - a translation key

context - a context

Returns:

a message format or null to skip translation

translate

protected @Nullable MessageFormat translate(String key,
 @Nullable String fallback,
 C context)

Gets a message format from a key, fallback string, and context.

Parameters:

key - a translation key

fallback - the fallback string

context - a context

Returns:

a message format or null to skip translation

renderBlockNbt

protected Component renderBlockNbt(BlockNBTComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a block NBT component.

Specified by:

renderBlockNbt in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderEntityNbt

protected Component renderEntityNbt(EntityNBTComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders an entity NBT component.

Specified by:

renderEntityNbt in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderStorageNbt

protected Component renderStorageNbt(StorageNBTComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a storage NBT component.

Specified by:

renderStorageNbt in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

nbt

protected <O extends NBTComponent<O>,
B extends NBTComponentBuilder<O,
B>>
B nbt(C context,
 B builder,
 O oldComponent)

renderKeybind

protected Component renderKeybind(KeybindComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a keybind component.

Specified by:

renderKeybind in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderScore

protected Component renderScore(ScoreComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a score component.

Specified by:

renderScore in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderSelector

protected Component renderSelector(SelectorComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a selector component.

Specified by:

renderSelector in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderText

protected Component renderText(TextComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a text component.

Specified by:

renderText in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderObject

protected Component renderObject(ObjectComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders an object component.

Specified by:

renderObject in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderTranslatable

protected Component renderTranslatable(TranslatableComponent component,
 C context)

Description copied from class: AbstractComponentRenderer

Renders a translatable component.

Specified by:

renderTranslatable in class AbstractComponentRenderer<C>

Parameters:

component - the component

context - the context

Returns:

the rendered component

renderTranslatableInner

protected Component renderTranslatableInner(TranslatableComponent component,
 C context)

optionallyRenderChildrenAndStyle

protected Component optionallyRenderChildrenAndStyle(Component component,
 C context)

mergeStyleAndOptionallyDeepRender

protected <O extends Component,
B extends ComponentBuilder<O,
B>>
O mergeStyleAndOptionallyDeepRender(Component component,
 B builder,
 C context)

optionallyRenderChildrenAppendAndBuild

protected <O extends Component,
B extends ComponentBuilder<O,
B>>
O optionallyRenderChildrenAppendAndBuild(List<Component> children,
 B builder,
 C context)

mergeStyle

protected <B extends ComponentBuilder<?,
?>> void mergeStyle(Component component,
 B builder,
 C context)