Interface SignText

All Superinterfaces:

BuildableDataComponent<SignText, SignText.Builder>

@NullMarked
@NonExtendable
public interface SignText
extends BuildableDataComponent<SignText, SignText.Builder>

Represents the text on a sign side.

See Also:

• DataComponentTypes.SIGN_TEXT_FRONT
• DataComponentTypes.SIGN_TEXT_BACK

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SignText.Builder	Builder for SignText.

Method Summary

Modifier and Type	Method	Description
DyeColor	color()	Gets the color of the text on this sign side.
List<Component>	filteredMessages()	Gets the list of messages on this sign side, filtered for the player.
boolean	hasGlowingText()	Checks if the text on this sign side has a glowing effect.
List<Component>	messages()	Gets the list of messages on this sign side.
static SignText.Builder	signText()
static SignText.Builder	signText(List<? extends ComponentLike> messages)

Methods inherited from interface BuildableDataComponent

toBuilder

Method Details

signText

@Contract(value="_ -> new",
          pure=true)
static SignText.Builder signText(List<? extends ComponentLike> messages)

signText

@Contract(value="-> new",
          pure=true)
static SignText.Builder signText()

messages

@Contract(pure=true)
List<Component> messages()

Gets the list of messages on this sign side.

Returns:

the list of messages

filteredMessages

@Contract(pure=true)
List<Component> filteredMessages()

Gets the list of messages on this sign side, filtered for the player.

Returns:

the list of messages

color

@Contract(pure=true)
DyeColor color()

Gets the color of the text on this sign side.

Returns:

the color of the text

hasGlowingText

@Contract(pure=true)
boolean hasGlowingText()

Checks if the text on this sign side has a glowing effect.

Returns:

true if the text has a glowing effect, false otherwise