Record Class BreakStartedEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.BreakStartedEvent
Record Components:
durationSeconds - the scheduled break duration in seconds
fatigue - the fatigue level at break start [0,1]
risk - the cumulative risk at break start
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record BreakStartedEvent(int durationSeconds, double fatigue, double risk, long timestamp) extends Record implements GameEvent
Fired when a break begins (logout triggered by fatigue/risk or manual schedule).

  • Constructor Summary

    Constructors
    Constructor
    Description
    BreakStartedEvent(int durationSeconds, double fatigue, double risk)
     
    BreakStartedEvent(int durationSeconds, double fatigue, double risk, long timestamp)
    Creates an instance of a BreakStartedEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    durationSeconds()
    Returns the value of the durationSeconds record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    fatigue()
    Returns the value of the fatigue record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    risk()
    Returns the value of the risk 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

    • BreakStartedEvent

      public BreakStartedEvent(int durationSeconds, double fatigue, double risk)

    • BreakStartedEvent

      public BreakStartedEvent(int durationSeconds, double fatigue, double risk, long timestamp)
      Creates an instance of a BreakStartedEvent record class.
      Parameters:
      durationSeconds - the value for the durationSeconds record component
      fatigue - the value for the fatigue record component
      risk - the value for the risk 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.

    • durationSeconds

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

    • fatigue

      public double fatigue()
      Returns the value of the fatigue record component.
      Returns:
      the value of the fatigue record component

    • risk

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