Package com.fastasyncworldedit.core.extent.processor.heightmap

Enum Class HeightMapType

java.lang.Object
java.lang.Enum<HeightMapType>
com.fastasyncworldedit.core.extent.processor.heightmap.HeightMapType
All Implemented Interfaces:
Serializable, Comparable<HeightMapType>, Constable
public enum HeightMapType extends Enum<HeightMapType>
This enum represents the different types of height maps available in minecraft.

Heightmaps are used to describe the highest position for given (x, z) coordinates. What's considered as highest position depends on the height map type and the blocks at that column. The highest position is a max(y + 1) such that the block at (x, y, z) is included by the height map type.

  • Enum Constant Details

    • MOTION_BLOCKING

      public static final HeightMapType MOTION_BLOCKING

    • MOTION_BLOCKING_NO_LEAVES

      public static final HeightMapType MOTION_BLOCKING_NO_LEAVES

    • OCEAN_FLOOR

      public static final HeightMapType OCEAN_FLOOR

    • WORLD_SURFACE

      public static final HeightMapType WORLD_SURFACE

  • Method Details

    • values

      public static HeightMapType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HeightMapType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • includes

      public abstract boolean includes(BlockState state)
      Returns whether the given block state is included by this height map.
      Parameters:
      state - the block state to check.
      Returns:
      true if the block is included.