Package studio.mevera.lotus.api.slot

Record Class Slot

java.lang.Object
java.lang.Record
studio.mevera.lotus.api.slot.Slot
All Implemented Interfaces:
Comparable<Slot>
public record Slot(int index) extends Record implements Comparable<Slot>
Position within a menu, identified by its raw inventory index.

Row/column derivation is capacity-relative — see row(Capacity) and column(Capacity).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Slot(int index)
    Creates an instance of a Slot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static @NotNull Slot
    at(int row, int column, @NotNull Capacity capacity)
     
    int
    column(@NotNull Capacity capacity)
     
    int
    compareTo(@NotNull Slot other)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static @NotNull Slot
    first()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    index()
    Returns the value of the index record component.
    static @NotNull Slot
    last(@NotNull Capacity capacity)
     
    static @NotNull Slot
    of(int index)
     
    int
    row(@NotNull Capacity capacity)
     
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull Slot
    translate(int delta)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Slot

      public Slot(int index)
      Creates an instance of a Slot record class.
      Parameters:
      index - the value for the index record component

  • Method Details

    • of

      @NotNull public static @NotNull Slot of(int index)

    • at

      @NotNull public static @NotNull Slot at(int row, int column, @NotNull @NotNull Capacity capacity)

    • first

      @NotNull public static @NotNull Slot first()

    • last

      @NotNull public static @NotNull Slot last(@NotNull @NotNull Capacity capacity)

    • row

      public int row(@NotNull @NotNull Capacity capacity)

    • column

      public int column(@NotNull @NotNull Capacity capacity)

    • translate

      @NotNull public @NotNull Slot translate(int delta)

    • compareTo

      public int compareTo(@NotNull @NotNull Slot other)
      Specified by:
      compareTo in interface Comparable<Slot>

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

    • index

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