Package org.bukkit.event.player

Enum PlayerLoginEvent.Result

java.lang.Object
java.lang.Enum<PlayerLoginEvent.Result>
org.bukkit.event.player.PlayerLoginEvent.Result
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PlayerLoginEvent.Result>, java.lang.constant.Constable
Enclosing class:
PlayerLoginEvent
public static enum PlayerLoginEvent.Result
extends java.lang.Enum<PlayerLoginEvent.Result>
Basic kick reasons for communicating to plugins

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static PlayerLoginEvent.Result[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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