public static interface ClientConnectionEvent.Login extends ClientConnectionEvent, MessageEvent, TargetUserEvent, Cancellable
Note: This event is fired after #Auth and is NOT async. Any changes
required for the Player
s 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.
ClientConnectionEvent.Auth, ClientConnectionEvent.Disconnect, ClientConnectionEvent.Join, ClientConnectionEvent.Login
MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier, MessageEvent.MessageFormatter
PARAM_MESSAGE_BODY, PARAM_MESSAGE_FOOTER, PARAM_MESSAGE_HEADER
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. |
clearMessage, getFormatter, getMessage, getOriginalMessage, isMessageCancelled, setMessage, setMessage, setMessage, setMessageCancelled
getTargetUser
getCause, getContext, getSource
isCancelled, setCancelled
RemoteConnection getConnection()
RemoteConnection
representing the client connection.GameProfile getProfile()
Transform<World> getFromTransform()
Player
came from.Transform<World> getToTransform()
Player
will change to.