Package org.bukkit.event.player

Class PlayerPreLoginEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerPreLoginEvent

Deprecated.

This event causes synchronization from the login thread; AsyncPlayerPreLoginEvent is preferred to keep the secondary threads asynchronous.

@Deprecated
public class PlayerPreLoginEvent
extends Event

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(String name, InetAddress ipAddress)	Deprecated.
PlayerPreLoginEvent(String name, InetAddress ipAddress, UUID uniqueId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	allow()	Deprecated. Allows the player to log in
void	disallow(PlayerPreLoginEvent.Result result, String message)	Deprecated. Disallows the player from logging in, with the given reason
InetAddress	getAddress()	Deprecated. Gets the player IP address.
static HandlerList	getHandlerList()	Deprecated.
HandlerList	getHandlers()	Deprecated.
String	getKickMessage()	Deprecated. Gets the current kick message that will be used if getResult() != Result.ALLOWED
String	getName()	Deprecated. Gets the player's name.
PlayerPreLoginEvent.Result	getResult()	Deprecated. Gets the current result of the login, as an enum
UUID	getUniqueId()	Deprecated. Gets the player's unique ID.
void	setKickMessage(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 Detail

PlayerPreLoginEvent

@Deprecated
public PlayerPreLoginEvent(@NotNull
                           String name,
                           @NotNull
                           InetAddress ipAddress)

Deprecated.

PlayerPreLoginEvent

public PlayerPreLoginEvent(@NotNull
                           String name,
                           @NotNull
                           InetAddress ipAddress,
                           @NotNull
                           UUID uniqueId)

Deprecated.

Method Detail

getResult

@NotNull
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(@NotNull
                      PlayerPreLoginEvent.Result result)

Deprecated.

Sets the new result of the login, as an enum

Parameters:

result - New result to set

getKickMessage

@NotNull
public String getKickMessage()

Deprecated.

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

Returns:

Current kick message

setKickMessage

public void setKickMessage(@NotNull
                           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(@NotNull
                     PlayerPreLoginEvent.Result result,
                     @NotNull
                     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

@NotNull
public String getName()

Deprecated.

Gets the player's name.

Returns:

the player's name

getAddress

@NotNull
public InetAddress getAddress()

Deprecated.

Gets the player IP address.

Returns:

The IP address

getHandlers

@NotNull
public HandlerList getHandlers()

Deprecated.

Specified by:

getHandlers in class Event

getUniqueId

@NotNull
public UUID getUniqueId()

Deprecated.

Gets the player's unique ID.

Returns:

The unique ID

getHandlerList

@NotNull
public static HandlerList getHandlerList()

Deprecated.