Record Class HudText

java.lang.Object
java.lang.Record
dev.boze.api.render.HudText
Record Components:
text - the text to draw
color - the color to draw it in (e.g. from ColorMaker)
public record HudText(String text, ClientColor color) extends Record
A single piece of colored text on a HudLine.
Multiple HudTexts on a line are rendered next to each other, separated by a space.

  • Constructor Details

    • HudText

      public HudText(String text, ClientColor color)
      Creates an instance of a HudText record class.
      Parameters:
      text - the value for the text record component
      color - the value for the color 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. All components in this record class are compared with Objects::equals(Object,Object).
      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

    • color

      public ClientColor color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component