Package com.btcvelocity.api.bridge

Record Class BridgeMessage.WorldLoaded

java.lang.Object

java.lang.Record

com.btcvelocity.api.bridge.BridgeMessage.WorldLoaded

Record Components:

serverName - the name of the server that loaded the world

worldName - the name of the world that was loaded

loadTimeMs - the time in milliseconds it took to load the world

All Implemented Interfaces:

BridgeMessage

Enclosing interface:

BridgeMessage

public static record BridgeMessage.WorldLoaded(String serverName, String worldName, long loadTimeMs)
extends Record
implements BridgeMessage

Backend -> Proxy: a world has been loaded and is ready to accept players.

Nested Class Summary

Nested classes/interfaces inherited from interface com.btcvelocity.api.bridge.BridgeMessage

BridgeMessage.ConnectRequest, BridgeMessage.Health, BridgeMessage.PartyWarp, BridgeMessage.QueueJoin, BridgeMessage.QueueLeave, BridgeMessage.QueueStatusResponse, BridgeMessage.RequestStatus, BridgeMessage.WorldLoaded, BridgeMessage.WorldPreload, BridgeMessage.WorldUnloaded

Constructor Summary

Constructors

Constructor	Description
WorldLoaded(String serverName, String worldName, long loadTimeMs)	Creates an instance of a WorldLoaded 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.
long	loadTimeMs()	Returns the value of the loadTimeMs record component.
String	serverName()	Returns the value of the serverName record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the string discriminator used to route this message during (de)serialization.
String	worldName()	Returns the value of the worldName record component.

Methods inherited from class java.lang.Object

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

Constructor Details

WorldLoaded

public WorldLoaded(String serverName,
 String worldName,
 long loadTimeMs)

Creates an instance of a WorldLoaded record class.

Parameters:

serverName - the value for the serverName record component

worldName - the value for the worldName record component

loadTimeMs - the value for the loadTimeMs record component

Method Details

type

public String type()

Description copied from interface: BridgeMessage

Returns the string discriminator used to route this message during (de)serialization.

Specified by:

type in interface BridgeMessage

Returns:

the message type identifier

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

serverName

public String serverName()

Returns the value of the serverName record component.

Returns:

the value of the serverName record component

worldName

public String worldName()

Returns the value of the worldName record component.

Returns:

the value of the worldName record component

loadTimeMs

public long loadTimeMs()

Returns the value of the loadTimeMs record component.

Returns:

the value of the loadTimeMs record component