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 class
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 invoid
disallow(AsyncPlayerPreLoginEvent.Result result, String message)
Disallows the player from logging in, with the given reasonvoid
disallow(PlayerPreLoginEvent.Result result, String message)
Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
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.ALLOWEDAsyncPlayerPreLoginEvent.Result
getLoginResult()
Gets the current result of the login, as an enumString
getName()
Gets the player's name.PlayerPreLoginEvent.Result
getResult()
Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
UUID
getUniqueId()
Gets the player's unique ID.void
setKickMessage(String message)
Sets the kick message to display if getResult() != Result.ALLOWEDvoid
setLoginResult(AsyncPlayerPreLoginEvent.Result result)
Sets the new result of the login, as an enumvoid
setResult(PlayerPreLoginEvent.Result result)
Deprecated.This method uses a deprecated enum fromPlayerPreLoginEvent
-
Constructor Details
-
AsyncPlayerPreLoginEvent
Deprecated. -
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:
getLoginResult()
-
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:
setLoginResult(Result)
-
getKickMessage
Gets the current kick message that will be used if getResult() != Result.ALLOWED- Returns:
- Current kick message
-
setKickMessage
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
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 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:
disallow(Result, String)
-
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
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-