com.viaversion.viaversion.libs.mcstructs.text.components

Class TranslationComponent

java.lang.Object

com.viaversion.viaversion.libs.mcstructs.text.TextComponent

com.viaversion.viaversion.libs.mcstructs.text.components.TranslationComponent

All Implemented Interfaces:

com.viaversion.viaversion.libs.mcstructs.core.Copyable<TextComponent>

public class TranslationComponent
extends TextComponent

Nested Class Summary

Nested classes/interfaces inherited from class com.viaversion.viaversion.libs.mcstructs.text.TextComponent

TextComponent.ComponentConsumer

Constructor Summary

Constructors

Constructor and Description
TranslationComponent(java.lang.String key, java.util.List<?> args)
TranslationComponent(java.lang.String key, java.lang.Object... args)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asLegacyFormatString()
java.lang.String	asSingleString()
void	asSingleString(com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking converter, TextComponent.ComponentConsumer consumer)
java.lang.Object[]	getArgs()
java.lang.String	getFallback()
java.lang.String	getKey()
TextComponent	resolveIntoComponents()
TranslationComponent	setArgs(java.lang.Object[] args) Set the arguments of this component.
TranslationComponent	setFallback(java.lang.String fallback) Set the fallback of this component. The fallback is used when the translation of the key was not found.
TranslationComponent	setKey(java.lang.String key) Set the key of this component.
TranslationComponent	setTranslator(Translator translator) Set the translator function used to translate the key. If a key is not found return null.
TextComponent	shallowCopy() Create a shallow copy of this component. This will only copy the component itself (including style) and not its siblings.
java.lang.String	toString()

Methods inherited from class com.viaversion.viaversion.libs.mcstructs.text.TextComponent

append, append, append, append, asUnformattedString, asUnformattedString, atlasSprite, atlasSprite, atlasSprite, atlasSprite, blockNbt, blockNbt, copy, copyMetaTo, empty, entityNbt, entityNbt, forEach, formatted, getSiblings, getStyle, keybind, mergeSiblingParentStyle, of, of, of, of, score, score, selector, selector, setParentStyle, setSiblingParentStyle, setStyle, storageNbt, storageNbt, styled, translation, translation, visit

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationComponent

public TranslationComponent(java.lang.String key,
                            java.util.List<?> args)

TranslationComponent

public TranslationComponent(java.lang.String key,
                            java.lang.Object... args)

Method Detail

getKey

public java.lang.String getKey()

Returns:

The key of this component

setKey

public TranslationComponent setKey(java.lang.String key)

Set the key of this component.

Parameters:

key - The key

Returns:

This component

getArgs

public java.lang.Object[] getArgs()

Returns:

The arguments of this component

setArgs

public TranslationComponent setArgs(java.lang.Object[] args)

Set the arguments of this component.

Parameters:

args - The arguments

Returns:

This component

getFallback

@Nullable
public java.lang.String getFallback()

Returns:

The fallback of this component

setFallback

public TranslationComponent setFallback(@Nullable
                                        java.lang.String fallback)

Set the fallback of this component.
The fallback is used when the translation of the key was not found.

Parameters:

fallback - The fallback

Returns:

This component

setTranslator

public TranslationComponent setTranslator(@Nullable
                                          Translator translator)

Set the translator function used to translate the key.
If a key is not found return null. This is required for the fallback to work.

Parameters:

translator - The translator function

Returns:

This component

resolveIntoComponents

public TextComponent resolveIntoComponents()

asLegacyFormatString

public java.lang.String asLegacyFormatString()

Overrides:

asLegacyFormatString in class TextComponent

Returns:

A legacy formatted string representation of this component

See Also:

StringFormat.vanilla(char, boolean), StringFormat.toString(TextComponent, ColorHandling, SerializerUnknownHandling)

asSingleString

public java.lang.String asSingleString()

Specified by:

asSingleString in class TextComponent

Returns:

An unformatted string representation of this component

asSingleString

public void asSingleString(com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking converter,
                           TextComponent.ComponentConsumer consumer)

Overrides:

asSingleString in class TextComponent

shallowCopy

public TextComponent shallowCopy()

Description copied from class: TextComponent

Create a shallow copy of this component.
This will only copy the component itself (including style) and not its siblings.

Specified by:

shallowCopy in class TextComponent

Returns:

The shallow copy

toString

public java.lang.String toString()

Specified by:

toString in class TextComponent