Record Class TickEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.TickEvent
Record Components:
tick - the server tick counter value
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record TickEvent(int tick, long timestamp) extends Record implements GameEvent
Fired each game tick when the server tick counter advances.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TickEvent(int tick)
     
    TickEvent(int tick, long timestamp)
    Creates an instance of a TickEvent 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
    tick()
    Returns the value of the tick 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

    • TickEvent

      public TickEvent(int tick)

    • TickEvent

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

    • tick

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