Interface ServerSideConnectionEvent.Intent
- All Superinterfaces:
Cancellable
,Event
,MessageEvent
,ServerSideConnectionEvent
- Enclosing interface:
ServerSideConnectionEvent
public static interface ServerSideConnectionEvent.Intent
extends ServerSideConnectionEvent, MessageEvent, Cancellable
Called asynchronously when the client attempts to connect to the server.
During this event, it's possible to use the RawDataChannel
s to send
requests to the client. As long as there's requests going to the client,
the connection will stay in the intent phase and will not continue
to the ServerSideConnectionEvent.Auth
event.
After observing this event for particular connection
you are guaranteed to get #Disconnect for the same connection without
ordering issues.
-
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 TypeMethodDescriptionboolean
Gets if the user is intending to connect due to being transferred.Methods inherited from interface org.spongepowered.api.event.Cancellable
isCancelled, setCancelled
Methods inherited from interface org.spongepowered.api.event.message.MessageEvent
message, originalMessage, setMessage
Methods inherited from interface org.spongepowered.api.event.network.ServerSideConnectionEvent
connection
-
Method Details
-
isTransfer
boolean isTransfer()Gets if the user is intending to connect due to being transferred.- Returns:
true
if the user is transferring.
-