Package io.github.vampirestudios.vampirelib.api

Class BiomeDictionary.Type

java.lang.Object

io.github.vampirestudios.vampirelib.api.BiomeDictionary.Type

Enclosing class:

BiomeDictionary

public static final class BiomeDictionary.Type
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final BiomeDictionary.Type	BEACH
static final BiomeDictionary.Type	COLD
static final BiomeDictionary.Type	CONIFEROUS
static final BiomeDictionary.Type	DEAD
static final BiomeDictionary.Type	DENSE
static final BiomeDictionary.Type	DRY
static final BiomeDictionary.Type	END
static final BiomeDictionary.Type	FOREST
static final BiomeDictionary.Type	HILLS
static final BiomeDictionary.Type	HOT
static final BiomeDictionary.Type	JUNGLE
static final BiomeDictionary.Type	LUSH
static final BiomeDictionary.Type	MAGICAL
static final BiomeDictionary.Type	MESA
static final BiomeDictionary.Type	MODIFIED
static final BiomeDictionary.Type	MOUNTAIN
static final BiomeDictionary.Type	MUSHROOM
static final BiomeDictionary.Type	NETHER
static final BiomeDictionary.Type	OCEAN
static final BiomeDictionary.Type	OVERWORLD
static final BiomeDictionary.Type	PEAK
static final BiomeDictionary.Type	PLAINS
static final BiomeDictionary.Type	PLATEAU
static final BiomeDictionary.Type	RARE
static final BiomeDictionary.Type	RIVER
static final BiomeDictionary.Type	SANDY
static final BiomeDictionary.Type	SAVANNA
static final BiomeDictionary.Type	SLOPE
static final BiomeDictionary.Type	SNOWY
static final BiomeDictionary.Type	SPARSE
static final BiomeDictionary.Type	SPOOKY
static final BiomeDictionary.Type	SWAMP
static final BiomeDictionary.Type	UNDERGROUND
static final BiomeDictionary.Type	VOID
static final BiomeDictionary.Type	WASTELAND
static final BiomeDictionary.Type	WATER	A general tag for all water-based biomes.
static final BiomeDictionary.Type	WET

Method Summary

Modifier and Type	Method	Description
static Collection<BiomeDictionary.Type>	getAll()
String	getName()	Gets the name for this type.
static BiomeDictionary.Type	getType(String name, BiomeDictionary.Type... subTypes)	Retrieves a Type instance by name, if one does not exist already it creates one.
static boolean	hasType(String name)	Checks if a type instance exists for a given name.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

HOT

public static final BiomeDictionary.Type HOT

COLD

public static final BiomeDictionary.Type COLD

SPARSE

public static final BiomeDictionary.Type SPARSE

DENSE

public static final BiomeDictionary.Type DENSE

WET

public static final BiomeDictionary.Type WET

DRY

public static final BiomeDictionary.Type DRY

SAVANNA

public static final BiomeDictionary.Type SAVANNA

CONIFEROUS

public static final BiomeDictionary.Type CONIFEROUS

JUNGLE

public static final BiomeDictionary.Type JUNGLE

SPOOKY

public static final BiomeDictionary.Type SPOOKY

DEAD

public static final BiomeDictionary.Type DEAD

LUSH

public static final BiomeDictionary.Type LUSH

MUSHROOM

public static final BiomeDictionary.Type MUSHROOM

MAGICAL

public static final BiomeDictionary.Type MAGICAL

RARE

public static final BiomeDictionary.Type RARE

PLATEAU

public static final BiomeDictionary.Type PLATEAU

MODIFIED

public static final BiomeDictionary.Type MODIFIED

OCEAN

public static final BiomeDictionary.Type OCEAN

RIVER

public static final BiomeDictionary.Type RIVER

WATER

public static final BiomeDictionary.Type WATER

A general tag for all water-based biomes. Shown as present if OCEAN or RIVER are.

MESA

public static final BiomeDictionary.Type MESA

FOREST

public static final BiomeDictionary.Type FOREST

PLAINS

public static final BiomeDictionary.Type PLAINS

HILLS

public static final BiomeDictionary.Type HILLS

SWAMP

public static final BiomeDictionary.Type SWAMP

SANDY

public static final BiomeDictionary.Type SANDY

SNOWY

public static final BiomeDictionary.Type SNOWY

WASTELAND

public static final BiomeDictionary.Type WASTELAND

BEACH

public static final BiomeDictionary.Type BEACH

VOID

public static final BiomeDictionary.Type VOID

UNDERGROUND

public static final BiomeDictionary.Type UNDERGROUND

PEAK

public static final BiomeDictionary.Type PEAK

SLOPE

public static final BiomeDictionary.Type SLOPE

MOUNTAIN

public static final BiomeDictionary.Type MOUNTAIN

OVERWORLD

public static final BiomeDictionary.Type OVERWORLD

NETHER

public static final BiomeDictionary.Type NETHER

END

public static final BiomeDictionary.Type END

Method Details

getName

public String getName()

Gets the name for this type.

toString

public String toString()

Overrides:

toString in class Object

getType

public static BiomeDictionary.Type getType(String name,
 BiomeDictionary.Type... subTypes)

Retrieves a Type instance by name, if one does not exist already it creates one. This can be used as intermediate measure for modders to add their own Biome types.

There are no naming conventions besides:

• Must be all upper case (enforced by name.toUpper())
• No Special characters. {Unenforced, just don't be a pain, if it becomes a issue I WILL make this RTE with no worry about backwards compatibility}

Note: For performance sake, the return value of this function SHOULD be cached. Two calls with the same name SHOULD return the same value.

Parameters:

name - The name of this Type

Returns:

An instance of Type for this name.

hasType

public static boolean hasType(String name)

Checks if a type instance exists for a given name. Does not have any side effects if a type does not already exist. This can be used for checking if a user-defined type is valid, for example, in a codec which accepts biome dictionary names.

Parameters:

name - The name.

Returns:

true if a type exists with this name.

See Also:

• #getType for type naming conventions.

getAll

public static Collection<BiomeDictionary.Type> getAll()

Returns:

An unmodifiable collection of all current biome types.