Record Class ValueBarSection

java.lang.Object
java.lang.Record
de.Keyle.MyPet.api.gui.ValueBarSection
Record Components:
id - this section's id within its menu
type - the registered type handle this section was decoded as
col - left-hand column of the bar
row - the bar's row
width - bar length in slots, from 1 to 9
lowItem - appearance of cells above the fill position
highItem - appearance of cells at or below the fill position
soundOnClick - played when a cell is clicked
All Implemented Interfaces:
Section

public record ValueBarSection(String id, SectionType<ValueBarSection> type, int col, int row, int width, ItemAppearance lowItem, ItemAppearance highItem, SoundSpec soundOnClick) extends Record implements Section
One-row horizontal slider. Cells [0..position] render with highItem, cells (position..width-1] with lowItem. The handler supplies the fill position via MenuHandler.valueBarPosition(C, java.lang.String). Each cell exposes a <percent> placeholder.
  • Constructor Details

  • Method Details

    • percentAt

      public int percentAt(int index)
      Returns the percentage a given cell of the bar represents, for the <percent> placeholder.
      Parameters:
      index - 0-indexed cell position within the bar
      Returns:
      the percentage from 0 to 100; always 100 for a one-cell bar
    • 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.
    • id

      public String id()
      Returns the value of the id record component.
      Specified by:
      id in interface Section
      Returns:
      the value of the id record component
    • type

      public SectionType<ValueBarSection> type()
      Returns the value of the type record component.
      Specified by:
      type in interface Section
      Returns:
      the value of the type record component
    • col

      public int col()
      Returns the value of the col record component.
      Returns:
      the value of the col record component
    • row

      public int row()
      Returns the value of the row record component.
      Returns:
      the value of the row record component
    • width

      public int width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component
    • lowItem

      public ItemAppearance lowItem()
      Returns the value of the lowItem record component.
      Returns:
      the value of the lowItem record component
    • highItem

      public ItemAppearance highItem()
      Returns the value of the highItem record component.
      Returns:
      the value of the highItem record component
    • soundOnClick

      public SoundSpec soundOnClick()
      Returns the value of the soundOnClick record component.
      Returns:
      the value of the soundOnClick record component