Package dev.twilite.client.ui.overlay

Record Class OverlayScreenTextLabel

java.lang.Object
java.lang.Record
dev.twilite.client.ui.overlay.OverlayScreenTextLabel
public record OverlayScreenTextLabel(String text, int x, int y, int argb, boolean rightAligned) extends Record
A single screen-space overlay text label.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OverlayScreenTextLabel(String text, int x, int y, int argb)
    Creates a left-aligned label.
    OverlayScreenTextLabel(String text, int x, int y, int argb, boolean rightAligned)
    Creates an instance of a OverlayScreenTextLabel record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    argb()
    Returns the value of the argb record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    rightAligned()
    Returns the value of the rightAligned record component.
    String
    text()
    Returns the value of the text record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    x()
    Returns the value of the x record component.
    int
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OverlayScreenTextLabel

      public OverlayScreenTextLabel(String text, int x, int y, int argb)
      Creates a left-aligned label.

    • OverlayScreenTextLabel

      public OverlayScreenTextLabel(String text, int x, int y, int argb, boolean rightAligned)
      Creates an instance of a OverlayScreenTextLabel record class.
      Parameters:
      text - the value for the text record component
      x - the value for the x record component
      y - the value for the y record component
      argb - the value for the argb record component
      rightAligned - the value for the rightAligned record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • x

      public int x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public int y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • argb

      public int argb()
      Returns the value of the argb record component.
      Returns:
      the value of the argb record component

    • rightAligned

      public boolean rightAligned()
      Returns the value of the rightAligned record component.
      Returns:
      the value of the rightAligned record component