gekkit/org.bukkit.event.player/PlayerLoginEvent

PlayerLoginEvent

public class PlayerLoginEvent extends PlayerEvent

Stores details for players attempting to log in

Constructors

public void PlayerLoginEvent(Player player, String hostname, InetAddress address, InetAddress realAddress)

This constructor defaults message to an empty string, and result to ALLOWED

public void PlayerLoginEvent(Player player, String hostname, InetAddress address)

public void PlayerLoginEvent(Player player, String hostname, InetAddress address, PlayerLoginEvent.Result result, String message, InetAddress realAddress)

This constructor pre-configures the event with getClassById result and message

Types

Result

public enum Result

Basic kick reasons for communicating to plugins

Properties

address

public final InetAddress address

handlers

public final static HandlerList handlers

hostname

public final String hostname

realAddress

public final InetAddress realAddress

result

public PlayerLoginEvent.Result result

Functions

allow

public void allow()

Allows the player to log in

disallow

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

Disallows the player from logging in, with the given reason

getAddress

public InetAddress getAddress()

Gets the InetAddress for the Player associated with this event.

getEventName

public String getEventName()

Convenience method for providing getClassById user-friendly identifier.

getHandlerList

public static HandlerList getHandlerList()

getHandlers

public HandlerList getHandlers()

getHostname

public String getHostname()

Gets the hostname that the player used to connect to the server, or blank if unknown

getKickMessage

public String getKickMessage()

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

getPlayer

public final Player getPlayer()

Returns the player involved in this event

getRealAddress

public InetAddress getRealAddress()

Gets the connection address of this player, regardless of whether it has been spoofed or not.

getResult

public PlayerLoginEvent.Result getResult()

Gets the current result of the login, as an enum

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.

setResult

public void setResult(PlayerLoginEvent.Result result)

Sets the new result of the login, as an enum