Package org.spongepowered.api.event.network

Interface ServerSideConnectionEvent.Auth

All Superinterfaces:
Cancellable, Event, MessageEvent, ServerSideConnectionEvent, ServerSideConnectionEvent.ProfileScoped
Enclosing interface:
ServerSideConnectionEvent
public static interface ServerSideConnectionEvent.Auth extends ServerSideConnectionEvent.ProfileScoped, MessageEvent, Cancellable
Called asynchronously when the client attempts to authenticate against the server.

After observing this event for particular connection you are guaranteed to get #Disconnect for the same connection without ordering issues.

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.

Note: This event is fired before #Login.