Record Class FirstContact

java.lang.Object

java.lang.Record

dev.zwazel.internal.message.data.FirstContact

Record Components:

botName - The name of the bot.

lobbyName - The name of the lobby the bot is joining.

mapName - The name of the map the bot is joining.

teamName - The name of the team the bot is joining.

clientType - The type of client the bot is (player or spectator).

botAssignedSpawnPoint - The spawn point the bot is assigned.

tankType - The type of tank the bot is using. can be null if the bot is a spectator.

All Implemented Interfaces:

MessageData

public record FirstContact(String botName, String lobbyName, String mapName, String teamName, FirstContact.ClientType clientType, Long botAssignedSpawnPoint, TankType tankType)
extends Record
implements MessageData

Message data for when a bot makes first contact with the server. This is the first message sent by a bot to the server. Used to register the bot with the server, and do initial setup.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FirstContact.ClientType

Constructor Summary

Constructors

Constructor	Description
FirstContact(String botName, String lobbyName, String mapName, String teamName, FirstContact.ClientType clientType, Long botAssignedSpawnPoint, TankType tankType)	Creates an instance of a FirstContact record class.

Method Summary

Modifier and Type	Method	Description
Long	botAssignedSpawnPoint()	Returns the value of the botAssignedSpawnPoint record component.
String	botName()	Returns the value of the botName record component.
FirstContact.ClientType	clientType()	Returns the value of the clientType 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.
String	lobbyName()	Returns the value of the lobbyName record component.
String	mapName()	Returns the value of the mapName record component.
TankType	tankType()	Returns the value of the tankType record component.
String	teamName()	Returns the value of the teamName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.zwazel.internal.message.MessageData

applyBeforeSend, applyOnAddingToQueue, applyOnReceive, isUnique

Constructor Details

FirstContact

public FirstContact(String botName,
 String lobbyName,
 String mapName,
 String teamName,
 FirstContact.ClientType clientType,
 Long botAssignedSpawnPoint,
 TankType tankType)

Creates an instance of a FirstContact record class.

Parameters:

botName - the value for the botName record component

lobbyName - the value for the lobbyName record component

mapName - the value for the mapName record component

teamName - the value for the teamName record component

clientType - the value for the clientType record component

botAssignedSpawnPoint - the value for the botAssignedSpawnPoint record component

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

botName

public String botName()

Returns the value of the botName record component.

Returns:

the value of the botName record component

lobbyName

public String lobbyName()

Returns the value of the lobbyName record component.

Returns:

the value of the lobbyName record component

mapName

public String mapName()

Returns the value of the mapName record component.

Returns:

the value of the mapName record component

teamName

public String teamName()

Returns the value of the teamName record component.

Returns:

the value of the teamName record component

clientType

public FirstContact.ClientType clientType()

Returns the value of the clientType record component.

Returns:

the value of the clientType record component

botAssignedSpawnPoint

public Long botAssignedSpawnPoint()

Returns the value of the botAssignedSpawnPoint record component.

Returns:

the value of the botAssignedSpawnPoint record component

tankType

public TankType tankType()

Returns the value of the tankType record component.

Returns:

the value of the tankType record component