Package com.cryptomorin.xseries
Enum XBiome
- All Implemented Interfaces:
Serializable
,Comparable<XBiome>
XBiome - Cross-version support for biome names.
Biomes: https://minecraft.gamepedia.com/Biome Biome: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/Biome.html
Biomes: https://minecraft.gamepedia.com/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:
- 6.1.0
- Author:
- Crypto Morin
- See Also:
-
Biome
-
Enum Constant Summary
Enum ConstantDescriptionRemoved from 1.18Removed from 1.18 -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionorg.bukkit.block.Biome
getBiome()
Parses the XBiome as aBiome
based on the server version.org.bukkit.World.Environment
Gets the environment (world type) which this biome originally belongs to.matchXBiome
(String biome) Parses the XBiome with the given name.static XBiome
matchXBiome
(org.bukkit.block.Biome biome) Parses the XBiome with the given bukkit biome.setBiome
(org.bukkit.Chunk chunk) Sets the biome of the chunk.setBiome
(org.bukkit.Location start, org.bukkit.Location end) Change the biome in the selected region.static XBiome
Returns the enum constant of this type with the specified name.static XBiome[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
WINDSWEPT_HILLS
-
SNOWY_PLAINS
-
SPARSE_JUNGLE
-
STONY_SHORE
-
OLD_GROWTH_PINE_TAIGA
-
WINDSWEPT_FOREST
-
WOODED_BADLANDS
-
WINDSWEPT_GRAVELLY_HILLS
-
OLD_GROWTH_BIRCH_FOREST
-
OLD_GROWTH_SPRUCE_TAIGA
-
WINDSWEPT_SAVANNA
-
MEADOW
-
MANGROVE_SWAMP
-
DEEP_DARK
-
GROVE
-
SNOWY_SLOPES
-
FROZEN_PEAKS
-
JAGGED_PEAKS
-
STONY_PEAKS
-
CUSTOM
-
BADLANDS
-
BADLANDS_PLATEAU
-
BEACH
-
BIRCH_FOREST
-
BIRCH_FOREST_HILLS
-
COLD_OCEAN
-
DARK_FOREST
-
DARK_FOREST_HILLS
-
DEEP_COLD_OCEAN
-
DEEP_FROZEN_OCEAN
-
DEEP_LUKEWARM_OCEAN
-
DEEP_OCEAN
-
DEEP_WARM_OCEAN
-
DESERT
-
DESERT_HILLS
-
DESERT_LAKES
-
END_BARRENS
-
END_HIGHLANDS
-
END_MIDLANDS
-
ERODED_BADLANDS
-
FLOWER_FOREST
-
FOREST
-
FROZEN_OCEAN
-
FROZEN_RIVER
-
GIANT_SPRUCE_TAIGA
-
GIANT_SPRUCE_TAIGA_HILLS
-
GIANT_TREE_TAIGA
-
GIANT_TREE_TAIGA_HILLS
-
ICE_SPIKES
-
JUNGLE
-
JUNGLE_HILLS
-
LUKEWARM_OCEAN
-
MODIFIED_BADLANDS_PLATEAU
-
MODIFIED_GRAVELLY_MOUNTAINS
-
MODIFIED_JUNGLE
-
MODIFIED_JUNGLE_EDGE
-
MODIFIED_WOODED_BADLANDS_PLATEAU
-
MOUNTAIN_EDGE
-
MUSHROOM_FIELDS
-
MUSHROOM_FIELD_SHORE
-
SOUL_SAND_VALLEY
-
CRIMSON_FOREST
-
WARPED_FOREST
-
BASALT_DELTAS
-
NETHER_WASTES
-
OCEAN
-
PLAINS
-
RIVER
-
SAVANNA
-
SAVANNA_PLATEAU
-
SHATTERED_SAVANNA_PLATEAU
-
SMALL_END_ISLANDS
-
SNOWY_BEACH
-
SNOWY_MOUNTAINS
-
SNOWY_TAIGA
-
SNOWY_TAIGA_HILLS
-
SNOWY_TAIGA_MOUNTAINS
-
SUNFLOWER_PLAINS
-
SWAMP
-
SWAMP_HILLS
-
TAIGA
-
TAIGA_HILLS
-
TAIGA_MOUNTAINS
-
TALL_BIRCH_FOREST
Removed from 1.18 -
TALL_BIRCH_HILLS
Removed from 1.18 -
THE_END
-
THE_VOID
-
WARM_OCEAN
-
WOODED_BADLANDS_PLATEAU
-
WOODED_HILLS
-
WOODED_MOUNTAINS
-
BAMBOO_JUNGLE
-
BAMBOO_JUNGLE_HILLS
-
DRIPSTONE_CAVES
-
LUSH_CAVES
-
-
Field Details
-
VALUES
A cached unmodifiable list ofvalues()
to avoid allocating memory for- Since:
- 1.0.0
-
-
Method Details
-
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
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
matchXBiome
Parses the XBiome with the given name.- Parameters:
biome
- the name of the biome.- Returns:
- a matched XBiome.
- Since:
- 1.0.0
-
matchXBiome
Parses the XBiome with the given bukkit biome.- Parameters:
biome
- the Bukkit biome.- Returns:
- a matched biome.
- Throws:
IllegalArgumentException
- may be thrown as an unexpected exception.- Since:
- 1.0.0
-
getEnvironment
Gets the environment (world type) which this biome originally belongs to.- Returns:
- the environment that this biome belongs to.
- Since:
- 4.0.0
-
getBiome
Parses the XBiome as aBiome
based on the server version.- Returns:
- the vanilla biome.
- Since:
- 1.0.0
-
setBiome
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
@Nonnull public CompletableFuture<Void> setBiome(@Nonnull org.bukkit.Location start, @Nonnull 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
-