org.bukkit.event.player
Enum PlayerLoginEvent.Result

java.lang.Object
  extended by java.lang.Enum<PlayerLoginEvent.Result>
      extended by org.bukkit.event.player.PlayerLoginEvent.Result
All Implemented Interfaces:
Serializable, Comparable<PlayerLoginEvent.Result>
Enclosing class:
PlayerLoginEvent

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

Basic kick reasons for communicating to plugins


Enum Constant Summary
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
static PlayerLoginEvent.Result valueOf(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're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, 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 final PlayerLoginEvent.Result[] values()
Returns an array containing the constants of this enum type, in the order they're 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're declared

valueOf

public static PlayerLoginEvent.Result valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name


Copyright © 2013. All Rights Reserved.