Record Class SlotPosition

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.world.gui.SlotPosition
Record Components:
segment - the inventory segment (TOP or BOTTOM)
index - the slot index within that segment
public record SlotPosition(GuiView.Segment segment, int index) extends Record
A record defining a specific location within a GuiView.

Combines an inventory segment with a numerical slot index to uniquely identify a slot in either the top or bottom inventory.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SlotPosition(GuiView.Segment segment, int index)
    Creates an instance of a SlotPosition record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SlotPosition
    bottom(int slot)
    Creates a position reference for the bottom inventory.
    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.
    int
    index()
    Returns the value of the index record component.
    GuiView.Segment
    segment()
    Returns the value of the segment record component.
    static SlotPosition
    top(int slot)
    Creates a position reference for the top inventory.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SlotPosition

      public SlotPosition(GuiView.Segment segment, int index)
      Creates an instance of a SlotPosition record class.
      Parameters:
      segment - the value for the segment record component
      index - the value for the index record component

  • Method Details

    • top

      public static SlotPosition top(int slot)
      Creates a position reference for the top inventory.
      Parameters:
      slot - the slot index
      Returns:
      a new SlotPosition for the top segment

    • bottom

      public static SlotPosition bottom(int slot)
      Creates a position reference for the bottom inventory.
      Parameters:
      slot - the slot index
      Returns:
      a new SlotPosition for the bottom segment

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

    • segment

      public GuiView.Segment segment()
      Returns the value of the segment record component.
      Returns:
      the value of the segment record component

    • index

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