com.viaversion.viaversion.libs.mcstructs.text

Class TextComponent

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

KeybindComponent, NbtComponent, ObjectComponent, ScoreComponent, SelectorComponent, StringComponent, TranslationComponent

public abstract class TextComponent
extends java.lang.Object
implements com.viaversion.viaversion.libs.mcstructs.core.Copyable<TextComponent>

The base text component class.
Implementations of this class are:
- StringComponent
- TranslationComponent
- ScoreComponent
- SelectorComponent
- KeybindComponent
- BlockNbtSource
- EntityNbtSource
- StorageNbtSource
- ObjectComponent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextComponent.ComponentConsumer

Constructor Summary

Constructors

Constructor and Description
TextComponent()

Method Summary

Modifier and Type	Method and Description
TextComponent	append(java.lang.Iterable<TextComponent> components)
TextComponent	append(java.lang.String... strings) Append multiple strings to this component.
TextComponent	append(TextComponent... components) Append multiple components to this component.
TextComponent	append(TextComponent component) Append a component to this component.
java.lang.String	asLegacyFormatString()
abstract java.lang.String	asSingleString()
void	asSingleString(com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking converter, TextComponent.ComponentConsumer consumer)
java.lang.String	asUnformattedString()
java.lang.String	asUnformattedString(com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking converter)
static ObjectComponent	atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite)
static ObjectComponent	atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier atlas, com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite)
static ObjectComponent	atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier atlas, com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite, TextComponent fallback)
static ObjectComponent	atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite, TextComponent fallback)
static NbtComponent	blockNbt(java.lang.String rawComponent, boolean resolve, java.lang.String pos)
static NbtComponent	blockNbt(java.lang.String rawComponent, boolean resolve, TextComponent separator, java.lang.String pos)
TextComponent	copy()
<C extends TextComponent> C	copyMetaTo(C component) Copy the style and siblings of this component to the given component.
static StringComponent	empty()
static NbtComponent	entityNbt(java.lang.String component, boolean resolve, java.lang.String selector)
static NbtComponent	entityNbt(java.lang.String component, boolean resolve, TextComponent separator, java.lang.String selector)
TextComponent	forEach(java.util.function.Consumer<TextComponent> consumer) Iterate over all components and their siblings.
TextComponent	formatted(TextFormatting formatting) Set a formatting of the style of this component.
java.util.List<TextComponent>	getSiblings()
Style	getStyle()
static KeybindComponent	keybind(java.lang.String keybind)
TextComponent	mergeSiblingParentStyle() Set the parent style of all siblings to this style and merge them together. This removes all parent references from the siblings while maintaining the style.
static TextComponent	of(java.lang.Iterable<TextComponent> components)
static TextComponent	of(java.lang.String... text)
static StringComponent	of(java.lang.String text)
static TextComponent	of(TextComponent... components)
static ScoreComponent	score(java.lang.String name, java.lang.String objective)
static ScoreComponent	score(java.lang.String name, java.lang.String objective, java.lang.String value)
static SelectorComponent	selector(java.lang.String selector)
static SelectorComponent	selector(java.lang.String selector, TextComponent separator)
TextComponent	setParentStyle(Style style) Set the parent style of this component.
TextComponent	setSiblingParentStyle() Set the parent style of all siblings to this style.
TextComponent	setStyle(Style style) Set the style of this component.
abstract TextComponent	shallowCopy() Create a shallow copy of this component. This will only copy the component itself (including style) and not its siblings.
static NbtComponent	storageNbt(java.lang.String component, boolean resolve, com.viaversion.viaversion.libs.mcstructs.core.Identifier id)
static NbtComponent	storageNbt(java.lang.String component, boolean resolve, TextComponent separator, com.viaversion.viaversion.libs.mcstructs.core.Identifier id)
TextComponent	styled(java.util.function.Consumer<Style> styleConsumer) Modify the style of this component.
abstract java.lang.String	toString()
static TranslationComponent	translation(java.lang.String key, java.util.List<java.lang.Object> args)
static TranslationComponent	translation(java.lang.String key, java.lang.Object... args)
void	visit(com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking converter, TextComponent.ComponentConsumer consumer)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextComponent

public TextComponent()

Method Detail

append

public TextComponent append(java.lang.String... strings)

Append multiple strings to this component.

Parameters:

strings - The strings to append

Returns:

This component

append

public TextComponent append(TextComponent component)

Append a component to this component.

Parameters:

component - The component to append

Returns:

This component

append

public TextComponent append(TextComponent... components)

Append multiple components to this component.

Parameters:

components - The components to append

Returns:

This component

append

public TextComponent append(java.lang.Iterable<TextComponent> components)

getSiblings

public java.util.List<TextComponent> getSiblings()

Returns:

The siblings of this component

forEach

