Record Class LauncherEvent.ClientStarted

java.lang.Object

java.lang.Record

com.botwithus.bot.api.script.LauncherEvent.ClientStarted

Record Components:

client - the full record

All Implemented Interfaces:

LauncherEvent

Enclosing interface:

LauncherEvent

public static record LauncherEvent.ClientStarted(LaunchedClient client)
extends Record
implements LauncherEvent

A client started: a launch reached its first record, or auto-restart replaced the process (then LaunchedClient.restartOf() is set).

Nested Class Summary

Nested classes/interfaces inherited from interface LauncherEvent

LauncherEvent.AgentUpdated, LauncherEvent.ClientExited, LauncherEvent.ClientStarted, LauncherEvent.ClientStateChanged, LauncherEvent.DataPhase, LauncherEvent.DataUpdateApplied, LauncherEvent.DataUpdateAvailable, LauncherEvent.EventsDropped, LauncherEvent.ExitReason, LauncherEvent.LicenceChanged, LauncherEvent.ServiceLost, LauncherEvent.ServiceRestored, LauncherEvent.ServiceShuttingDown

Constructor Summary

Constructors

Constructor	Description
ClientStarted(LaunchedClient client)	Creates an instance of a ClientStarted record class.

Method Summary

Modifier and Type	Method	Description
LaunchedClient	client()	Returns the value of the client record component.
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.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ClientStarted

public ClientStarted(LaunchedClient client)

Creates an instance of a ClientStarted record class.

Parameters:

client - the value for the client 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 Objects::equals(Object,Object).

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.

client

public LaunchedClient client()

Returns the value of the client record component.

Returns:

the value of the client record component