mkremins.fanciful

Class TextualComponent

java.lang.Object

mkremins.fanciful.TextualComponent

All Implemented Interfaces:

java.lang.Cloneable

public abstract class TextualComponent
extends java.lang.Object
implements java.lang.Cloneable

Represents a textual component of a message part. This can be used to not only represent string literals in a JSON message, but also to represent localized strings and other text values.

Different instances of this class can be created with static constructor methods.

Constructor Summary

Constructors

Constructor and Description
TextualComponent()

Method Summary

Modifier and Type	Method and Description
abstract TextualComponent	clone() Clones a textual component instance.
abstract java.lang.String	getKey()
abstract java.lang.String	getReadableString()
static TextualComponent	localizedText(java.lang.String translateKey) Create a textual component representing a localized string.
static TextualComponent	objectiveScore(java.lang.String scoreboardObjective) Create a textual component representing a scoreboard value.
static TextualComponent	objectiveScore(java.lang.String playerName, java.lang.String scoreboardObjective) Create a textual component representing a scoreboard value.
static TextualComponent	rawText(java.lang.String textValue) Create a textual component representing a string literal.
static TextualComponent	selector(java.lang.String selector) Create a textual component representing a player name, retrievable by using a standard minecraft selector.
java.lang.String	toString()
abstract void	writeJson(JsonWriter writer) Writes the text data represented by this textual component to the specified JSON writer object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextualComponent

public TextualComponent()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getKey

public abstract java.lang.String getKey()

Returns:

The JSON key used to represent text components of this type.

getReadableString

public abstract java.lang.String getReadableString()

Returns:

A readable String

clone

public abstract TextualComponent clone()
                                throws java.lang.CloneNotSupportedException

Clones a textual component instance. The returned object should not reference this textual component instance, but should maintain the same key and value.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

writeJson

public abstract void writeJson(JsonWriter writer)
                        throws java.io.IOException

Writes the text data represented by this textual component to the specified JSON writer object. A new object within the writer is not started.

Parameters:

writer - The object to which to write the JSON data.

Throws:

java.io.IOException - If an error occurs while writing to the stream.

rawText

public static TextualComponent rawText(java.lang.String textValue)

Create a textual component representing a string literal. This is the default type of textual component when a single string literal is given to a method.

Parameters:

textValue - The text which will be represented.

Returns:

The text component representing the specified literal text.

localizedText

public static TextualComponent localizedText(java.lang.String translateKey)

Create a textual component representing a localized string. The client will see this text component as their localized version of the specified string key, which can be overridden by a resource pack.

If the specified translation key is not present on the client resource pack, the translation key will be displayed as a string literal to the client.

Parameters:

translateKey - The string key which maps to localized text.

Returns:

The text component representing the specified localized text.

objectiveScore

public static TextualComponent objectiveScore(java.lang.String scoreboardObjective)

Create a textual component representing a scoreboard value. The client will see their own score for the specified objective as the text represented by this component.

This method is currently guaranteed to throw an UnsupportedOperationException as it is only supported on snapshot clients.

Parameters:

scoreboardObjective - The name of the objective for which to display the score.

Returns:

The text component representing the specified scoreboard score (for the viewing player), or null if an error occurs during JSON serialization.

objectiveScore

public static TextualComponent objectiveScore(java.lang.String playerName,
                                              java.lang.String scoreboardObjective)

Create a textual component representing a scoreboard value. The client will see the score of the specified player for the specified objective as the text represented by this component.

This method is currently guaranteed to throw an UnsupportedOperationException as it is only supported on snapshot clients.

Parameters:

playerName - The name of the player whos score will be shown. If this string represents the single-character sequence "*", the viewing player's score will be displayed. Standard minecraft selectors (@a, @p, etc) are not supported.

scoreboardObjective - The name of the objective for which to display the score.

Returns:

The text component representing the specified scoreboard score for the specified player, or null if an error occurs during JSON serialization.

selector

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

Create a textual component representing a player name, retrievable by using a standard minecraft selector. The client will see the players or entities captured by the specified selector as the text represented by this component.

This method is currently guaranteed to throw an UnsupportedOperationException as it is only supported on snapshot clients.

Parameters:

selector - The minecraft player or entity selector which will capture the entities whose string representations will be displayed in the place of this text component.

Returns:

The text component representing the name of the entities captured by the selector.