public TextComponent forEach(java.util.function.Consumer<TextComponent> consumer)

Iterate over all components and their siblings.

Parameters:

consumer - The consumer that will be called for every component

Returns:

This component

See Also:

TextUtils.iterateAll(TextComponent, Consumer)

getStyle

@Nonnull
public Style getStyle()

Returns:

The style of this component

setStyle

public TextComponent setStyle(@Nonnull
                              Style style)

Set the style of this component.

Parameters:

style - The new style

Returns:

This component

styled

public TextComponent styled(java.util.function.Consumer<Style> styleConsumer)

Modify the style of this component.

Parameters:

styleConsumer - The consumer that will be called with the current style

Returns:

This component

formatted

public TextComponent formatted(TextFormatting formatting)

Set a formatting of the style of this component.

Parameters:

formatting - The formatting to set

Returns:

This component

setParentStyle

public TextComponent setParentStyle(@Nonnull
                                    Style style)

Set the parent style of this component.

Parameters:

style - The new parent style

Returns:

This component

setSiblingParentStyle

public TextComponent setSiblingParentStyle()

Set the parent style of all siblings to this style.

Returns:

This component

mergeSiblingParentStyle

public TextComponent mergeSiblingParentStyle()

Set the parent style of all siblings to this style and merge them together.
This removes all parent references from the siblings while maintaining the style.

Returns:

This component

See Also:

Style.mergeParent()

copyMetaTo

public <C extends TextComponent> C copyMetaTo(C component)

Copy the style and siblings of this component to the given component.

Type Parameters:

C - The type of the component

Parameters:

component - The component to copy to

Returns:

The given component

asUnformattedString

public java.lang.String asUnformattedString()

Returns:

An unformatted string representation of this component

asUnformattedString

public java.lang.String asUnformattedString(com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking converter)

visit

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

asLegacyFormatString

public java.lang.String asLegacyFormatString()

Returns:

A legacy formatted string representation of this component

See Also:

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

asSingleString

public abstract java.lang.String asSingleString()

Returns:

An unformatted string representation of this component

asSingleString

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

copy

public TextComponent copy()

Specified by:

copy in interface com.viaversion.viaversion.libs.mcstructs.core.Copyable<TextComponent>

shallowCopy

public abstract TextComponent shallowCopy()

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

Returns:

The shallow copy

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Object

empty

public static StringComponent empty()

of

public static StringComponent of(java.lang.String text)

of

public static TextComponent of(java.lang.String... text)

of

public static TextComponent of(TextComponent... components)

of

public static TextComponent of(java.lang.Iterable<TextComponent> components)

translation

public static TranslationComponent translation(java.lang.String key,
                                               java.util.List<java.lang.Object> args)

translation

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

score

public static ScoreComponent score(java.lang.String name,
                                   java.lang.String objective)

score

public static ScoreComponent score(java.lang.String name,
                                   java.lang.String objective,
                                   @Nullable
                                   java.lang.String value)

selector

public static SelectorComponent selector(java.lang.String selector)

selector

public static SelectorComponent selector(java.lang.String selector,
                                         @Nullable
                                         TextComponent separator)

keybind

public static KeybindComponent keybind(java.lang.String keybind)

blockNbt

public static NbtComponent blockNbt(java.lang.String rawComponent,
                                    boolean resolve,
                                    java.lang.String pos)

blockNbt

public static NbtComponent blockNbt(java.lang.String rawComponent,
                                    boolean resolve,
                                    @Nullable
                                    TextComponent separator,
                                    java.lang.String pos)

entityNbt

public static NbtComponent entityNbt(java.lang.String component,
                                     boolean resolve,
                                     java.lang.String selector)

entityNbt

public static NbtComponent entityNbt(java.lang.String component,
                                     boolean resolve,
                                     @Nullable
                                     TextComponent separator,
                                     java.lang.String selector)

storageNbt

public static NbtComponent storageNbt(java.lang.String component,
                                      boolean resolve,
                                      com.viaversion.viaversion.libs.mcstructs.core.Identifier id)

storageNbt

public static NbtComponent storageNbt(java.lang.String component,
                                      boolean resolve,
                                      @Nullable
                                      TextComponent separator,
                                      com.viaversion.viaversion.libs.mcstructs.core.Identifier id)

atlasSprite

public static ObjectComponent atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite)

atlasSprite

public static ObjectComponent atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite,
                                          @Nullable
                                          TextComponent fallback)

atlasSprite

public static ObjectComponent atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier atlas,
                                          com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite)

atlasSprite

public static ObjectComponent atlasSprite(com.viaversion.viaversion.libs.mcstructs.core.Identifier atlas,
                                          com.viaversion.viaversion.libs.mcstructs.core.Identifier sprite,
                                          @Nullable
                                          TextComponent fallback)