Record Class HudLine

java.lang.Object
java.lang.Record
dev.boze.api.render.HudLine
Record Components:
texts - the colored segments that make up this line
public record HudLine(List<HudText> texts) extends Record
A single line of a HUD, made up of one or more colored HudText segments rendered left to right and separated by spaces. A List<HudLine> stacks these lines vertically.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HudLine(List<HudText> texts)
    Creates an instance of a HudLine record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    static HudLine
    of(HudText... texts)
    Creates a line from the given colored segments.
    List<HudText>
    texts()
    Returns the value of the texts record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • HudLine

      public HudLine(List<HudText> texts)
      Creates an instance of a HudLine record class.
      Parameters:
      texts - the value for the texts record component

  • Method Details

    • of

      public static HudLine of(HudText... texts)
      Creates a line from the given colored segments.
      Parameters:
      texts - the colored segments, drawn left to right separated by spaces
      Returns:
      a new HudLine

    • 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.

    • texts

      public List<HudText> texts()
      Returns the value of the texts record component.
      Returns:
      the value of the texts record component