Package org.spongepowered.api.event.network

Interface ServerSideConnectionEvent

All Superinterfaces:

Event

All Known Subinterfaces:

ServerSideConnectionEvent.Auth, ServerSideConnectionEvent.Disconnect, ServerSideConnectionEvent.Handshake, ServerSideConnectionEvent.Join, ServerSideConnectionEvent.Login

public interface ServerSideConnectionEvent
extends Event

Represents an event fired during the login process.

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:

#Auth -> #Handshake -> #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.Disconnect	Called when a player disconnects from the game.
static interface	ServerSideConnectionEvent.Handshake	Called after the client authenticates and attempts to login to the server.
static interface	ServerSideConnectionEvent.Join	Called when a player joins the game within a world for the first time after initial connection.
static interface	ServerSideConnectionEvent.Login	Called after the server finished its handshake with the client.

Method Summary

Modifier and Type	Method	Description
ServerSideConnection	connection()	Gets the ServerSideConnection.
default GameProfile	profile()	Gets the GameProfile of the client attempting to connect.

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

profile

default GameProfile profile()

Gets the GameProfile of the client attempting to connect.

Returns:

The client's profile