Package org.bukkit.event.player
Class PlayerLoginEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerLoginEvent
Stores details for players attempting to log in.
Note that this event is called early in the player initialization process. It is recommended that most options involving the Player entity be postponed to the
Note that this event is called early in the player initialization process. It is recommended that most options involving the Player entity be postponed to the
PlayerJoinEvent
instead.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Basic kick reasons for communicating to plugins -
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
ConstructorDescriptionPlayerLoginEvent
(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address) This constructor defaults message to an empty string, and result to ALLOWEDPlayerLoginEvent
(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address, @NotNull InetAddress realAddress) This constructor defaults message to an empty string, and result to ALLOWEDPlayerLoginEvent
(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address, @NotNull PlayerLoginEvent.Result result, @NotNull String message, @NotNull InetAddress realAddress) Deprecated.PlayerLoginEvent
(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address, @NotNull PlayerLoginEvent.Result result, Component message, @NotNull InetAddress realAddress) This constructor pre-configures the event with a result and message -
Method Summary
Modifier and TypeMethodDescriptionvoid
allow()
Allows the player to log invoid
disallow
(@NotNull PlayerLoginEvent.Result result, @NotNull String message) Deprecated.in favour ofdisallow(Result, net.kyori.adventure.text.Component)
void
disallow
(@NotNull PlayerLoginEvent.Result result, Component message) Disallows the player from logging in, with the given reasonGets theInetAddress
for the Player associated with this event.static @NotNull HandlerList
Gets the hostname that the player used to connect to the server, or blank if unknownDeprecated.in favour ofkickMessage()
Gets the connection address of this player, regardless of whether it has been spoofed or not.Gets the current result of the login, as an enumGets the current kick message that will be used if getResult() != Result.ALLOWEDvoid
kickMessage
(@NotNull 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
setResult
(@NotNull PlayerLoginEvent.Result result) Sets the new result of the login, as an enumMethods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerLoginEvent
public PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull @NotNull InetAddress realAddress) This constructor defaults message to an empty string, and result to ALLOWED- Parameters:
player
- ThePlayer
for this eventhostname
- The hostname that was used to connect to the serveraddress
- The address the player used to connect, provided for timing issuesrealAddress
- the actual, unspoofed connecting address
-
PlayerLoginEvent
public PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address) This constructor defaults message to an empty string, and result to ALLOWED- Parameters:
player
- ThePlayer
for this eventhostname
- The hostname that was used to connect to the serveraddress
- The address the player used to connect, provided for timing issues
-
PlayerLoginEvent
@Deprecated public PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull @NotNull PlayerLoginEvent.Result result, @NotNull @NotNull String message, @NotNull @NotNull InetAddress realAddress) Deprecated.This constructor pre-configures the event with a result and message- Parameters:
player
- ThePlayer
for this eventhostname
- The hostname that was used to connect to the serveraddress
- The address the player used to connect, provided for timing issuesresult
- The result status for this eventmessage
- The message to be displayed if result denies loginrealAddress
- the actual, unspoofed connecting address
-
PlayerLoginEvent
public PlayerLoginEvent(@NotNull @NotNull Player player, @NotNull @NotNull String hostname, @NotNull @NotNull InetAddress address, @NotNull @NotNull PlayerLoginEvent.Result result, @NotNull Component message, @NotNull @NotNull InetAddress realAddress) This constructor pre-configures the event with a result and message- Parameters:
player
- ThePlayer
for this eventhostname
- The hostname that was used to connect to the serveraddress
- The address the player used to connect, provided for timing issuesresult
- The result status for this eventmessage
- The message to be displayed if result denies loginrealAddress
- the actual, unspoofed connecting address
-
-
Method Details
-
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
-
getResult
Gets the current result of the login, as an enum- Returns:
- Current Result of the login
-
setResult
Sets the new result of the login, as an enum- Parameters:
result
- New result to set
-
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
-
getHostname
Gets the hostname that the player used to connect to the server, or blank if unknown- Returns:
- The hostname
-
allow
public void allow()Allows the player to log in -
disallow
@Deprecated public void disallow(@NotNull @NotNull PlayerLoginEvent.Result result, @NotNull @NotNull String message) Deprecated.in favour ofdisallow(Result, net.kyori.adventure.text.Component)
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
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
-
getAddress
Gets theInetAddress
for the Player associated with this event. This method is provided as a workaround for player.getAddress() returning null during PlayerLoginEvent.- Returns:
- The address for this player. For legacy compatibility, this may be null.
-
getRealAddress
Gets the connection address of this player, regardless of whether it has been spoofed or not.- Returns:
- the player's connection address
- See Also:
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
PlayerLoginEvent(Player, String, InetAddress, Result, net.kyori.adventure.text.Component, InetAddress)