Package org.spongepowered.api.event.network

Interface ServerSideConnectionEvent

All Superinterfaces:

Event

All Known Subinterfaces:

ServerSideConnectionEvent.Auth, ServerSideConnectionEvent.Configuration, ServerSideConnectionEvent.Disconnect, ServerSideConnectionEvent.Handshake, ServerSideConnectionEvent.Intent, ServerSideConnectionEvent.Join, ServerSideConnectionEvent.Leave, ServerSideConnectionEvent.Login, ServerSideConnectionEvent.ProfileScoped

public interface ServerSideConnectionEvent
extends Event

Represents an event fired during the login and configuration phase.

These events represent the progression of a player from first authenticating, to being fully loaded in the world.

The events are fired in the following order:

#Intent -> #Auth -> #Handshake -> #Configuration -> #Login -> #Join

Vanilla also allows the client to go back to the configuration phase where the player is removed from the world before being put back after the configuration phase ends. The order of the events is the following:

#Leave -> #Configuration -> #Login -> #Join

Traditionally one could consider a SpawnEntityEvent to be thrown, but due to the nature of cancellations, a player joining a world after login would be inadvisable to cancel due to the inconsistent state of both the player and the player's client.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ServerSideConnectionEvent.Auth	Called asynchronously when the client attempts to authenticate against the server.
static interface	ServerSideConnectionEvent.Configuration	Called when the configuration phase starts.
static interface	ServerSideConnectionEvent.Disconnect	Called when a connection disconnects from the game.
static interface	ServerSideConnectionEvent.Handshake	Called after the client authenticates and attempts to switch to the configuration phase.
static interface	ServerSideConnectionEvent.Intent	Called asynchronously when the client attempts to connect to the server.
static interface	ServerSideConnectionEvent.Join	Called when a player joins the game within a world for the first time after the configuration phase.
static interface	ServerSideConnectionEvent.Leave	Called when a player leaves from the world.
static interface	ServerSideConnectionEvent.Login	Called after the server finished its configuration with the client.
static interface	ServerSideConnectionEvent.ProfileScoped	Represents an event that has knowledge about the GameProfile that is linked to the connection.

Method Summary

Modifier and Type	Method	Description
ServerSideConnection	connection()	Gets the ServerSideConnection.

Methods inherited from interface org.spongepowered.api.event.Event

cause, context, source

Method Details

connection

ServerSideConnection connection()

Gets the ServerSideConnection.

Returns:

The server side connection