Record Class ObjVarChangeEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.ObjVarChangeEvent
Record Components:
invId - the container id (e.g. 93 = backpack)
slot - the 0-based slot index within the container
varId - the obj-var id that changed
oldValue - the previous value
newValue - the new value
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record ObjVarChangeEvent(int invId, int slot, int varId, int oldValue, int newValue, long timestamp) extends Record implements GameEvent
Fired when a per-item obj var changes value.

Obj vars are the per-instance variables an item carries inside a container slot's ObjVarDomain (augmentation XP, charges, etc.) — distinct from the global player varp / client varc domains. The value space is keyed by (invId, slot, varId); correlate slot with the snapshot's inventory items to find which item it belongs to.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ObjVarChangeEvent(int invId, int slot, int varId, int oldValue, int newValue)
     
    ObjVarChangeEvent(int invId, int slot, int varId, int oldValue, int newValue, long timestamp)
    Creates an instance of a ObjVarChangeEvent 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.
    int
    newValue()
    Returns the value of the newValue record component.
    int
    oldValue()
    Returns the value of the oldValue record component.
    int
    slot()
    Returns the value of the slot record component.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    varId()
    Returns the value of the varId record component.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface GameEvent

    type

  • Constructor Details

    • ObjVarChangeEvent

      public ObjVarChangeEvent(int invId, int slot, int varId, int oldValue, int newValue)

    • ObjVarChangeEvent

      public ObjVarChangeEvent(int invId, int slot, int varId, int oldValue, int newValue, long timestamp)
      Creates an instance of a ObjVarChangeEvent record class.
      Parameters:
      invId - the value for the invId record component
      slot - the value for the slot record component
      varId - the value for the varId record component
      oldValue - the value for the oldValue record component
      newValue - the value for the newValue record component
      timestamp - the value for the timestamp 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.

    • invId

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

    • slot

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

    • varId

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

    • oldValue

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

    • newValue

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

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface GameEvent
      Returns:
      the value of the timestamp record component