Package org.spongepowered.api.event.network

Interface ServerSideConnectionEvent.Login

All Superinterfaces:

Cancellable, Event, MessageEvent, ServerSideConnectionEvent, ServerSideConnectionEvent.ProfileScoped

Enclosing interface:

ServerSideConnectionEvent

public static interface ServerSideConnectionEvent.Login
extends ServerSideConnectionEvent.ProfileScoped, MessageEvent, Cancellable

Called after the server finished its configuration with the client.

Note: This event is fired after #Configuration and is NOT async. Any changes required for the players location or rotation should be done during this event and NOT during #Join.

If the registered BanService or WhitelistService indicates that a player should not be allowed to join ( GameProfile or InetAddress has an ban, or is not on the whitelist), then this event will automatically cancelled by the implementation, with the proper message set through MessageEvent.setMessage(Component). No action on the part of the registered BanService or WhitelistService is required for this to occur.

Plugins may uncancel the event to allow a client to join, regardless of its ban/whitelist status.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.event.network.ServerSideConnectionEvent

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

Method Summary

Modifier and Type	Method	Description
ServerLocation	fromLocation()	Gets the previous location the player would have logged in at.
Vector3d	fromRotation()	Gets the rotation the player would have logged in to.
void	setToLocation(ServerLocation location)	Sets the location the player will log in at.
void	setToRotation(Vector3d rotation)	Sets the rotation the player will log in to.
ServerLocation	toLocation()	Gets the location the player will log in at.
Vector3d	toRotation()	Gets the rotation the player will log in to.
User	user()	Gets the User.

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

isCancelled, setCancelled

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

cause, context, source

Methods inherited from interface org.spongepowered.api.event.message.MessageEvent

message, originalMessage, setMessage

Methods inherited from interface org.spongepowered.api.event.network.ServerSideConnectionEvent

connection

Methods inherited from interface org.spongepowered.api.event.network.ServerSideConnectionEvent.ProfileScoped

profile

Method Details

user

User user()

Gets the User.

Returns:

The user

fromLocation

ServerLocation fromLocation()

Gets the previous location the player would have logged in at.

Returns:

The location

toLocation

ServerLocation toLocation()

Gets the location the player will log in at.

Returns:

The location

setToLocation

void setToLocation(ServerLocation location)

Sets the location the player will log in at.

Parameters:

location - The location

fromRotation

Vector3d fromRotation()

Gets the rotation the player would have logged in to.

Returns:

The rotation

toRotation

Vector3d toRotation()

Gets the rotation the player will log in to.

Returns:

The rotation

setToRotation

void setToRotation(Vector3d rotation)

Sets the rotation the player will log in to.

Parameters:

rotation - The rotation