org.spongepowered.api.text

Interface TextRepresentable

All Superinterfaces:

TextElement

All Known Subinterfaces:

Advancement, PartitionedTextFormatter<E>, PlaceholderText, TextFormatter<E>, TextTemplateApplier

All Known Implementing Classes:

DynamicPartitionedTextFormatter, FixedPartitionedTextFormatter, LiteralText, LiteralText.Builder, MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier, MessageEvent.MessageFormatter, ScoreText, ScoreText.Builder, SelectorText, SelectorText.Builder, SimpleTextFormatter, SimpleTextTemplateApplier, Text, Text.Builder, TextTemplate, TextTemplate.Arg, TranslatableText, TranslatableText.Builder

public interface TextRepresentable
extends TextElement

Represents an instance that have a Text representation that should be used when this instance should be used inside a Text.

Method Summary

Modifier and Type	Method and Description
default void	applyTo(Text.Builder builder) Applies this element to the end of the specified builder.
Text	toText() Gets the textual representation of this instance for its usage in other Text objects.

Method Detail

toText

Text toText()

Gets the textual representation of this instance for its usage in other Text objects. This may but does not need to include hover texts or other actions. This method is basically the toString() equivalent for Texts.

Returns:

The text instance representing this instance

applyTo

default void applyTo(Text.Builder builder)

Description copied from interface: TextElement

Applies this element to the end of the specified builder.

Specified by:

applyTo in interface TextElement

Parameters:

builder - Text builder to apply to