Enum Class GrassColorModifier

java.lang.Object

java.lang.Enum<GrassColorModifier>

dev.wyck.wrapper.environment.GrassColorModifier

All Implemented Interfaces:

WrappedEnumerator<GrassColorModifier>, Serializable, Comparable<GrassColorModifier>, Constable

@NullMarked
@AsOf("0.0.24")
public enum GrassColorModifier
extends Enum<GrassColorModifier>
implements WrappedEnumerator<GrassColorModifier>

This enum represents the grass color modifier for a biome in Minecraft. It includes three values: NONE, SWAMP, and DARK_FOREST, which correspond to the GrassColorModifier values in the BiomeSpecialEffects class in the Minecraft code. Each enum value carries a vanilla key, retrievable via getKey(), which the impl module translates to the underlying NMS value.

Since:

0.0.24

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DARK_FOREST
NONE
SWAMP

Field Summary

Fields

Modifier and Type	Field	Description
static final KeyedEnumTranslator<GrassColorModifier>	TRANSLATOR

Method Summary

Modifier and Type	Method	Description
String	getKey()	Returns the vanilla key for this grass color modifier (e.g.
KeyedEnumTranslator<GrassColorModifier>	translator()
static GrassColorModifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GrassColorModifier[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface WrappedEnumerator

fromNms, toNms, toNms

Enum Constant Details

NONE

public static final GrassColorModifier NONE

SWAMP

public static final GrassColorModifier SWAMP

DARK_FOREST

public static final GrassColorModifier DARK_FOREST

Field Details

TRANSLATOR

public static final KeyedEnumTranslator<GrassColorModifier> TRANSLATOR

Method Details

values

public static GrassColorModifier[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GrassColorModifier valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getKey

@AsOf("0.0.24")
public String getKey()

Returns the vanilla key for this grass color modifier (e.g. "none", "swamp", "dark_forest"). The impl module uses this key to resolve the underlying Minecraft GrassColorModifier value.

Returns:

The vanilla key for this enum value.

translator

public KeyedEnumTranslator<GrassColorModifier> translator()

Specified by:

translator in interface WrappedEnumerator<GrassColorModifier>