org.spongepowered.api.text

Class ScoreText

java.lang.Object

org.spongepowered.api.text.Text

org.spongepowered.api.text.ScoreText

All Implemented Interfaces:

Comparable<Text>, DataSerializable, TextElement, TextRepresentable

public final class ScoreText
extends Text

Represents a Text displaying the current score of a player.

See Also:

Score, ScoreText.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScoreText.Builder Represents a Text.Builder creating immutable ScoreText instances.

Field Summary

Fields inherited from class org.spongepowered.api.text.Text

EMPTY, NEW_LINE, PLAIN_COMPARATOR

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Optional<String>	getOverride() Returns a value that is displayed instead of the real score.
Score	getScore() Returns the score displayed by this Text.
int	hashCode()
ScoreText.Builder	toBuilder() Returns a new Text.Builder with the content, formatting and actions of this text.

Methods inherited from class org.spongepowered.api.text.Text

builder, builder, builder, builder, builder, builder, builder, builder, builder, builder, builder, builder, compareTo, concat, getChildren, getClickAction, getColor, getContentVersion, getFormat, getHoverAction, getShiftClickAction, getStyle, isEmpty, join, join, join, joinWith, joinWith, joinWith, of, of, of, of, of, of, of, of, replace, replace, replace, replace, toContainer, toPlain, toPlainSingle, toString, toText, trim, withChildren

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.spongepowered.api.text.TextRepresentable

applyTo

Method Detail

getScore

public Score getScore()

Returns the score displayed by this Text.

Returns:

The score in this text

getOverride

public Optional<String> getOverride()

Returns a value that is displayed instead of the real score.

Returns:

The value displayed instead of the real score, or Optional.empty() if the real score will be displayed instead

toBuilder

public ScoreText.Builder toBuilder()

Description copied from class: Text

Returns a new Text.Builder with the content, formatting and actions of this text. This can be used to edit an otherwise immutable Text instance.

Specified by:

toBuilder in class Text

Returns:

A new message builder with the content of this text

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Text

hashCode

public int hashCode()

Overrides:

hashCode in class Text