Package net.fabricmc.fabric.api.biome.v1
Enum ModificationPhase
- All Implemented Interfaces:
Serializable
,Comparable<ModificationPhase>
,java.lang.constant.Constable
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:
- Additions to biomes
- Removals from biomes
- Replacements (removal + add) in biomes
- Generic post-processing of biomes
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe appropriate phase for enriching biomes by adding to them without relying on other information in the biome, or removing other features.The appropriate phase for modifiers that perform wide-reaching biome postprocessing.The appropriate phase for modifiers that remove features or other aspects of biomes (i.e.The appropriate phase for modifiers that replace existing features with modified features. -
Method Summary
Modifier and TypeMethodDescriptionstatic ModificationPhase
Returns the enum constant of this type with the specified name.static ModificationPhase[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
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
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
The appropriate phase for modifiers that replace existing features with modified features.Examples: Replace mineshafts with biome-specific mineshafts
-
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
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
-