Record Class LoginStateChangeEvent

java.lang.Object

java.lang.Record

com.botwithus.bot.api.event.LoginStateChangeEvent

Record Components:

oldState - the previous login state value

newState - the new login state value

timestamp - event creation time in milliseconds since epoch

All Implemented Interfaces:

GameEvent

public record LoginStateChangeEvent(int oldState, int newState, long timestamp)
extends Record
implements GameEvent

Fired when the client login state changes (e.g., lobby to logged in).

Settled states: 10 = login screen, 20 = lobby, 30 = in a world. Other codes are not settled states; 0 means the agent could not resolve the client yet.

Constructor Summary

Constructors

Constructor	Description
LoginStateChangeEvent(int oldState, int newState)
LoginStateChangeEvent(int oldState, int newState, long timestamp)	Creates an instance of a LoginStateChangeEvent 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	newState()	Returns the value of the newState record component.
int	oldState()	Returns the value of the oldState 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

LoginStateChangeEvent

public LoginStateChangeEvent(int oldState,
 int newState)

LoginStateChangeEvent

public LoginStateChangeEvent(int oldState,
 int newState,
 long timestamp)

Creates an instance of a LoginStateChangeEvent record class.

Parameters:

oldState - the value for the oldState record component

newState - the value for the newState 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.

oldState

public int oldState()

Returns the value of the oldState record component.

Returns:

the value of the oldState record component

newState

public int newState()

Returns the value of the newState record component.

Returns:

the value of the newState 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