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
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 ClassesModifier and TypeClassDescriptionstatic enum
Deprecated.Basic kick reasons for communicating to plugins -
Constructor Summary
ConstructorsConstructorDescriptionPlayerPreLoginEvent
(@NotNull String name, @NotNull InetAddress ipAddress) Deprecated, for removal: This API element is subject to removal in a future version.PlayerPreLoginEvent
(@NotNull String name, @NotNull InetAddress ipAddress, @NotNull UUID uniqueId) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
allow()
Deprecated.Allows the player to log invoid
disallow
(@NotNull PlayerPreLoginEvent.Result result, @NotNull String message) Deprecated.void
disallow
(@NotNull PlayerPreLoginEvent.Result result, @NotNull Component message) Deprecated.Disallows the player from logging in, with the given reasonDeprecated.Gets the player IP address.static @NotNull HandlerList
Deprecated.Deprecated.Deprecated.in favour ofkickMessage()
getName()
Deprecated.Gets the player's name.Deprecated.Gets the current result of the login, as an enumDeprecated.Gets the player's unique ID.Deprecated.Gets the current kick message that will be used when the outcome is not allowedvoid
kickMessage
(@NotNull Component message) Deprecated.Sets the kick message to display when the outcome is not allowedvoid
setKickMessage
(@NotNull String message) Deprecated.in favour ofkickMessage(Component)
void
Deprecated.Sets the new result of the login, as an enumMethods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerPreLoginEvent
@Internal @Deprecated(since="1.7.5", forRemoval=true) public PlayerPreLoginEvent(@NotNull @NotNull String name, @NotNull @NotNull InetAddress ipAddress) Deprecated, for removal: This API element is subject to removal in a future version. -
PlayerPreLoginEvent
@Internal public PlayerPreLoginEvent(@NotNull @NotNull String name, @NotNull @NotNull InetAddress ipAddress, @NotNull @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
-
kickMessage
Deprecated.Gets the current kick message that will be used when the outcome is not allowed- Returns:
- Current kick message
-
kickMessage
Deprecated.Sets the kick message to display when the outcome is not allowed- Parameters:
message
- New kick message
-
disallow
public void disallow(@NotNull @NotNull PlayerPreLoginEvent.Result result, @NotNull @NotNull Component 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
-
getKickMessage
Deprecated.in favour ofkickMessage()
Gets the current kick message that will be used when the outcome is not allowed- Returns:
- Current kick message
-
setKickMessage
Deprecated.in favour ofkickMessage(Component)
Sets the kick message to display when the outcome is not allowed- Parameters:
message
- New kick message
-
allow
public void allow()Deprecated.Allows the player to log in -
disallow
@Deprecated public void disallow(@NotNull @NotNull PlayerPreLoginEvent.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
-
getName
Deprecated.Gets the player's name.- Returns:
- the player's name
-
getAddress
Deprecated.Gets the player IP address.- Returns:
- The IP address
-
getUniqueId
Deprecated.Gets the player's unique ID.- Returns:
- The unique ID
-
getHandlers
Deprecated.- Specified by:
getHandlers
in classEvent
-
getHandlerList
Deprecated.
-
AsyncPlayerPreLoginEvent
is preferred to keep the secondary threads asynchronous.