Package org.bukkit.event.player

Class PlayerPreLoginEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerPreLoginEvent
@Deprecated
public class PlayerPreLoginEvent
extends Event
Deprecated.
This event causes synchronization from the login thread; AsyncPlayerPreLoginEvent is preferred to keep the secondary threads asynchronous.
Stores details for players attempting to log in

  • Nested Class Summary

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

  • Constructor Summary

    Constructors 
    Constructor Description
    PlayerPreLoginEvent​(java.lang.String name, java.net.InetAddress ipAddress)
    Deprecated.
    PlayerPreLoginEvent​(java.lang.String name, java.net.InetAddress ipAddress, java.util.UUID uniqueId)
    Deprecated.
     

  • Method Summary

    Modifier and Type Method Description
    void allow()
    Deprecated.
    Allows the player to log in
    void disallow​(PlayerPreLoginEvent.Result result, java.lang.String message)
    Deprecated.
    Disallows the player from logging in, with the given reason
    java.net.InetAddress getAddress()
    Deprecated.
    Gets the player IP address.
    static HandlerList getHandlerList()
    Deprecated.
     
    HandlerList getHandlers()
    Deprecated.
     
    java.lang.String getKickMessage()
    Deprecated.
    Gets the current kick message that will be used if getResult() != Result.ALLOWED
    java.lang.String getName()
    Deprecated.
    Gets the player's name.
    PlayerPreLoginEvent.Result getResult()
    Deprecated.
    Gets the current result of the login, as an enum
    java.util.UUID getUniqueId()
    Deprecated.
    Gets the player's unique ID.
    void setKickMessage​(java.lang.String message)
    Deprecated.
    Sets the kick message to display if getResult() != Result.ALLOWED
    void setResult​(PlayerPreLoginEvent.Result result)
    Deprecated.
    Sets the new result of the login, as an enum

    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

    • PlayerPreLoginEvent

      @Deprecated public PlayerPreLoginEvent​(java.lang.String name, java.net.InetAddress ipAddress)
      Deprecated.

    • PlayerPreLoginEvent

      public PlayerPreLoginEvent​(java.lang.String name, java.net.InetAddress ipAddress, java.util.UUID uniqueId)
      Deprecated.

  • Method Details

    • getResult

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

    • setResult

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

    • getKickMessage

      public java.lang.String getKickMessage()
      Deprecated.
      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)
      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

      public void disallow​(PlayerPreLoginEvent.Result result, java.lang.String message)
      Deprecated.
      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

    • getName

      public java.lang.String getName()
      Deprecated.
      Gets the player's name.
      Returns:
      the player's name

    • getAddress

      public java.net.InetAddress getAddress()
      Deprecated.
      Gets the player IP address.
      Returns:
      The IP address

    • getHandlers

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

    • getUniqueId

      public java.util.UUID getUniqueId()
      Deprecated.
      Gets the player's unique ID.
      Returns:
      The unique ID

    • getHandlerList

      public static HandlerList getHandlerList()
      Deprecated.