Record Class WalkCancelledEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.WalkCancelledEvent
Record Components:
targetX - the original target world X coordinate
targetY - the original target world Y coordinate
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record WalkCancelledEvent(int targetX, int targetY, long timestamp) extends Record implements GameEvent
Fired when a walk is cancelled (explicitly via walkCancel(), or implicitly when an action interrupts it).

  • Constructor Summary

    Constructors
    Constructor
    Description
    WalkCancelledEvent(int targetX, int targetY)
     
    WalkCancelledEvent(int targetX, int targetY, long timestamp)
    Creates an instance of a WalkCancelledEvent 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
    targetX()
    Returns the value of the targetX record component.
    int
    targetY()
    Returns the value of the targetY record component.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface GameEvent

    type

  • Constructor Details

    • WalkCancelledEvent

      public WalkCancelledEvent(int targetX, int targetY)

    • WalkCancelledEvent

      public WalkCancelledEvent(int targetX, int targetY, long timestamp)
      Creates an instance of a WalkCancelledEvent record class.
      Parameters:
      targetX - the value for the targetX record component
      targetY - the value for the targetY 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.

    • targetX

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

    • targetY

      public int targetY()
      Returns the value of the targetY record component.
      Returns:
      the value of the targetY 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