Package xyz.gmitch215.socketmc.util.render.text

Class PaperText

java.lang.Object

xyz.gmitch215.socketmc.util.render.text.Text

xyz.gmitch215.socketmc.util.render.text.PaperText

All Implemented Interfaces:

Serializable

public final class PaperText
extends Text

Represents a text element to be displayed on the client's screen, built by a Component.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	alpha	The alpha value for the color in this text element.
protected Component	component	The text content for this text element.

Fields inherited from class xyz.gmitch215.socketmc.util.render.text.Text

dropShadow, FONT_HEIGHT

Constructor Summary

Constructors

Constructor	Description
PaperText()	Constructs a new, empty text element.
PaperText(@NotNull Component component)	Constructs a new text element.
PaperText(@NotNull Component component, int alpha)	Constructs a new text element.

Method Summary

Modifier and Type	Method	Description
static @NotNull PaperText	from(@NotNull Component component)	Creates a new text element from a component.
int	getAlpha()	Gets the alpha value for the color in this text element.
int	getColor()	Gets the color as an ARGB integer.
@NotNull Component	getComponent()	Gets the text content for this text element.
void	setAlpha(int alpha)	Sets the alpha value for the color in this text element.
void	setComponent(@NotNull Component component)	Sets the text content for this text element.
String	toJSON()	Serializes this text element to a JSON string compatible with the Minecraft Component format.

Methods inherited from class xyz.gmitch215.socketmc.util.render.text.Text

isDropShadow, setDropShadow

Methods inherited from class java.lang.Object

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

Field Details

component

protected Component component

The text content for this text element.

alpha

protected int alpha

The alpha value for the color in this text element.

Constructor Details

PaperText

public PaperText()

Constructs a new, empty text element.

PaperText

public PaperText(@NotNull
 @NotNull Component component)
          throws IllegalArgumentException

Constructs a new text element.

Parameters:

component - Component for Text

Throws:

IllegalArgumentException - if the component is null

PaperText

public PaperText(@NotNull
 @NotNull Component component,
 int alpha)
          throws IllegalArgumentException

Constructs a new text element.

Parameters:

component - Component for Text

alpha - Color Alpha Value

Throws:

IllegalArgumentException - if the component is null or the alpha value is not between 0 and 255

Method Details

getComponent

@NotNull
public @NotNull Component getComponent()

Gets the text content for this text element.

Returns:

Text Content

setComponent

public void setComponent(@NotNull
 @NotNull Component component)
                  throws IllegalArgumentException

Sets the text content for this text element.

Parameters:

component - Text Component

Throws:

IllegalArgumentException - if the text is null

getAlpha

public int getAlpha()

Gets the alpha value for the color in this text element.

Returns:

Alpha Value

setAlpha

public void setAlpha(int alpha)
              throws IllegalArgumentException

Sets the alpha value for the color in this text element.

Parameters:

alpha - Alpha Value

Throws:

IllegalArgumentException - if the alpha value is not between 0 and 255

getColor

public int getColor()

Description copied from class: Text

Gets the color as an ARGB integer.

Specified by:

getColor in class Text

Returns:

String Color

toJSON

public String toJSON()

Description copied from class: Text

Serializes this text element to a JSON string compatible with the Minecraft Component format.

Specified by:

toJSON in class Text

Returns:

JSON String

from

@NotNull
public static @NotNull PaperText from(@NotNull
 @NotNull Component component)

Creates a new text element from a component.

Parameters:

component - Component for Text

Returns:

Text Element