Package com.velocitypowered.api.proxy.server

Enum Class PlayerInfoForwarding

java.lang.Object

java.lang.Enum<PlayerInfoForwarding>

com.velocitypowered.api.proxy.server.PlayerInfoForwarding

All Implemented Interfaces:

Serializable, Comparable<PlayerInfoForwarding>, Constable

public enum PlayerInfoForwarding
extends Enum<PlayerInfoForwarding>

Supported player info forwarding methods.

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
BUNGEEGUARD	Uses BungeeGuard-style secure IP forwarding, which works by sending a shared secret token in the handshake.
LEGACY	Forwards player information using the legacy BungeeCord IP forwarding system.
MODERN	Forwards player information using Velocity's modern forwarding system, based on a signed public key and identity chain.
NONE	No player information is forwarded.

Method Summary

Modifier and Type	Method	Description
static PlayerInfoForwarding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerInfoForwarding[]	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

NONE

public static final PlayerInfoForwarding NONE

No player information is forwarded. Backend servers will treat all players as offline-mode users with random UUIDs and no skin or IP information.

This mode is the safest for servers that do not support Velocity's forwarding, but it disables any functionality dependent on online UUIDs or skins.

LEGACY

public static final PlayerInfoForwarding LEGACY

Forwards player information using the legacy BungeeCord IP forwarding system. This requires backend servers to have IP forwarding enabled and to use a compatible login handler (such as in Paper or BungeeCord-compatible forks).

Use this if your backend servers do not support Velocity’s modern forwarding, but do support BungeeCord-style forwarding.

BUNGEEGUARD

public static final PlayerInfoForwarding BUNGEEGUARD

Uses BungeeGuard-style secure IP forwarding, which works by sending a shared secret token in the handshake. This helps secure legacy IP forwarding without modifying the backend server.

Requires BungeeGuard (or a compatible plugin) to be installed and configured on backend servers.

MODERN

public static final PlayerInfoForwarding MODERN

Forwards player information using Velocity's modern forwarding system, based on a signed public key and identity chain.

This is the most secure and recommended method, requiring backend support for Velocity’s forwarding protocol (such as in Paper 1.13+ with Velocity forwarding enabled).

Method Details

values

public static PlayerInfoForwarding[] 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 PlayerInfoForwarding 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