Record Class GroundItem

java.lang.Object
java.lang.Record
com.botwithus.bot.api.snapshot.GroundItem
Record Components:
itemId - item type id (resolves via GameAPI.getItemType)
quantity - stack size; 1 for non-stackable items
tileX - absolute world tile X
tileY - absolute world tile Y
plane - 0..3
public record GroundItem(int itemId, int quantity, int tileX, int tileY, int plane) extends Record
Snapshot of one ground-item stack at the producer's current tick (v15+).

Rows come from the producer's ObjStackList walk; every alive bucket entry within the loaded-scene tile bounds is emitted. Consumers spatially filter on the immutable snapshot.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GroundItem(int itemId, int quantity, int tileX, int tileY, int plane)
    Creates an instance of a GroundItem 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
    itemId()
    Returns the value of the itemId record component.
    int
    plane()
    Returns the value of the plane record component.
    int
    quantity()
    Returns the value of the quantity record component.
    int
    tileX()
    Returns the value of the tileX record component.
    int
    tileY()
    Returns the value of the tileY 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

    • GroundItem

      public GroundItem(int itemId, int quantity, int tileX, int tileY, int plane)
      Creates an instance of a GroundItem record class.
      Parameters:
      itemId - the value for the itemId record component
      quantity - the value for the quantity record component
      tileX - the value for the tileX record component
      tileY - the value for the tileY record component
      plane - the value for the plane 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. All components in this record class 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.

    • itemId

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

    • quantity

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

    • tileX

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

    • tileY

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

    • plane

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