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

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  PlayerLoginEvent.Result
    Basic kick reasons for communicating to plugins

  • Field Summary

    Fields inherited from class org.bukkit.event.player.PlayerEvent

    player

  • Constructor Summary

    Constructors 
    Constructor Description
    PlayerLoginEvent​(Player player)
    Deprecated.
    Address should be provided in other constructor
    PlayerLoginEvent​(Player player, java.lang.String hostname)
    Deprecated.
    Address should be provided in other constructor
    PlayerLoginEvent​(Player player, java.lang.String hostname, java.net.InetAddress address)  
    PlayerLoginEvent​(Player player, java.lang.String hostname, java.net.InetAddress address, java.net.InetAddress realAddress)
    This constructor defaults message to an empty string, and result to ALLOWED
    PlayerLoginEvent​(Player player, java.lang.String hostname, java.net.InetAddress address, PlayerLoginEvent.Result result, java.lang.String message, java.net.InetAddress realAddress)
    This constructor pre-configures the event with a result and message
    PlayerLoginEvent​(Player player, PlayerLoginEvent.Result result, java.lang.String message)
    Deprecated.
    Address and hostname should be provided in other constructor

  • Method Summary

    Modifier and Type Method Description
    void allow()
    Allows the player to log in
    void disallow​(PlayerLoginEvent.Result result, java.lang.String message)
    Disallows the player from logging in, with the given reason
    java.net.InetAddress getAddress()
    Gets the InetAddress for the Player associated with this event.
    static HandlerList getHandlerList()  
    HandlerList getHandlers()  
    java.lang.String getHostname()
    Gets the hostname that the player used to connect to the server, or blank if unknown
    java.lang.String getKickMessage()
    Gets the current kick message that will be used if getResult() != Result.ALLOWED
    java.net.InetAddress getRealAddress()
    Gets the connection address of this player, regardless of whether it has been spoofed or not.
    PlayerLoginEvent.Result getResult()
    Gets the current result of the login, as an enum
    void setKickMessage​(java.lang.String message)
    Sets the kick message to display if getResult() != Result.ALLOWED
    void setResult​(PlayerLoginEvent.Result result)
    Sets the new result of the login, as an enum

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    getPlayer

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PlayerLoginEvent

      @Deprecated public PlayerLoginEvent​(Player player)
      Deprecated.
      Address should be provided in other constructor
      Parameters:
      player - The Player for this event

    • PlayerLoginEvent

      @Deprecated public PlayerLoginEvent​(Player player, java.lang.String hostname)
      Deprecated.
      Address should be provided in other constructor
      Parameters:
      player - The Player for this event
      hostname - The hostname that was used to connect to the server

    • PlayerLoginEvent

      public PlayerLoginEvent​(Player player, java.lang.String hostname, java.net.InetAddress address, java.net.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

    • PlayerLoginEvent

      public PlayerLoginEvent​(Player player, java.lang.String hostname, java.net.InetAddress address)

    • PlayerLoginEvent

      @Deprecated public PlayerLoginEvent​(Player player, PlayerLoginEvent.Result result, java.lang.String message)
      Deprecated.
      Address and hostname should be provided in other constructor
      Parameters:
      player - The Player for this event
      result - The result status for this event
      message - The message to be displayed if result denies login

    • PlayerLoginEvent

      public PlayerLoginEvent​(Player player, java.lang.String hostname, java.net.InetAddress address, PlayerLoginEvent.Result result, java.lang.String message, java.net.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

  • Method Details

    • getRealAddress

      public java.net.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

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

    • setResult

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

    • getKickMessage

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

    • setKickMessage

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

    • getHostname

      public java.lang.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​(PlayerLoginEvent.Result result, java.lang.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

      public java.net.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

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

    • getHandlerList

      public static HandlerList getHandlerList()