Record Class FoliosText.Line

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.page.FoliosText.Line
Record Components:
first - whether it starts its block (a bullet's mark is drawn on it)
marker - the bullet's mark or number, drawn at x - INDENT
shift - how far right of x its words start, for centred and right-aligned lines
stretch - the room shared out between its words, for a justified line
scale - how large the words after a leading item slot are drawn: under 1 for a line kept whole beside its slot ({slot:...} or {item:...}) by drawing them smaller
Enclosing class:
FoliosText
public static record FoliosText.Line(net.minecraft.util.FormattedCharSequence text, int x, int y, FoliosText.Kind kind, boolean first, String marker, int shift, int stretch, float scale) extends Record
One line, at (x, y) from the text's top left.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Line(net.minecraft.util.FormattedCharSequence text, int x, int y, FoliosText.Kind kind, boolean first, String marker, int shift, int stretch)
     
    Line(net.minecraft.util.FormattedCharSequence text, int x, int y, FoliosText.Kind kind, boolean first, String marker, int shift, int stretch, float scale)
    Creates an instance of a Line record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    first()
    Returns the value of the first record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    height()
     
    FoliosText.Kind
    kind()
    Returns the value of the kind record component.
    String
    marker()
    Returns the value of the marker record component.
    float
    scale()
    Returns the value of the scale record component.
    int
    shift()
    Returns the value of the shift record component.
    int
    stretch()
    Returns the value of the stretch record component.
    net.minecraft.util.FormattedCharSequence
    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 Object

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

  • Constructor Details

    • Line

      public Line(net.minecraft.util.FormattedCharSequence text, int x, int y, FoliosText.Kind kind, boolean first, String marker, int shift, int stretch)

    • Line

      public Line(net.minecraft.util.FormattedCharSequence text, int x, int y, FoliosText.Kind kind, boolean first, String marker, int shift, int stretch, float scale)
      Creates an instance of a Line 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
      kind - the value for the kind record component
      first - the value for the first record component
      marker - the value for the marker record component
      shift - the value for the shift record component
      stretch - the value for the stretch record component
      scale - the value for the scale record component

  • Method Details

    • height

      public int height()

    • 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 the compare method from their corresponding wrapper classes.
      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 net.minecraft.util.FormattedCharSequence 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

    • kind

      public FoliosText.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • first

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

    • marker

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

    • shift

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

    • stretch

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

    • scale

      public float scale()
      Returns the value of the scale record component.
      Returns:
      the value of the scale record component