Record Class ResourceItem

java.lang.Object
java.lang.Record
com.botwithus.bot.api.model.ResourceItem
Record Components:
itemId - item type id (e.g. 453 for coal)
level - minimum level to obtain
quantity - quantity per harvest action when applicable; 0 for "unspecified"
public record ResourceItem(int itemId, int level, int quantity) extends Record
A single resource line on a WorldMapElement — typically an ore, fish, or log obtainable at the spot.

  • Constructor Summary

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

    • ResourceItem

      public ResourceItem(int itemId, int level, int quantity)
      Creates an instance of a ResourceItem record class.
      Parameters:
      itemId - the value for the itemId record component
      level - the value for the level record component
      quantity - the value for the quantity 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

    • level

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

    • quantity

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