org.spongepowered.api.event.network

Interface ClientConnectionEvent.Login

All Superinterfaces:

Cancellable, ClientConnectionEvent, Event, MessageEvent, TargetUserEvent

Enclosing interface:

ClientConnectionEvent

public static interface ClientConnectionEvent.Login
extends ClientConnectionEvent, MessageEvent, TargetUserEvent, Cancellable

Called after the client authenticates and attempts to login to the server.

Note: This event is fired after #Auth and is NOT async. Any changes required for the Players Transform 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(TextRepresentable). 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.ClientConnectionEvent

ClientConnectionEvent.Auth, ClientConnectionEvent.Disconnect, ClientConnectionEvent.Join, ClientConnectionEvent.Login

Nested classes/interfaces inherited from interface org.spongepowered.api.event.message.MessageEvent

MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier, MessageEvent.MessageFormatter

Field Summary

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

PARAM_MESSAGE_BODY, PARAM_MESSAGE_FOOTER, PARAM_MESSAGE_HEADER

Method Summary

Modifier and Type	Method and Description
RemoteConnection	getConnection() Gets the RemoteConnection representing the client connection.
Transform<World>	getFromTransform() Gets the transform that the Player came from.
GameProfile	getProfile() Gets the profile of the client attempting to connect.
Transform<World>	getToTransform() Gets the new transform that the Player will change to.
void	setToTransform(Transform<World> transform) Sets the new transform that the Player will change to.

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

clearMessage, getFormatter, getMessage, getOriginalMessage, isMessageCancelled, setMessage, setMessage, setMessage, setMessageCancelled

Methods inherited from interface org.spongepowered.api.event.user.TargetUserEvent

getTargetUser

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

getCause, getContext, getSource

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

isCancelled, setCancelled

Method Detail

getConnection

RemoteConnection getConnection()

Gets the RemoteConnection representing the client connection.

Returns:

The remote connection

getProfile

GameProfile getProfile()

Gets the profile of the client attempting to connect.

Returns:

The client's profile

getFromTransform

Transform<World> getFromTransform()

Gets the transform that the Player came from.

Returns:

the previous transform

getToTransform

Transform<World> getToTransform()

Gets the new transform that the Player will change to.

Returns:

the new transform

setToTransform

void setToTransform(Transform<World> transform)

Sets the new transform that the Player will change to.

Parameters:

transform - The new transform