Record Class Inventory

java.lang.Object
java.lang.Record
com.botwithus.bot.api.snapshot.Inventory
Record Components:
invId - game-side inventory id (matches InventoryIds)
slotCount - declared slot count for this container
items - one entry per slot in [0, slotCount); empty slots have itemId == -1. Defensive copy is taken.
public record Inventory(int invId, int slotCount, List<InventoryItem> items) extends Record
Snapshot of one inventory container.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Inventory(int invId, int slotCount, List<InventoryItem> items)
    Creates an instance of a Inventory 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.
    int
    invId()
    Returns the value of the invId record component.
    List<InventoryItem>
    items()
    Returns the value of the items record component.
    int
    slotCount()
    Returns the value of the slotCount record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Inventory

      public Inventory(int invId, int slotCount, List<InventoryItem> items)
      Creates an instance of a Inventory record class.
      Parameters:
      invId - the value for the invId record component
      slotCount - the value for the slotCount record component
      items - the value for the items record component

  • Method Details

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

    • invId

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

    • slotCount

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

    • items

      public List<InventoryItem> items()
      Returns the value of the items record component.
      Returns:
      the value of the items record component