Package com.cryptomorin.xseries

Enum XBiome

java.lang.Object

java.lang.Enum<XBiome>

com.cryptomorin.xseries.XBiome

All Implemented Interfaces:

Serializable, Comparable<XBiome>

public enum XBiome
extends Enum<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

Version:

5.1.0

Author:

Crypto Morin

See Also:

Biome

Enum Constant Summary

Enum Constants

Enum Constant	Description
BADLANDS
BADLANDS_PLATEAU
BAMBOO_JUNGLE
BAMBOO_JUNGLE_HILLS
BASALT_DELTAS
BEACH
BIRCH_FOREST
BIRCH_FOREST_HILLS
COLD_OCEAN
CRIMSON_FOREST
DARK_FOREST
DARK_FOREST_HILLS
DEEP_COLD_OCEAN
DEEP_FROZEN_OCEAN
DEEP_LUKEWARM_OCEAN
DEEP_OCEAN
DEEP_WARM_OCEAN
DESERT
DESERT_HILLS
DESERT_LAKES
DRIPSTONE_CAVES
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
GRAVELLY_MOUNTAINS
ICE_SPIKES
JUNGLE
JUNGLE_EDGE
JUNGLE_HILLS
LUKEWARM_OCEAN
LUSH_CAVES
MODIFIED_BADLANDS_PLATEAU
MODIFIED_GRAVELLY_MOUNTAINS
MODIFIED_JUNGLE
MODIFIED_JUNGLE_EDGE
MODIFIED_WOODED_BADLANDS_PLATEAU
MOUNTAIN_EDGE
MOUNTAINS
MUSHROOM_FIELD_SHORE
MUSHROOM_FIELDS
NETHER_WASTES
OCEAN
PLAINS
RIVER
SAVANNA
SAVANNA_PLATEAU
SHATTERED_SAVANNA
SHATTERED_SAVANNA_PLATEAU
SMALL_END_ISLANDS
SNOWY_BEACH
SNOWY_MOUNTAINS
SNOWY_TAIGA
SNOWY_TAIGA_HILLS
SNOWY_TAIGA_MOUNTAINS
SNOWY_TUNDRA
SOUL_SAND_VALLEY
STONE_SHORE
SUNFLOWER_PLAINS
SWAMP
SWAMP_HILLS
TAIGA
TAIGA_HILLS
TAIGA_MOUNTAINS
TALL_BIRCH_FOREST
TALL_BIRCH_HILLS
THE_END
THE_VOID
WARM_OCEAN
WARPED_FOREST
WOODED_BADLANDS_PLATEAU
WOODED_HILLS
WOODED_MOUNTAINS

Field Summary

Fields

Modifier and Type	Field	Description
static XBiome[]	VALUES	A cached unmodifiable list of values() to avoid allocating memory for

Method Summary

Modifier and Type	Method	Description
org.bukkit.block.Biome	getBiome()	Parses the XBiome as a Biome based on the server version.
org.bukkit.World.Environment	getEnvironment()	Gets the enviroment (world type) which this biome originally belongs to.
static Optional<XBiome>	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.
CompletableFuture<Void>	setBiome(org.bukkit.Chunk chunk)	Sets the biome of the chunk.
CompletableFuture<Void>	setBiome(org.bukkit.Location start, org.bukkit.Location end)	Change the biome in the selected region.
static XBiome	valueOf(String name)	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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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

GRAVELLY_MOUNTAINS

public static final XBiome GRAVELLY_MOUNTAINS

ICE_SPIKES

public static final XBiome ICE_SPIKES

JUNGLE

public static final XBiome JUNGLE

JUNGLE_EDGE

public static final XBiome JUNGLE_EDGE

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

MOUNTAINS

public static final XBiome MOUNTAINS

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

public static final XBiome SHATTERED_SAVANNA

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

SNOWY_TUNDRA

public static final XBiome SNOWY_TUNDRA

STONE_SHORE

public static final XBiome STONE_SHORE

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

TALL_BIRCH_FOREST

public static final XBiome TALL_BIRCH_FOREST

TALL_BIRCH_HILLS

public static final XBiome TALL_BIRCH_HILLS

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

Field Detail

VALUES

public static final XBiome[] VALUES

A cached unmodifiable list of values() to avoid allocating memory for

Since:

1.0.0

Method Detail

values

public static XBiome[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (XBiome c : XBiome.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static XBiome valueOf(String name)

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 name

NullPointerException - if the argument is null

matchXBiome

@Nonnull
public static Optional<XBiome> matchXBiome(@Nonnull
                                           String biome)

Parses the XBiome with the given name.

Parameters:

biome - the name of the biome.

Returns:

a matched XBiome.

Since:

1.0.0

matchXBiome

@Nonnull
public static XBiome matchXBiome(@Nonnull
                                 org.bukkit.block.Biome biome)

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

@Nonnull
public org.bukkit.World.Environment getEnvironment()

Gets the enviroment (world type) which this biome originally belongs to.

Returns:

the enviroment that this biome belongs to.

Since:

4.0.0

getBiome

@Nullable
public org.bukkit.block.Biome getBiome()

Parses the XBiome as a Biome based on the server version.

Returns:

the vanilla biome.

Since:

1.0.0

setBiome

@Nonnull
public CompletableFuture<Void> setBiome(@Nonnull
                                        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

@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