Class LocalPlayerPreLoginEvent.Result

java.lang.Object

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

Enclosing class:

LocalPlayerPreLoginEvent

public static final class LocalPlayerPreLoginEvent.Result
extends Object

Represents the outcome of the login event.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowed
private static final LocalPlayerPreLoginEvent.Result	ALLOWED
private final Component	result

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Result(boolean allowed, @Nullable Component result)	Constructs a new result for the player pre login event.

Method Summary

Modifier and Type	Method	Description
static @NonNull LocalPlayerPreLoginEvent.Result	allowed()	Gets a jvm static result that allows the login.
static @NonNull LocalPlayerPreLoginEvent.Result	denied(@Nullable Component reason)	Creates a new result that denies the login of the player and sets the given reason.
boolean	permitLogin()	Gets whether this result allows the login or not.
@UnknownNullability Component	result()	Gets the text component that is displayed to the player if the login is denied.

Methods inherited from class java.lang.Object

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

Field Details

ALLOWED

private static final LocalPlayerPreLoginEvent.Result ALLOWED

allowed

private final boolean allowed

result

private final Component result

Constructor Details

Result

private Result(boolean allowed,
 @Nullable
 @Nullable Component result)

Constructs a new result for the player pre login event.

Parameters:

allowed - whether the player is allowed to connect or not.

result - the reason for denying the login.

Method Details

allowed

@NonNull
public static @NonNull LocalPlayerPreLoginEvent.Result allowed()

Gets a jvm static result that allows the login.

Returns:

an allowing result.

denied

@NonNull
public static @NonNull LocalPlayerPreLoginEvent.Result denied(@Nullable
 @Nullable Component reason)

Creates a new result that denies the login of the player and sets the given reason.

Parameters:

reason - the reason for denying the login.

Returns:

the new result denying the login.

permitLogin

public boolean permitLogin()

Gets whether this result allows the login or not.

Returns:

true if the login is allowed, false otherwise.

result

public @UnknownNullability Component result()

Gets the text component that is displayed to the player if the login is denied.

Returns:

the reason to display to the player, might be null if the component is not set.