Package org.bukkit.event.player

Class PlayerLoginEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerLoginEvent
public class PlayerLoginEvent extends PlayerEvent
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 PlayerJoinEvent instead.

  • Constructor Details

    • PlayerLoginEvent

      public PlayerLoginEvent(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address, @NotNull InetAddress realAddress)
      This constructor defaults message to an empty string, and result to ALLOWED
      Parameters:
      player - The Player for this event
      hostname - The hostname that was used to connect to the server
      address - The address the player used to connect, provided for timing issues
      realAddress - the actual, unspoofed connecting address

    • PlayerLoginEvent

      public PlayerLoginEvent(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address)

    • PlayerLoginEvent

      public PlayerLoginEvent(@NotNull Player player, @NotNull String hostname, @NotNull InetAddress address, @NotNull PlayerLoginEvent.Result result, @NotNull String message, @NotNull InetAddress realAddress)
      This constructor pre-configures the event with a result and message
      Parameters:
      player - The Player for this event
      hostname - The hostname that was used to connect to the server
      address - The address the player used to connect, provided for timing issues
      result - The result status for this event
      message - The message to be displayed if result denies login
      realAddress - the actual, unspoofed connecting address

  • Method Details

    • getRealAddress

      @NotNull public InetAddress getRealAddress()
      Gets the connection address of this player, regardless of whether it has been spoofed or not.
      Returns:
      the player's connection address

    • getResult

      @NotNull public PlayerLoginEvent.Result getResult()
      Gets the current result of the login, as an enum
      Returns:
      Current Result of the login

    • setResult

      public void setResult(@NotNull PlayerLoginEvent.Result result)
      Sets the new result of the login, as an enum
      Parameters:
      result - New result to set

    • getKickMessage

      @NotNull public String getKickMessage()
      Gets the current kick message that will be used if getResult() != Result.ALLOWED
      Returns:
      Current kick message

    • setKickMessage

      public void setKickMessage(@NotNull String message)
      Sets the kick message to display if getResult() != Result.ALLOWED
      Parameters:
      message - New kick message

    • getHostname

      @NotNull public String 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

      public void disallow(@NotNull PlayerLoginEvent.Result result, @NotNull String message)
      Disallows the player from logging in, with the given reason
      Parameters:
      result - New result for disallowing the player
      message - Kick message to display to the user

    • getAddress

      @NotNull public InetAddress getAddress()
      Gets the InetAddress 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.

    • getHandlers

      @NotNull public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static HandlerList getHandlerList()