gekkit/org.bukkit.event.player/AsyncPlayerPreLoginEvent

AsyncPlayerPreLoginEvent

public class AsyncPlayerPreLoginEvent extends Event

Stores details for players attempting to log in.

This event is asynchronous, and not run using main thread.

Constructors

public void AsyncPlayerPreLoginEvent(String name, InetAddress ipAddress, UUID uniqueId)

Types

Result

public enum Result

Basic kick reasons for communicating to plugins

Properties

handlers

public final static HandlerList handlers

name

public final String name

uniqueId

public final UUID uniqueId

Functions

allow

public void allow()

Allows the player to log in

disallow

public void disallow(AsyncPlayerPreLoginEvent.Result result, String message)

Disallows the player from logging in, with the given reason

getAddress

public InetAddress getAddress()

Gets the player IP address.

getEventName

public String getEventName()

Convenience method for providing getClassById user-friendly identifier.

getHandlerList

public static HandlerList getHandlerList()

getHandlers

public HandlerList getHandlers()

getKickMessage

public String getKickMessage()

Gets the current kick message that will be used if getResult() != Result.

getLoginResult

public AsyncPlayerPreLoginEvent.Result getLoginResult()

Gets the current result of the login, as an enum

getName

public String getName()

Gets the player's name.

getUniqueId

public UUID getUniqueId()

Gets the player's unique ID.

isAsynchronous

public final boolean isAsynchronous()

Any custom event that should not by synchronized with other events must use the specific constructor.

setKickMessage

public void setKickMessage(String message)

Sets the kick message to display if getResult() != Result.

setLoginResult

public void setLoginResult(AsyncPlayerPreLoginEvent.Result result)

Sets the new result of the login, as an enum