Package com.cryptomorin.xseries

Class XBiome

java.lang.Object
com.cryptomorin.xseries.base.XModule<XBiome,org.bukkit.block.Biome>
com.cryptomorin.xseries.XBiome
All Implemented Interfaces:
XBase<XBiome,org.bukkit.block.Biome>
public final class XBiome extends XModule<XBiome,org.bukkit.block.Biome>
XBiome - Cross-version support for biome names.
Biomes: https://minecraft.wiki/w/Biome Biome: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html

The ordering of this enum class matters and should not be changed due to 1.18 removed biomes issue.

Version:
7.0.0
Author:
Crypto Morin
See Also:
  • Biome

  • Field Details

    • REGISTRY

      public static final XRegistry<XBiome,org.bukkit.block.Biome> REGISTRY

    • WINDSWEPT_HILLS

      public static final XBiome WINDSWEPT_HILLS

    • SNOWY_PLAINS

      public static final XBiome SNOWY_PLAINS

    • SPARSE_JUNGLE

      public static final XBiome SPARSE_JUNGLE

    • STONY_SHORE

      public static final XBiome STONY_SHORE

    • CHERRY_GROVE

      public static final XBiome CHERRY_GROVE

    • PALE_GARDEN

      public static final XBiome PALE_GARDEN

    • OLD_GROWTH_PINE_TAIGA

      public static final XBiome OLD_GROWTH_PINE_TAIGA

    • WINDSWEPT_FOREST

      public static final XBiome WINDSWEPT_FOREST

    • WOODED_BADLANDS

      public static final XBiome WOODED_BADLANDS

    • WINDSWEPT_GRAVELLY_HILLS

      public static final XBiome WINDSWEPT_GRAVELLY_HILLS

    • OLD_GROWTH_BIRCH_FOREST

      public static final XBiome OLD_GROWTH_BIRCH_FOREST

    • OLD_GROWTH_SPRUCE_TAIGA

      public static final XBiome OLD_GROWTH_SPRUCE_TAIGA

    • WINDSWEPT_SAVANNA

      public static final XBiome WINDSWEPT_SAVANNA

    • MEADOW

      public static final XBiome MEADOW

    • MANGROVE_SWAMP

      public static final XBiome MANGROVE_SWAMP

    • DEEP_DARK

      public static final XBiome DEEP_DARK

    • GROVE

      public static final XBiome GROVE

    • SNOWY_SLOPES

      public static final XBiome SNOWY_SLOPES

    • FROZEN_PEAKS

      public static final XBiome FROZEN_PEAKS

    • JAGGED_PEAKS

      public static final XBiome JAGGED_PEAKS

    • STONY_PEAKS

      public static final XBiome STONY_PEAKS

    • BADLANDS

      public static final XBiome BADLANDS

    • BADLANDS_PLATEAU

      public static final XBiome BADLANDS_PLATEAU

    • BEACH

      public static final XBiome BEACH

    • BIRCH_FOREST

      public static final XBiome BIRCH_FOREST

    • BIRCH_FOREST_HILLS

      public static final XBiome BIRCH_FOREST_HILLS

    • COLD_OCEAN

      public static final XBiome COLD_OCEAN

    • DARK_FOREST

      public static final XBiome DARK_FOREST

    • DARK_FOREST_HILLS

      public static final XBiome DARK_FOREST_HILLS

    • DEEP_COLD_OCEAN

      public static final XBiome DEEP_COLD_OCEAN

    • DEEP_FROZEN_OCEAN

      public static final XBiome DEEP_FROZEN_OCEAN

    • DEEP_LUKEWARM_OCEAN

      public static final XBiome DEEP_LUKEWARM_OCEAN

    • DEEP_OCEAN

      public static final XBiome DEEP_OCEAN

    • DEEP_WARM_OCEAN

      public static final XBiome DEEP_WARM_OCEAN

    • DESERT

      public static final XBiome DESERT

    • DESERT_HILLS

      public static final XBiome DESERT_HILLS

    • DESERT_LAKES

      public static final XBiome DESERT_LAKES

    • END_BARRENS

      public static final XBiome END_BARRENS

    • END_HIGHLANDS

      public static final XBiome END_HIGHLANDS

    • END_MIDLANDS

      public static final XBiome END_MIDLANDS

    • ERODED_BADLANDS

      public static final XBiome ERODED_BADLANDS

    • FLOWER_FOREST

      public static final XBiome FLOWER_FOREST

    • FOREST

      public static final XBiome FOREST

    • FROZEN_OCEAN

      public static final XBiome FROZEN_OCEAN

    • FROZEN_RIVER

      public static final XBiome FROZEN_RIVER

    • GIANT_SPRUCE_TAIGA

      public static final XBiome GIANT_SPRUCE_TAIGA

    • GIANT_SPRUCE_TAIGA_HILLS

      public static final XBiome GIANT_SPRUCE_TAIGA_HILLS

    • GIANT_TREE_TAIGA

      public static final XBiome GIANT_TREE_TAIGA

    • GIANT_TREE_TAIGA_HILLS

      public static final XBiome GIANT_TREE_TAIGA_HILLS

    • ICE_SPIKES

      public static final XBiome ICE_SPIKES

    • JUNGLE

      public static final XBiome JUNGLE

    • JUNGLE_HILLS

      public static final XBiome JUNGLE_HILLS

    • LUKEWARM_OCEAN

      public static final XBiome LUKEWARM_OCEAN

    • MODIFIED_BADLANDS_PLATEAU

      public static final XBiome MODIFIED_BADLANDS_PLATEAU

    • MODIFIED_GRAVELLY_MOUNTAINS

      public static final XBiome MODIFIED_GRAVELLY_MOUNTAINS

    • MODIFIED_JUNGLE

      public static final XBiome MODIFIED_JUNGLE

    • MODIFIED_JUNGLE_EDGE

      public static final XBiome MODIFIED_JUNGLE_EDGE

    • MODIFIED_WOODED_BADLANDS_PLATEAU

      public static final XBiome MODIFIED_WOODED_BADLANDS_PLATEAU

    • MOUNTAIN_EDGE

      public static final XBiome MOUNTAIN_EDGE

    • MUSHROOM_FIELDS

      public static final XBiome MUSHROOM_FIELDS

    • MUSHROOM_FIELD_SHORE

      public static final XBiome MUSHROOM_FIELD_SHORE

    • SOUL_SAND_VALLEY

      public static final XBiome SOUL_SAND_VALLEY

    • CRIMSON_FOREST

      public static final XBiome CRIMSON_FOREST

    • WARPED_FOREST

      public static final XBiome WARPED_FOREST

    • BASALT_DELTAS

      public static final XBiome BASALT_DELTAS

    • NETHER_WASTES

      public static final XBiome NETHER_WASTES

    • OCEAN

      public static final XBiome OCEAN

    • PLAINS

      public static final XBiome PLAINS

    • RIVER

      public static final XBiome RIVER

    • SAVANNA

      public static final XBiome SAVANNA

    • SAVANNA_PLATEAU

      public static final XBiome SAVANNA_PLATEAU

    • SHATTERED_SAVANNA_PLATEAU

      public static final XBiome SHATTERED_SAVANNA_PLATEAU

    • SMALL_END_ISLANDS

      public static final XBiome SMALL_END_ISLANDS

    • SNOWY_BEACH

      public static final XBiome SNOWY_BEACH

    • SNOWY_MOUNTAINS

      public static final XBiome SNOWY_MOUNTAINS

    • SNOWY_TAIGA

      public static final XBiome SNOWY_TAIGA

    • SNOWY_TAIGA_HILLS

      public static final XBiome SNOWY_TAIGA_HILLS

    • SNOWY_TAIGA_MOUNTAINS

      public static final XBiome SNOWY_TAIGA_MOUNTAINS

    • SUNFLOWER_PLAINS

      public static final XBiome SUNFLOWER_PLAINS

    • SWAMP

      public static final XBiome SWAMP

    • SWAMP_HILLS

      public static final XBiome SWAMP_HILLS

    • TAIGA

      public static final XBiome TAIGA

    • TAIGA_HILLS

      public static final XBiome TAIGA_HILLS

    • TAIGA_MOUNTAINS

      public static final XBiome TAIGA_MOUNTAINS

    • CUSTOM

      @XInfo(since="1.21.3", removedSince="1.21.3") public static final XBiome CUSTOM
      Why add it in the first place if it was removed in a few builds?

    • TALL_BIRCH_FOREST

      public static final XBiome TALL_BIRCH_FOREST
      Removed from 1.18

    • TALL_BIRCH_HILLS

      public static final XBiome TALL_BIRCH_HILLS
      Removed from 1.18

    • THE_END

      public static final XBiome THE_END

    • THE_VOID

      public static final XBiome THE_VOID

    • WARM_OCEAN

      public static final XBiome WARM_OCEAN

    • WOODED_BADLANDS_PLATEAU

      public static final XBiome WOODED_BADLANDS_PLATEAU

    • WOODED_HILLS

      public static final XBiome WOODED_HILLS

    • WOODED_MOUNTAINS

      public static final XBiome WOODED_MOUNTAINS

    • BAMBOO_JUNGLE

      public static final XBiome BAMBOO_JUNGLE

    • BAMBOO_JUNGLE_HILLS

      public static final XBiome BAMBOO_JUNGLE_HILLS

    • DRIPSTONE_CAVES

      public static final XBiome DRIPSTONE_CAVES

    • LUSH_CAVES

      public static final XBiome LUSH_CAVES

  • Constructor Details

    • XBiome

      public XBiome(org.bukkit.World.Environment environment, org.bukkit.block.Biome biome, String[] names)

  • Method Details

    • getEnvironment

      public Optional<org.bukkit.World.Environment> getEnvironment()
      Gets the environment (world type) which this biome originally belongs to. If the biome is non-standard (registered by another program) this will return Optional.empty().
      Returns:
      the environment that this biome belongs to.
      Since:
      4.0.0

    • getBiome

      @Nullable @Deprecated public @Nullable org.bukkit.block.Biome getBiome()
      Deprecated.
      use XModule.get() instead.
      Parses the XBiome as a Biome based on the server version.
      Returns:
      the vanilla biome.
      Since:
      1.0.0

    • setBiome

      @NotNull public @NotNull CompletableFuture<Void> setBiome(@NotNull @NotNull org.bukkit.Chunk chunk)
      Sets the biome of the chunk. If the chunk is not generated/loaded already, it'll be generated and loaded. Note that this doesn't send any update packets to the nearby clients.
      Parameters:
      chunk - the chunk to change the biome.
      Returns:
      the async task handling this operation.
      Since:
      1.0.0

    • setBiome

      @NotNull public @NotNull CompletableFuture<Void> setBiome(@NotNull @NotNull org.bukkit.Location start, @NotNull @NotNull org.bukkit.Location end)
      Change the biome in the selected region. Unloaded chunks will be ignored. Note that this doesn't send any update packets to the nearby clients.
      Parameters:
      start - the start position.
      end - the end position.
      Since:
      1.0.0

    • of

      @NotNull public static @NotNull XBiome of(@NotNull @NotNull org.bukkit.block.Biome biome)

    • of

      public static Optional<XBiome> of(@NotNull @NotNull String biome)

    • values

      @Deprecated public static XBiome[] values()
      Deprecated.
      Use getValues() instead.

    • getValues

      @NotNull public static @NotNull @Unmodifiable Collection<XBiome> getValues()