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.

This event is fired after the server has successfully completed Mojang authentication. The event is still fired if the server is in offline mode.

When this event is fired, the player's locale is not available. Therefore, any translatable component will be rendered with the default locale, Locale.US.

Consider rendering any translatable yourself with GlobalTranslator.render(net.kyori.adventure.text.Component, java.util.Locale) if the client's language is known.

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(@NotNull String name, @NotNull InetAddress ipAddress)	Deprecated, for removal: This API element is subject to removal in a future version.
AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull InetAddress rawAddress, @NotNull UUID uniqueId, boolean transferred, PlayerProfile profile)	Deprecated, for removal: This API element is subject to removal in a future version.
AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull InetAddress rawAddress, @NotNull UUID uniqueId, boolean transferred, PlayerProfile profile, @NotNull String hostname, PlayerLoginConnection playerLoginConnection)
AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId)	Deprecated, for removal: This API element is subject to removal in a future version.
AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId, boolean transferred)
AsyncPlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId, boolean transferred, PlayerProfile profile)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
void	allow()	Allows the player to log in
void	disallow(@NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull String message)	Deprecated. in favour of disallow(org.bukkit.event.player.AsyncPlayerPreLoginEvent.Result, Component)
void	disallow(@NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull Component message)	Disallows the player from logging in, with the given reason
void	disallow(PlayerPreLoginEvent.Result result, @NotNull String message)	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent
void	disallow(PlayerPreLoginEvent.Result result, Component message)	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent
@NotNull InetAddress	getAddress()	Gets the player IP address.
@NotNull PlayerLoginConnection	getConnection()	Gets the connection for the player logging in.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull String	getHostname()	Gets the hostname that the player used to connect to the server, or blank if unknown
@NotNull String	getKickMessage()	Deprecated. in favour of kickMessage()
@NotNull AsyncPlayerPreLoginEvent.Result	getLoginResult()	Gets the current result of the login, as an enum
@NotNull String	getName()	Gets the player's name.
PlayerProfile	getPlayerProfile()	Gets the PlayerProfile of the player logging in
@NotNull InetAddress	getRawAddress()	Gets the raw address of the player logging in
PlayerPreLoginEvent.Result	getResult()	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent
@NotNull UUID	getUniqueId()	Gets the player's unique ID.
boolean	isTransferred()	Gets if this connection has been transferred from another server.
@NotNull Component	kickMessage()	Gets the current kick message that will be used when the outcome is not allowed
void	kickMessage(@NotNull Component message)	Sets the kick message to display when the outcome is not allowed
void	setKickMessage(@NotNull String message)	Deprecated. in favour of kickMessage(Component)
void	setLoginResult(@NotNull AsyncPlayerPreLoginEvent.Result result)	Sets the new result of the login, as an enum
void	setPlayerProfile(PlayerProfile profile)	Changes the PlayerProfile the player will login as
void	setResult(PlayerPreLoginEvent.Result result)	Deprecated. This method uses a deprecated enum from PlayerPreLoginEvent

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

AsyncPlayerPreLoginEvent

@Internal
@Deprecated(since="1.7.5",
            forRemoval=true)
public AsyncPlayerPreLoginEvent(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull InetAddress ipAddress)

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

AsyncPlayerPreLoginEvent

@Internal
@Deprecated(since="1.20.5",
            forRemoval=true)
public AsyncPlayerPreLoginEvent(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull InetAddress ipAddress,
 @NotNull
 @NotNull UUID uniqueId)

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

AsyncPlayerPreLoginEvent

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

AsyncPlayerPreLoginEvent

@Internal
@Deprecated(forRemoval=true)
public AsyncPlayerPreLoginEvent(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull InetAddress ipAddress,
 @NotNull
 @NotNull UUID uniqueId,
 boolean transferred,
 @NotNull
 PlayerProfile profile)

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

AsyncPlayerPreLoginEvent

@Internal
@Deprecated(forRemoval=true)
public AsyncPlayerPreLoginEvent(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull InetAddress ipAddress,
 @NotNull
 @NotNull InetAddress rawAddress,
 @NotNull
 @NotNull UUID uniqueId,
 boolean transferred,
 @NotNull
 PlayerProfile profile)

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

AsyncPlayerPreLoginEvent

@Internal
public AsyncPlayerPreLoginEvent(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull InetAddress ipAddress,
 @NotNull
 @NotNull InetAddress rawAddress,
 @NotNull
 @NotNull UUID uniqueId,
 boolean transferred,
 @NotNull
 PlayerProfile profile,
 @NotNull
 @NotNull String hostname,
 PlayerLoginConnection playerLoginConnection)

Method Details

getLoginResult

@NotNull
public @NotNull AsyncPlayerPreLoginEvent.Result getLoginResult()

Gets the current result of the login, as an enum

Returns:

Current Result of the login

getResult

@Deprecated(since="1.3.2")
@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
 @NotNull AsyncPlayerPreLoginEvent.Result result)

Sets the new result of the login, as an enum

Parameters:

result - New result to set

setResult

@Deprecated(since="1.3.2")
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)

kickMessage

@NotNull
public @NotNull Component kickMessage()

Gets the current kick message that will be used when the outcome is not allowed

Returns:

Current kick message

kickMessage

public void kickMessage(@NotNull
 @NotNull Component message)

Sets the kick message to display when the outcome is not allowed

Parameters:

message - New kick message

disallow

public void disallow(@NotNull
 @NotNull AsyncPlayerPreLoginEvent.Result result,
 @NotNull
 @NotNull Component 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
 Component 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)

getKickMessage

@NotNull
@Deprecated
public @NotNull String getKickMessage()

Deprecated.

in favour of kickMessage()

Gets the current kick message that will be used when the outcome is not allowed

Returns:

Current kick message

setKickMessage

@Deprecated
public void setKickMessage(@NotNull
 @NotNull String message)

Deprecated.

in favour of kickMessage(Component)

Sets the kick message to display when the outcome is not allowed

Parameters:

message - New kick message

allow

public void allow()

Allows the player to log in

disallow

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

Deprecated.

in favour of disallow(org.bukkit.event.player.AsyncPlayerPreLoginEvent.Result, Component)

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(since="1.3.2")
public void disallow(@NotNull
 PlayerPreLoginEvent.Result result,
 @NotNull
 @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 @NotNull String getName()

Gets the player's name.

Returns:

the player's name

getAddress

@NotNull
public @NotNull InetAddress getAddress()

Gets the player IP address.

Returns:

The IP address

getUniqueId

@NotNull
public @NotNull UUID getUniqueId()

Gets the player's unique ID.

Returns:

The unique ID

getPlayerProfile

@NotNull
public PlayerProfile getPlayerProfile()

Gets the PlayerProfile of the player logging in

Returns:

The Profile

setPlayerProfile

public void setPlayerProfile(@NotNull
 PlayerProfile profile)

Changes the PlayerProfile the player will login as

Parameters:

profile - The profile to use

getRawAddress

@NotNull
public @NotNull InetAddress getRawAddress()

Gets the raw address of the player logging in

Returns:

The address

getHostname

@NotNull
public @NotNull String getHostname()

Gets the hostname that the player used to connect to the server, or blank if unknown

Returns:

The hostname

isTransferred

public boolean isTransferred()

Gets if this connection has been transferred from another server.

Returns:

true if the connection has been transferred

getConnection

@Experimental
@NotNull
public @NotNull PlayerLoginConnection getConnection()

Gets the connection for the player logging in.

Returns:

connection

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()