Package org.bukkit.event.player

Enum PlayerLoginEvent.Result

java.lang.Object

java.lang.Enum<PlayerLoginEvent.Result>

org.bukkit.event.player.PlayerLoginEvent.Result

Enclosing class:

PlayerLoginEvent

public static enum PlayerLoginEvent.Result
extends java.lang.Enum<PlayerLoginEvent.Result>

Basic kick reasons for communicating to plugins

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOWED	The player is allowed to log in
KICK_BANNED	The player is not allowed to log in, due to them being banned
KICK_FULL	The player is not allowed to log in, due to the server being full
KICK_OTHER	The player is not allowed to log in, for reasons undefined
KICK_WHITELIST	The player is not allowed to log in, due to them not being on the white list

Method Summary

Modifier and Type	Method	Description
static PlayerLoginEvent.Result	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PlayerLoginEvent.Result[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLOWED

public static final PlayerLoginEvent.Result ALLOWED

The player is allowed to log in

KICK_FULL

public static final PlayerLoginEvent.Result KICK_FULL

The player is not allowed to log in, due to the server being full

KICK_BANNED

public static final PlayerLoginEvent.Result KICK_BANNED

The player is not allowed to log in, due to them being banned

KICK_WHITELIST

public static final PlayerLoginEvent.Result KICK_WHITELIST

The player is not allowed to log in, due to them not being on the white list

KICK_OTHER

public static final PlayerLoginEvent.Result KICK_OTHER

The player is not allowed to log in, for reasons undefined

Method Detail

values

public static PlayerLoginEvent.Result[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PlayerLoginEvent.Result c : PlayerLoginEvent.Result.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PlayerLoginEvent.Result valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null