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()

Method Summary

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

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

render

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()

Method Details

usingTranslationSource

public static @NonNull TranslatableComponentRenderer<Locale> usingTranslationSource(@NonNull Translator source)

Creates a TranslatableComponentRenderer using the Translator to translate.

Parameters:

source - the translation source

Returns:

the renderer

Since:

4.0.0

translate

protected abstract @Nullable MessageFormat translate(@NonNull String key, @NonNull 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

renderBlockNbt

protected @NonNull Component renderBlockNbt(@NonNull BlockNBTComponent component, @NonNull 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 @NonNull Component renderEntityNbt(@NonNull EntityNBTComponent component, @NonNull 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 @NonNull Component renderStorageNbt(@NonNull StorageNBTComponent component, @NonNull 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 static <C extends NBTComponent<C, B>, B extends NBTComponentBuilder<C, B>> B nbt(B builder, C oldComponent)

renderKeybind

protected @NonNull Component renderKeybind(@NonNull KeybindComponent component, @NonNull 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 @NonNull Component renderScore(@NonNull ScoreComponent component, @NonNull 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 @NonNull Component renderSelector(@NonNull SelectorComponent component, @NonNull 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 @NonNull Component renderText(@NonNull TextComponent component, @NonNull 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

renderTranslatable

protected @NonNull Component renderTranslatable(@NonNull TranslatableComponent component, @NonNull 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

mergeStyleAndOptionallyDeepRender

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

optionallyRenderChildrenAppendAndBuild

protected <O extends BuildableComponent<O, B>, 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)