Package com.velocitypowered.api.network

Enum Class HandshakeIntent

java.lang.Object

java.lang.Enum<HandshakeIntent>

com.velocitypowered.api.network.HandshakeIntent

All Implemented Interfaces:

Serializable, Comparable<HandshakeIntent>, Constable

public enum HandshakeIntent
extends Enum<HandshakeIntent>

Represents the ClientIntent of a client in the Handshake state.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOGIN	Indicates that the client intends to log in to the server.
STATUS	Indicates that the client is performing a status request (e.g., server list ping).
TRANSFER	Indicates that the client is initiating a transfer (e.g., Velocity-native forwarding).

Method Summary

Modifier and Type	Method	Description
static HandshakeIntent	getById(int id)	Obtain the HandshakeIntent by ID.
int	id()	Returns the numeric ID associated with this handshake intent.
static HandshakeIntent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HandshakeIntent[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

STATUS

public static final HandshakeIntent STATUS

Indicates that the client is performing a status request (e.g., server list ping).

LOGIN

public static final HandshakeIntent LOGIN

Indicates that the client intends to log in to the server.

TRANSFER

public static final HandshakeIntent TRANSFER

Indicates that the client is initiating a transfer (e.g., Velocity-native forwarding).

Method Details

values

public static HandshakeIntent[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HandshakeIntent valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

id

public int id()

Returns the numeric ID associated with this handshake intent.

Returns:

the handshake intent ID

getById

public static HandshakeIntent getById(int id)

Obtain the HandshakeIntent by ID.

Parameters:

id - the intent id

Returns:

the HandshakeIntent desired