Package org.bukkit.event.player

Class AsyncPlayerPreLoginEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.AsyncPlayerPreLoginEvent

public class AsyncPlayerPreLoginEvent
extends Event

Stores details for players attempting to log in.

This event is asynchronous, and not run using main thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AsyncPlayerPreLoginEvent.Result	Basic kick reasons for communicating to plugins

Constructor Summary

Constructors

Constructor	Description
AsyncPlayerPreLoginEvent(String name, InetAddress ipAddress)	Deprecated.
AsyncPlayerPreLoginEvent(String name, InetAddress ipAddress, UUID uniqueId)

Method Summary

Modifier and Type	Method	Description
void	allow()	Allows the player to log in
void	disallow(AsyncPlayerPreLoginEvent.Result result, String message)	Disallows the player from logging in, with the given reason
void	disallow(PlayerPreLoginEvent.Result result, String message)	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent
InetAddress	getAddress()	Gets the player IP address.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
String	getKickMessage()	Gets the current kick message that will be used if getResult() != Result.ALLOWED
AsyncPlayerPreLoginEvent.Result	getLoginResult()	Gets the current result of the login, as an enum
String	getName()	Gets the player's name.
PlayerPreLoginEvent.Result	getResult()	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent
UUID	getUniqueId()	Gets the player's unique ID.
void	setKickMessage(String message)	Sets the kick message to display if getResult() != Result.ALLOWED
void	setLoginResult(AsyncPlayerPreLoginEvent.Result result)	Sets the new result of the login, as an enum
void	setResult(PlayerPreLoginEvent.Result result)	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncPlayerPreLoginEvent

@Deprecated
public AsyncPlayerPreLoginEvent(@NotNull
 String name,
 @NotNull
 InetAddress ipAddress)

Deprecated.

AsyncPlayerPreLoginEvent

public AsyncPlayerPreLoginEvent(@NotNull
 String name,
 @NotNull
 InetAddress ipAddress,
 @NotNull
 UUID uniqueId)

Method Details

getLoginResult

@NotNull
public AsyncPlayerPreLoginEvent.Result getLoginResult()

Gets the current result of the login, as an enum

Returns:

Current Result of the login

getResult

@Deprecated
@NotNull
public PlayerPreLoginEvent.Result getResult()

Deprecated.

This method uses a deprecated enum from PlayerPreLoginEvent

Gets the current result of the login, as an enum

Returns:

Current Result of the login

See Also:

• getLoginResult()

setLoginResult

public void setLoginResult(@NotNull
 AsyncPlayerPreLoginEvent.Result result)

Sets the new result of the login, as an enum

Parameters:

result - New result to set

setResult

@Deprecated
public void setResult(@NotNull
 PlayerPreLoginEvent.Result result)

Deprecated.

This method uses a deprecated enum from PlayerPreLoginEvent

Sets the new result of the login, as an enum

Parameters:

result - New result to set

See Also:

• setLoginResult(Result)

getKickMessage

@NotNull
public String getKickMessage()

Gets the current kick message that will be used if getResult() != Result.ALLOWED

Returns:

Current kick message

setKickMessage

public void setKickMessage(@NotNull
 String message)

Sets the kick message to display if getResult() != Result.ALLOWED

Parameters:

message - New kick message

allow

public void allow()

Allows the player to log in

disallow

public void disallow(@NotNull
 AsyncPlayerPreLoginEvent.Result result,
 @NotNull
 String message)

Disallows the player from logging in, with the given reason

Parameters:

result - New result for disallowing the player

message - Kick message to display to the user

disallow

@Deprecated
public void disallow(@NotNull
 PlayerPreLoginEvent.Result result,
 @NotNull
 String message)

Deprecated.

This method uses a deprecated enum from PlayerPreLoginEvent

Disallows the player from logging in, with the given reason

Parameters:

result - New result for disallowing the player

message - Kick message to display to the user

See Also:

• disallow(Result, String)

getName

@NotNull
public String getName()

Gets the player's name.

Returns:

the player's name

getAddress

@NotNull
public InetAddress getAddress()

Gets the player IP address.

Returns:

The IP address

getUniqueId

@NotNull
public UUID getUniqueId()

Gets the player's unique ID.

Returns:

The unique ID

getHandlers

@NotNull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()