Class LoginEvent
- java.lang.Object
-
- com.velocitypowered.api.event.connection.LoginEvent
-
- All Implemented Interfaces:
ResultedEvent<ResultedEvent.ComponentResult>
@AwaitingEvent public final class LoginEvent extends Object implements ResultedEvent<ResultedEvent.ComponentResult>
This event is fired once the player has been authenticated, but before they connect to a server. Velocity will wait for this event to finish firing before proceeding with the rest of the login process, but you should try to limit the work done in any event that fires during the login process.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent
ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result
-
-
Constructor Summary
Constructors Constructor Description LoginEvent(Player player)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlayergetPlayer()ResultedEvent.ComponentResultgetResult()Returns the result associated with this event.voidsetResult(ResultedEvent.ComponentResult result)Sets the result of this event.StringtoString()
-
-
-
Constructor Detail
-
LoginEvent
public LoginEvent(Player player)
-
-
Method Detail
-
getPlayer
public Player getPlayer()
-
getResult
public ResultedEvent.ComponentResult getResult()
Description copied from interface:ResultedEventReturns the result associated with this event.- Specified by:
getResultin interfaceResultedEvent<ResultedEvent.ComponentResult>- Returns:
- the result of this event
-
setResult
public void setResult(ResultedEvent.ComponentResult result)
Description copied from interface:ResultedEventSets the result of this event. The result must be non-null.- Specified by:
setResultin interfaceResultedEvent<ResultedEvent.ComponentResult>- Parameters:
result- the new result
-
-