Package net.minecraftforge.common.world
Record Class ForgeBiomeModifiers.AddFeaturesBiomeModifier
java.lang.Object
java.lang.Record
net.minecraftforge.common.world.ForgeBiomeModifiers.AddFeaturesBiomeModifier
- Record Components:
biomes
- Biomes to add features to.features
- PlacedFeatures to add to biomes.step
- Decoration step to run features in.
- All Implemented Interfaces:
BiomeModifier
- Enclosing class:
- ForgeBiomeModifiers
public static record ForgeBiomeModifiers.AddFeaturesBiomeModifier(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features, GenerationStep.Decoration step)
extends Record
implements BiomeModifier
Stock biome modifier that adds features to biomes. Has the following json format:
{ "type": "forge:add_features", // required "biomes": "#namespace:your_biome_tag" // accepts a biome id, [list of biome ids], or #namespace:biome_tag "features": "namespace:your_feature", // accepts a placed feature id, [list of placed feature ids], or #namespace:feature_tag "step": "underground_ores" // accepts a Decoration enum name }
Be wary of using this to add vanilla PlacedFeatures to biomes, as doing so may cause a feature cycle violation.
-
Nested Class Summary
Nested classes/interfaces inherited from interface net.minecraftforge.common.world.BiomeModifier
BiomeModifier.Phase
-
Field Summary
Modifier and TypeFieldDescriptionThe field for thebiomes
record component.static final com.mojang.serialization.Codec<ForgeBiomeModifiers.AddFeaturesBiomeModifier>
private final HolderSet<PlacedFeature>
The field for thefeatures
record component.private final GenerationStep.Decoration
The field for thestep
record component.Fields inherited from interface net.minecraftforge.common.world.BiomeModifier
DIRECT_CODEC, LIST_CODEC, REFERENCE_CODEC
-
Constructor Summary
ConstructorDescriptionAddFeaturesBiomeModifier
(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features, GenerationStep.Decoration step) Creates an instance of aAddFeaturesBiomeModifier
record class. -
Method Summary
Modifier and TypeMethodDescriptionbiomes()
Returns the value of thebiomes
record component.com.mojang.serialization.Codec<? extends BiomeModifier>
codec()
final boolean
Indicates whether some other object is "equal to" this one.features()
Returns the value of thefeatures
record component.final int
hashCode()
Returns a hash code value for this object.void
modify
(Holder<Biome> biome, BiomeModifier.Phase phase, ModifiableBiomeInfo.BiomeInfo.Builder builder) Modifies the information via the provided biome builder.step()
Returns the value of thestep
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
biomes
The field for thebiomes
record component. -
features
The field for thefeatures
record component. -
step
The field for thestep
record component. -
CODEC
public static final com.mojang.serialization.Codec<ForgeBiomeModifiers.AddFeaturesBiomeModifier> CODEC
-
-
Constructor Details
-
AddFeaturesBiomeModifier
public AddFeaturesBiomeModifier(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features, GenerationStep.Decoration step) Creates an instance of aAddFeaturesBiomeModifier
record class.
-
-
Method Details
-
modify
public void modify(Holder<Biome> biome, BiomeModifier.Phase phase, ModifiableBiomeInfo.BiomeInfo.Builder builder) Description copied from interface:BiomeModifier
Modifies the information via the provided biome builder. Allows mob spawns and world-gen features to be added or removed, and climate and client effects to be modified.- Specified by:
modify
in interfaceBiomeModifier
- Parameters:
biome
- the named biome being modified (with original data readable).phase
- biome modification phase. Biome modifiers apply in each phase in order of the enum constants.builder
- mutable biome info builder. Apply changes to this.
-
codec
- Specified by:
codec
in interfaceBiomeModifier
- Returns:
- the codec which serializes and deserializes this biome modifier
-
toString
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components. -
hashCode
public final int hashCode()Returns a hash code value for this object. The value is derived from the hash code of each of the record components. -
equals
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared withObjects::equals(Object,Object)
. -
biomes
Returns the value of thebiomes
record component.- Returns:
- the value of the
biomes
record component
-
features
Returns the value of thefeatures
record component.- Returns:
- the value of the
features
record component
-
step
Returns the value of thestep
record component.- Returns:
- the value of the
step
record component
-