Package org.bukkit

Enum World.Environment

java.lang.Object
java.lang.Enum<World.Environment>
org.bukkit.World.Environment
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<World.Environment>, java.lang.constant.Constable
Enclosing interface:
World

public static enum World.Environment
extends java.lang.Enum<World.Environment>
Represents various map environment types that a world may be
  • 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
    NETHER
    Represents a nether based map ("hell")
    NORMAL
    Represents the "normal"/"surface world" map
    THE_END
    Represents the "end" map
  • Method Summary

    Modifier and Type Method Description
    static World.Environment getEnvironment​(int id)
    Deprecated.
    Magic value
    int getId()
    Deprecated.
    Magic value
    static World.Environment valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static World.Environment[] 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 World.Environment[] 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 World.Environment 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
    • getId

      @Deprecated public int getId()
      Deprecated.
      Magic value
      Gets the dimension ID of this environment
      Returns:
      dimension ID
    • getEnvironment

      @Deprecated public static World.Environment getEnvironment​(int id)
      Deprecated.
      Magic value
      Get an environment by ID
      Parameters:
      id - The ID of the environment
      Returns:
      The environment