Package org.bukkit.event.player
Class AsyncPlayerPreLoginEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.AsyncPlayerPreLoginEvent
Stores details for players attempting to log in.
This event is asynchronous, and not run using main thread.
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
Modifier and TypeClassDescriptionstatic enum
Basic kick reasons for communicating to plugins -
Constructor Summary
ConstructorDescriptionAsyncPlayerPreLoginEvent
(@NotNull String name, @NotNull InetAddress ipAddress) Deprecated.AsyncPlayerPreLoginEvent
(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull InetAddress rawAddress, @NotNull UUID uniqueId, @NotNull 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, @NotNull PlayerProfile profile, @NotNull String hostname) AsyncPlayerPreLoginEvent
(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId) AsyncPlayerPreLoginEvent
(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId, @NotNull PlayerProfile profile) Deprecated, for removal: This API element is subject to removal in a future version. -
Method Summary
Modifier and TypeMethodDescriptionvoid
allow()
Allows the player to log invoid
disallow
(@NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull String message) Deprecated.void
disallow
(@NotNull AsyncPlayerPreLoginEvent.Result result, Component message) Disallows the player from logging in, with the given reasonvoid
disallow
(PlayerPreLoginEvent.Result result, @NotNull String message) Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
void
disallow
(PlayerPreLoginEvent.Result result, Component message) Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
Gets the player IP address.static @NotNull HandlerList
Gets the hostname that the player used to connect to the server, or blank if unknownDeprecated.in favour ofkickMessage()
Gets the current result of the login, as an enumgetName()
Gets the player's name.Gets the PlayerProfile of the player logging inGets the raw address of the player logging inDeprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
Gets the player's unique ID.Gets the current kick message that will be used if getResult() != Result.ALLOWEDvoid
kickMessage
(Component message) Sets the kick message to display if getResult() != Result.ALLOWEDvoid
setKickMessage
(@NotNull String message) Deprecated.in favour ofkickMessage(net.kyori.adventure.text.Component)
void
Sets the new result of the login, as an enumvoid
setPlayerProfile
(@NotNull PlayerProfile profile) Changes the PlayerProfile the player will login asvoid
setResult
(PlayerPreLoginEvent.Result result) Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
Methods inherited from class org.bukkit.event.Event
asynchronous, callEvent, getEventName, isAsynchronous
-
Constructor Details
-
AsyncPlayerPreLoginEvent
@Deprecated public AsyncPlayerPreLoginEvent(@NotNull @NotNull String name, @NotNull @NotNull InetAddress ipAddress) Deprecated. -
AsyncPlayerPreLoginEvent
-
AsyncPlayerPreLoginEvent
@Deprecated(forRemoval=true) public AsyncPlayerPreLoginEvent(@NotNull @NotNull String name, @NotNull @NotNull InetAddress ipAddress, @NotNull @NotNull UUID uniqueId, @NotNull @NotNull PlayerProfile profile) Deprecated, for removal: This API element is subject to removal in a future version. -
AsyncPlayerPreLoginEvent
@Deprecated(forRemoval=true) public AsyncPlayerPreLoginEvent(@NotNull @NotNull String name, @NotNull @NotNull InetAddress ipAddress, @NotNull @NotNull InetAddress rawAddress, @NotNull @NotNull UUID uniqueId, @NotNull @NotNull PlayerProfile profile) Deprecated, for removal: This API element is subject to removal in a future version. -
AsyncPlayerPreLoginEvent
-
-
Method Details
-
getLoginResult
Gets the current result of the login, as an enum- Returns:
- Current Result of the login
-
getResult
Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
Gets the current result of the login, as an enum- Returns:
- Current Result of the login
- See Also:
-
setLoginResult
Sets the new result of the login, as an enum- Parameters:
result
- New result to set
-
setResult
Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
Sets the new result of the login, as an enum- Parameters:
result
- New result to set- See Also:
-
kickMessage
Gets the current kick message that will be used if getResult() != Result.ALLOWED- Returns:
- Current kick message
-
kickMessage
Sets the kick message to display if getResult() != Result.ALLOWED- Parameters:
message
- New kick message
-
disallow
public void disallow(@NotNull @NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull Component message) Disallows the player from logging in, with the given reason- Parameters:
result
- New result for disallowing the playermessage
- 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 fromPlayerPreLoginEvent
Disallows the player from logging in, with the given reason- Parameters:
result
- New result for disallowing the playermessage
- Kick message to display to the user- See Also:
-
getKickMessage
Deprecated.in favour ofkickMessage()
Gets the current kick message that will be used if getResult() != Result.ALLOWED- Returns:
- Current kick message
-
setKickMessage
Deprecated.in favour ofkickMessage(net.kyori.adventure.text.Component)
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
@Deprecated public void disallow(@NotNull @NotNull AsyncPlayerPreLoginEvent.Result result, @NotNull @NotNull String message) Deprecated.Disallows the player from logging in, with the given reason- Parameters:
result
- New result for disallowing the playermessage
- Kick message to display to the user
-
disallow
@Deprecated public void disallow(@NotNull PlayerPreLoginEvent.Result result, @NotNull @NotNull String message) Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
Disallows the player from logging in, with the given reason- Parameters:
result
- New result for disallowing the playermessage
- Kick message to display to the user- See Also:
-
getName
Gets the player's name.- Returns:
- the player's name
-
getAddress
Gets the player IP address.- Returns:
- The IP address
-
getUniqueId
Gets the player's unique ID.- Returns:
- The unique ID
-
getPlayerProfile
Gets the PlayerProfile of the player logging in- Returns:
- The Profile
-
setPlayerProfile
Changes the PlayerProfile the player will login as- Parameters:
profile
- The profile to use
-
getRawAddress
Gets the raw address of the player logging in- Returns:
- The address
-
getHostname
Gets the hostname that the player used to connect to the server, or blank if unknown- Returns:
- The hostname
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
disallow(org.bukkit.event.player.AsyncPlayerPreLoginEvent.Result, net.kyori.adventure.text.Component)