Package net.neoforged.neoforge.event.entity.player

Class PlayerNegotiationEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.player.PlayerNegotiationEvent

public class PlayerNegotiationEvent
extends net.neoforged.bus.api.Event

This event is fired on the server when a connection has started the Forge handshake, Forge will wait for all enqueued work to be completed before proceeding further with the login process.
This event can be used to delay the player login until any necessary work such as preloading user data has completed.
This event is fired on the NeoForge.EVENT_BUS.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final Connection	connection
private final List<Future<Void>>	futures
private final com.mojang.authlib.GameProfile	profile

Constructor Summary

Constructors

Constructor	Description
PlayerNegotiationEvent(Connection connection, com.mojang.authlib.GameProfile profile, List<Future<Void>> futures)

Method Summary

Modifier and Type	Method	Description
void	enqueueWork(Runnable runnable)	Enqueue work to be completed asynchronously before the login proceeds.
void	enqueueWork(Future<Void> future)	Enqueue work to be completed asynchronously before the login proceeds.
Connection	getConnection()
com.mojang.authlib.GameProfile	getProfile()

Methods inherited from class net.neoforged.bus.api.Event

getResult, hasResult, setResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

connection

private final Connection connection

profile

private final com.mojang.authlib.GameProfile profile

futures

private final List<Future<Void>> futures

Constructor Details

PlayerNegotiationEvent

public PlayerNegotiationEvent(Connection connection,
 com.mojang.authlib.GameProfile profile,
 List<Future<Void>> futures)

Method Details

enqueueWork

public void enqueueWork(Runnable runnable)

Enqueue work to be completed asynchronously before the login proceeds.

enqueueWork

public void enqueueWork(Future<Void> future)

Enqueue work to be completed asynchronously before the login proceeds.

getConnection

public Connection getConnection()

getProfile

public com.mojang.authlib.GameProfile getProfile()