net.md_5.bungee.api.chat

Class TranslatableComponent

java.lang.Object

net.md_5.bungee.api.chat.BaseComponent

net.md_5.bungee.api.chat.TranslatableComponent

public final class TranslatableComponent
extends BaseComponent

Constructor Summary

Constructors

Constructor and Description
TranslatableComponent()
TranslatableComponent(String translate, Object... with) Creates a translatable component with the passed substitutions
TranslatableComponent(TranslatableComponent original) Creates a translatable component from the original to clone it.

Method Summary

Modifier and Type	Method and Description
void	addWith(BaseComponent component) Adds a component substitution to the component.
void	addWith(String text) Adds a text substitution to the component.
BaseComponent	duplicate() Creates a duplicate of this TranslatableComponent.
Pattern	getFormat()
String	getTranslate() The key into the Minecraft locale files to use for the translation.
List<BaseComponent>	getWith() The components to substitute into the translation
void	setTranslate(String translate) The key into the Minecraft locale files to use for the translation.
void	setWith(List<BaseComponent> components) Sets the translation substitutions to be used in this component.
protected void	toLegacyText(StringBuilder builder)
protected void	toPlainText(StringBuilder builder)
String	toString()

Methods inherited from class net.md_5.bungee.api.chat.BaseComponent

addExtra, addExtra, copyFormatting, copyFormatting, copyFormatting, duplicateWithoutFormatting, getClickEvent, getColor, getColorRaw, getExtra, getHoverEvent, getInsertion, hasFormatting, isBold, isBoldRaw, isItalic, isItalicRaw, isObfuscated, isObfuscatedRaw, isStrikethrough, isStrikethroughRaw, isUnderlined, isUnderlinedRaw, retain, setBold, setClickEvent, setColor, setExtra, setHoverEvent, setInsertion, setItalic, setObfuscated, setStrikethrough, setUnderlined, toLegacyText, toLegacyText, toPlainText, toPlainText

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslatableComponent

public TranslatableComponent(TranslatableComponent original)

Creates a translatable component from the original to clone it.

Parameters:

original - the original for the new translatable component.

TranslatableComponent

public TranslatableComponent(String translate,
                             Object... with)

Creates a translatable component with the passed substitutions

Parameters:

translate - the translation key

with - the Strings and BaseComponents to use into the translation

See Also:

translate, setWith(java.util.List)

TranslatableComponent

public TranslatableComponent()

Method Detail

duplicate

public BaseComponent duplicate()

Creates a duplicate of this TranslatableComponent.

Specified by:

duplicate in class BaseComponent

Returns:

the duplicate of this TranslatableComponent.

setWith

public void setWith(List<BaseComponent> components)

Sets the translation substitutions to be used in this component. Removes any previously set substitutions

Parameters:

components - the components to substitute

addWith

public void addWith(String text)

Adds a text substitution to the component. The text will inherit this component's formatting

Parameters:

text - the text to substitute

addWith

public void addWith(BaseComponent component)

Adds a component substitution to the component. The text will inherit this component's formatting

Parameters:

component - the component to substitute

toPlainText

protected void toPlainText(StringBuilder builder)

toLegacyText

protected void toLegacyText(StringBuilder builder)

getFormat

public Pattern getFormat()

getTranslate

public String getTranslate()

The key into the Minecraft locale files to use for the translation. The text depends on the client's locale setting. The console is always en_US

getWith

public List<BaseComponent> getWith()

The components to substitute into the translation

setTranslate

public void setTranslate(String translate)

The key into the Minecraft locale files to use for the translation. The text depends on the client's locale setting. The console is always en_US

toString

public String toString()

Overrides:

toString in class BaseComponent