Package com.seibel.distanthorizons.api.enums

Enum Class EDhApiDetailLevel

java.lang.Object
java.lang.Enum<EDhApiDetailLevel>
com.seibel.distanthorizons.api.enums.EDhApiDetailLevel
All Implemented Interfaces:
Serializable, Comparable<EDhApiDetailLevel>, Constable
public enum EDhApiDetailLevel extends Enum<EDhApiDetailLevel>
BLOCK - Detail Level: 0, width 1 block,
CHUNK - Detail Level: 4, width 16 block,
REGION - Detail Level: 9, width 512 block

Detail levels in Distant Horizons represent how large a LOD is, with the smallest being 0 (1 block wide).
The width of a detail level can be calculated by putting the detail level to the power of 2.
Example for the chunk detail level (4): 2^4 = 16 blocks wide

This enum doesn't contain all valid detail levels, only those most likely to be needed. Detail levels 1,2,3, ... 255 are all technically valid detail levels (although anything beyond REGION may be difficult deal with).
Since:
API 1.0.0

  • Enum Constant Details

    • BLOCK

      public static final EDhApiDetailLevel BLOCK
      detail level: 0
      width in Blocks: 1

    • CHUNK

      public static final EDhApiDetailLevel CHUNK
      detail level: 4
      width in Blocks: 16

    • REGION

      public static final EDhApiDetailLevel REGION
      detail level: 9
      width in Blocks: 512

  • Field Details

    • detailLevel

      public final byte detailLevel

    • widthInBlocks

      public final byte widthInBlocks

  • Method Details

    • values

      public static EDhApiDetailLevel[] 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 EDhApiDetailLevel 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