Package org.bukkit.event.player
Class PlayerPreLoginEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerPreLoginEvent
Deprecated.
Stores details for players attempting to log in
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Deprecated.Basic kick reasons for communicating to plugins -
Constructor Summary
ConstructorDescriptionPlayerPreLoginEvent
(String name, InetAddress ipAddress) Deprecated.PlayerPreLoginEvent
(String name, InetAddress ipAddress, UUID uniqueId) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
allow()
Deprecated.Allows the player to log invoid
disallow
(PlayerPreLoginEvent.Result result, String message) Deprecated.Disallows the player from logging in, with the given reasonDeprecated.Gets the player IP address.static HandlerList
Deprecated.Deprecated.Deprecated.Gets the current kick message that will be used if getResult() != Result.ALLOWEDgetName()
Deprecated.Gets the player's name.Deprecated.Gets the current result of the login, as an enumDeprecated.Gets the player's unique ID.void
setKickMessage
(String message) Deprecated.Sets the kick message to display if getResult() != Result.ALLOWEDvoid
setResult
(PlayerPreLoginEvent.Result result) Deprecated.Sets the new result of the login, as an enumMethods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
-
Constructor Details
-
PlayerPreLoginEvent
@Deprecated(since="1.7.5") public PlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress) Deprecated. -
PlayerPreLoginEvent
public PlayerPreLoginEvent(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId) Deprecated.
-
-
Method Details
-
getResult
Deprecated.Gets the current result of the login, as an enum- Returns:
- Current Result of the login
-
setResult
Deprecated.Sets the new result of the login, as an enum- Parameters:
result
- New result to set
-
getKickMessage
Deprecated.Gets the current kick message that will be used if getResult() != Result.ALLOWED- Returns:
- Current kick message
-
setKickMessage
Deprecated.Sets the kick message to display if getResult() != Result.ALLOWED- Parameters:
message
- New kick message
-
allow
public void allow()Deprecated.Allows the player to log in -
disallow
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
-
getName
Deprecated.Gets the player's name.- Returns:
- the player's name
-
getAddress
Deprecated.Gets the player IP address.- Returns:
- The IP address
-
getHandlers
Deprecated.- Specified by:
getHandlers
in classEvent
-
getUniqueId
Deprecated.Gets the player's unique ID.- Returns:
- The unique ID
-
getHandlerList
Deprecated.
-
AsyncPlayerPreLoginEvent
is preferred to keep the secondary threads asynchronous.