net.minecraft.text

Interface Text

All Superinterfaces:

com.mojang.brigadier.Message, StringVisitable

All Known Subinterfaces:

MutableText

All Known Implementing Classes:

BaseText, KeybindText, LiteralText, NbtText, NbtText.BlockNbtText, NbtText.EntityNbtText, NbtText.StorageNbtText, ScoreText, SelectorText, TranslatableText

public interface Text
extends com.mojang.brigadier.Message, StringVisitable

A text. Can be converted to and from JSON format.

Each text has a tree structure, embodying all its siblings. To iterate contents in the text and all its siblings, call visit methods.

This interface does not expose mutation operations. For mutation, refer to MutableText.

See Also:

MutableText

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Text.Serializer A JSON serializer for Text.

Nested classes/interfaces inherited from interface net.minecraft.text.StringVisitable

StringVisitable.StyledVisitor<T>, StringVisitable.Visitor<T>

Field Summary

Fields inherited from interface net.minecraft.text.StringVisitable

EMPTY, TERMINATE_VISIT

Method Summary

Modifier and Type	Method and Description
OrderedText	asOrderedText()
String	asString() Returns the string representation of this text itself, excluding siblings.
default String	asTruncatedString(int length) Returns the full string representation of this text, truncated beyond the supplied length.
MutableText	copy() Copies the text itself, excluding the styles or siblings.
List<Text>	getSiblings() Returns the siblings of this text.
default String	getString()
Style	getStyle() Returns the style of this text.
static Text	of(String string) Creates a literal text with the given string as content.
MutableText	shallowCopy() Copies the text itself, the style, and the siblings.
default <T> Optional<T>	visit(StringVisitable.StyledVisitor<T> styledVisitor, Style style) Supplies this visitable's literal content and contextual style to the visitor.
default <T> Optional<T>	visit(StringVisitable.Visitor<T> visitor) Supplies this visitable's literal content to the visitor.
default <T> Optional<T>	visitSelf(StringVisitable.StyledVisitor<T> visitor, Style style) Visits the text itself.
default <T> Optional<T>	visitSelf(StringVisitable.Visitor<T> visitor) Visits the text itself.

Methods inherited from interface net.minecraft.text.StringVisitable

concat, concat, plain, styled

Method Detail

getStyle

Style getStyle()

Returns the style of this text.

asString

String asString()

Returns the string representation of this text itself, excluding siblings.

getString

default String getString()

Specified by:

getString in interface com.mojang.brigadier.Message

Specified by:

getString in interface StringVisitable

asTruncatedString

default String asTruncatedString(int length)

Returns the full string representation of this text, truncated beyond the supplied length.

Parameters:

length - the max length allowed for the string representation of the text

getSiblings

List<Text> getSiblings()

Returns the siblings of this text.

copy

MutableText copy()

Copies the text itself, excluding the styles or siblings.

shallowCopy

MutableText shallowCopy()

Copies the text itself, the style, and the siblings.

A shallow copy is made for the siblings.

asOrderedText

@Environment(value=CLIENT)
OrderedText asOrderedText()

visit

@Environment(value=CLIENT)
default <T> Optional<T> visit(StringVisitable.StyledVisitor<T> styledVisitor,
                                                         Style style)

Supplies this visitable's literal content and contextual style to the visitor.

Specified by:

visit in interface StringVisitable

Parameters:

styledVisitor - the visitor

style - the contextual style

Returns:

Optional.empty() if the visit finished, or a terminating result from the visitor

visit

default <T> Optional<T> visit(StringVisitable.Visitor<T> visitor)

Supplies this visitable's literal content to the visitor.

Specified by:

visit in interface StringVisitable

Parameters:

visitor - the visitor

Returns:

Optional.empty() if the visit finished, or a terminating result from the visitor

visitSelf

@Environment(value=CLIENT)
default <T> Optional<T> visitSelf(StringVisitable.StyledVisitor<T> visitor,
                                                             Style style)

Visits the text itself.

Parameters:

visitor - the visitor

style - the current style

Returns:

the visitor's return value

See Also:

StringVisitable.visit(StyledVisitor, Style)

visitSelf

default <T> Optional<T> visitSelf(StringVisitable.Visitor<T> visitor)

Visits the text itself.

Parameters:

visitor - the visitor

Returns:

the visitor's return value

See Also:

StringVisitable.visit(Visitor)

of

@Environment(value=CLIENT)
static Text of(@Nullable
                                          String string)

Creates a literal text with the given string as content.