Package com.velocitypowered.api.event.connection

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)	Deprecated, for removal: This API element is subject to removal in a future version. Use LoginEvent(Player, String).
LoginEvent(Player player, @Nullable String serverIdHash)	Constructs a new LoginEvent.

Method Summary

Modifier and Type	Method	Description
Player	getPlayer()	Returns the player who has completed authentication.
ResultedEvent.ComponentResult	getResult()	Returns the result associated with this event.
@Nullable String	getServerIdHash()	Returns the server ID hash that was sent to Mojang to authenticate the player.
void	setResult(ResultedEvent.ComponentResult result)	Sets the result of this event.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LoginEvent

public LoginEvent(Player player,
 @Nullable String serverIdHash)

Constructs a new LoginEvent.

Parameters:

player - the player who has completed authentication

serverIdHash - the server ID hash sent to Mojang for authentication, or null if the connection is in offline-mode

LoginEvent

@Deprecated(forRemoval=true)
public LoginEvent(Player player)

Deprecated, for removal: This API element is subject to removal in a future version.

Use LoginEvent(Player, String).

Constructs a new LoginEvent.

Parameters:

player - the player who has completed authentication

Method Details

getPlayer

public Player getPlayer()

Returns the player who has completed authentication.

Returns:

the authenticated player

getServerIdHash

public @Nullable String getServerIdHash()

Returns the server ID hash that was sent to Mojang to authenticate the player. If the connection was in offline-mode, this returns null.

Returns:

the server ID hash that was sent to Mojang to authenticate the player

getResult

public ResultedEvent.ComponentResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<ResultedEvent.ComponentResult>

Returns:

the result of this event

setResult

public void setResult(ResultedEvent.ComponentResult result)

Description copied from interface: ResultedEvent

Sets the result of this event. The result must be non-null.

Specified by:

setResult in interface ResultedEvent<ResultedEvent.ComponentResult>

Parameters:

result - the new result

toString

public String toString()

Overrides:

toString in class Object