Class LocalPlayerPreLoginEvent

java.lang.Object

eu.cloudnetservice.driver.event.Event

eu.cloudnetservice.modules.bridge.node.event.LocalPlayerPreLoginEvent

public final class LocalPlayerPreLoginEvent
extends eu.cloudnetservice.driver.event.Event

Called before the login of a player is processed and therefore allows determining the outcome of the login process.

Note: This event is ONLY called on the node the proxy is running on.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LocalPlayerPreLoginEvent.Result	Represents the outcome of the login event.

Field Summary

Fields

Modifier and Type	Field	Description
private final NetworkPlayerProxyInfo	playerInfo
private LocalPlayerPreLoginEvent.Result	result

Constructor Summary

Constructors

Constructor	Description
LocalPlayerPreLoginEvent(@NonNull NetworkPlayerProxyInfo playerInfo)	Constructs a new player pre login event with the given player proxy info.

Method Summary

Modifier and Type	Method	Description
@NonNull NetworkPlayerProxyInfo	playerInfo()	Gets the player proxy info for the player requesting a login.
@NonNull LocalPlayerPreLoginEvent.Result	result()	Gets the result of the login process.
void	result(@NonNull LocalPlayerPreLoginEvent.Result result)	Sets the result of the login process.

Methods inherited from class java.lang.Object

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

Field Details

playerInfo

private final NetworkPlayerProxyInfo playerInfo

result

private LocalPlayerPreLoginEvent.Result result

Constructor Details

LocalPlayerPreLoginEvent

public LocalPlayerPreLoginEvent(@NonNull
 @NonNull NetworkPlayerProxyInfo playerInfo)

Constructs a new player pre login event with the given player proxy info.

Parameters:

playerInfo - the player info of the player connecting.

Throws:

NullPointerException - if the player proxy info is null.

Method Details

playerInfo

@NonNull
public @NonNull NetworkPlayerProxyInfo playerInfo()

Gets the player proxy info for the player requesting a login.

Returns:

the player proxy info.

result

@NonNull
public @NonNull LocalPlayerPreLoginEvent.Result result()

Gets the result of the login process. If LocalPlayerPreLoginEvent.Result.permitLogin() is true the player is allowed to log in and denied otherwise.

Returns:

the result of the login process.

result

public void result(@NonNull
 @NonNull LocalPlayerPreLoginEvent.Result result)

Sets the result of the login process. To deny a login use LocalPlayerPreLoginEvent.Result.denied(Component) and LocalPlayerPreLoginEvent.Result.allowed() to allow the login.

Parameters:

result - the result to set for the login.

Throws:

NullPointerException - if the result is null.