Interface Dimension

All Superinterfaces:
Keyed, Wrapper
All Known Implementing Classes:
DimensionImpl

@NullMarked @AsOf("2.4.0") public interface Dimension extends Keyed, Wrapper
Wraps a minecraft dimension type.
Since:
2.4.0
  • Method Details

    • resourceKey

      @AsOf("2.4.0") ResourceKey resourceKey()
      The key of this dimension type.
      Returns:
      the key of this dimension type.
      Since:
      2.4.0
    • hasFixedTime

      @AsOf("2.4.0") boolean hasFixedTime()
      Whether this dimension type has a fixed time.
      Returns:
      whether this dimension type has a fixed time.
      Since:
      2.4.0
    • hasSkyLight

      @AsOf("2.4.0") boolean hasSkyLight()
      If there should be light that comes from the sky.
      Returns:
      whether this dimension type has sky light.
      Since:
      2.4.0
    • hasCeiling

      @AsOf("2.4.0") boolean hasCeiling()
      Whether this dimension type has a ceiling (e.g., the nether).
      Returns:
      whether this dimension type has a ceiling.
      Since:
      2.4.0
    • hasEnderDragonFight

      @AsOf("2.4.0") boolean hasEnderDragonFight()
      Whether this dimension type has an ender dragon fight.
      Returns:
      whether this dimension type has an ender dragon fight.
      Since:
      2.4.0
    • coordinateScale

      @AsOf("2.4.0") double coordinateScale()
      The coordinate scale of this dimension type.
      Returns:
      the coordinate scale of this dimension type.
      Since:
      2.4.0
    • minY

      @AsOf("2.4.0") int minY()
      The minimum Y of this dimension type.
      Returns:
      the minimum Y of this dimension type.
      Since:
      2.4.0
    • height

      @AsOf("2.4.0") int height()
      The height of this dimension type.
      Returns:
      the height of this dimension type.
      Since:
      2.4.0
    • logicalHeight

      @AsOf("2.4.0") int logicalHeight()
      The logical height of this dimension type.
      Returns:
      the logical height of this dimension type.
      Since:
      2.4.0
    • infiniburn

      @AsOf("2.4.0") Infiniburn infiniburn()
      A tag of blocks that will burn infinitely in this dimension type.
      Returns:
      the infiniburn of this dimension type.
      Since:
      2.4.0
    • ambientLight

      @AsOf("2.4.0") float ambientLight()
      The ambient light of this dimension type.
      Returns:
      the ambient light level of this dimension type.
      Since:
      2.4.0
    • monsterSettings

      @AsOf("2.4.0") MonsterSettings monsterSettings()
      The monster settings of this dimension type.
      Returns:
      the monster settings of this dimension type.
      Since:
      2.4.0
    • skybox

      @AsOf("2.4.0") Skybox skybox()
      The skybox of this dimension type.
      Returns:
      the skybox of this dimension type.
      Since:
      2.4.0
    • cardinalLightType

      @AsOf("2.4.0") CardinalLightType cardinalLightType()
      The cardinal light type of this dimension type.
      Returns:
      the cardinal light type of this dimension type.
      Since:
      2.4.0
    • attributes

      @AsOf("2.4.0") EnvironmentAttributeMap attributes()
      The attributes of this dimension type.
      Returns:
      the attributes of this dimension type.
      Since:
      2.4.0
    • timelines

      @AsOf("2.4.0") TimelineSet timelines()
      The timelines of this dimension type.
      Returns:
      the timelines of this dimension type.
      Since:
      2.4.0
    • defaultClock

      @AsOf("2.4.0") Optional<WorldClock> defaultClock()
      The default clock of this dimension type.
      Returns:
      the default clock of this dimension type.
      Since:
      2.4.0
    • isSimilar

      boolean isSimilar(Dimension other)
      Checks if this dimension type is similar to another.
      Parameters:
      other - the other dimension type to compare to
      Returns:
      whether this dimension type is similar to the other
      Since:
      2.4.0
    • register

      @AsOf("2.4.0") default Dimension register()
      Registers this dimension type to the dimension registry.
      Returns:
      this dimension type
      Since:
      2.4.0
    • modify

      @AsOf("2.4.0") default Dimension modify()
      Modifies this dimension type in the dimension registry.
      Returns:
      this dimension type
      Since:
      2.4.0
    • toBuilder

      @AsOf("2.4.0") default Dimension.Builder toBuilder()
      Creates a new Dimension.Builder with the same properties as this dimension type.
      Returns:
      a new Dimension.Builder with the same properties as this dimension type.
      Since:
      2.4.0
    • builder

      @AsOf("2.4.0") static Dimension.Builder builder()
      Creates a new Dimension.Builder with the given resource key.
      Returns:
      a new Dimension.Builder with the given resource key.
      Since:
      2.4.0
    • builder

      @AsOf("2.4.0") static Dimension.Builder builder(ResourceKey resourceKey)
      Creates a new Dimension.Builder with the given resource key.
      Parameters:
      resourceKey - the resource key to seed the builder with
      Returns:
      a new Dimension.Builder with the given resource key.
      Since:
      2.4.0
    • reference

      @AsOf("2.4.0") static Dimension reference(ResourceKey resourceKey)
      Simply holds a reference to a dimension.
      Parameters:
      resourceKey - the resource key of the dimension
      Returns:
      a new dimension reference
      Since:
      2.4.0