Package net.fabricmc.fabric.api.biome.v1

Enum Class ModificationPhase

java.lang.Object

java.lang.Enum<ModificationPhase>

net.fabricmc.fabric.api.biome.v1.ModificationPhase

All Implemented Interfaces:

Serializable, Comparable<ModificationPhase>, java.lang.constant.Constable

public enum ModificationPhase
extends Enum<ModificationPhase>

To achieve a predictable order for biome modifiers, and to aid with mod compatibility, modifiers need to declare the phase in which they will be applied.

This will result in the following order:

1. Additions to biomes
2. Removals from biomes
3. Replacements (removal + add) in biomes
4. Generic post-processing of biomes

Experimental feature, may be removed or changed without further notice.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDITIONS	The appropriate phase for enriching biomes by adding to them without relying on other information in the biome, or removing other features.
POST_PROCESSING	The appropriate phase for modifiers that perform wide-reaching biome postprocessing.
REMOVALS	The appropriate phase for modifiers that remove features or other aspects of biomes (i.e.
REPLACEMENTS	The appropriate phase for modifiers that replace existing features with modified features.

Method Summary

Modifier and Type	Method	Description
static ModificationPhase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ModificationPhase[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADDITIONS

public static final ModificationPhase ADDITIONS

The appropriate phase for enriching biomes by adding to them without relying on other information in the biome, or removing other features.

Examples: New ores, new vegetation, new structures

REMOVALS

public static final ModificationPhase REMOVALS

The appropriate phase for modifiers that remove features or other aspects of biomes (i.e. removal of spawns, removal of features, etc.).

Examples: Remove iron ore from plains, remove ghasts

REPLACEMENTS

public static final ModificationPhase REPLACEMENTS

The appropriate phase for modifiers that replace existing features with modified features.

Examples: Replace mineshafts with biome-specific mineshafts

POST_PROCESSING

public static final ModificationPhase POST_PROCESSING

The appropriate phase for modifiers that perform wide-reaching biome postprocessing.

Examples: Mods that allow modpack authors to customize world generation, changing biome properties (i.e. category) that other mods rely on.

Method Details

values

public static ModificationPhase[] 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 ModificationPhase 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