Package net.minecraftforge.common.world
Record Class ForgeBiomeModifiers.RemoveFeaturesBiomeModifier
java.lang.Object
java.lang.Record
net.minecraftforge.common.world.ForgeBiomeModifiers.RemoveFeaturesBiomeModifier
- Record Components:
biomes
- Biomes to remove features from.features
- PlacedFeatures to remove from biomes.steps
- Decoration steps to remove features from.
- All Implemented Interfaces:
BiomeModifier
- Enclosing class:
ForgeBiomeModifiers
public static record ForgeBiomeModifiers.RemoveFeaturesBiomeModifier(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features, Set<GenerationStep.Decoration> steps)
extends Record
implements BiomeModifier
Stock biome modifier that removes features from biomes. Has the following json format:
{ "type": "forge:removefeatures", // 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 "steps": "underground_ores" OR ["underground_ores", "vegetal_decoration"] // one or more decoration steps; optional field, defaults to all steps if not specified }
-
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.MapCodec
<ForgeBiomeModifiers.RemoveFeaturesBiomeModifier> private final HolderSet
<PlacedFeature> The field for thefeatures
record component.private final Set
<GenerationStep.Decoration> The field for thesteps
record component.Fields inherited from interface net.minecraftforge.common.world.BiomeModifier
DIRECT_CODEC, LIST_CODEC, REFERENCE_CODEC
-
Constructor Summary
ConstructorDescriptionRemoveFeaturesBiomeModifier
(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features, Set<GenerationStep.Decoration> steps) Creates an instance of aRemoveFeaturesBiomeModifier
record class. -
Method Summary
Modifier and TypeMethodDescriptionallSteps
(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features) Creates a modifier that removes the given features from all decoration steps in the given biomes.biomes()
Returns the value of thebiomes
record component.com.mojang.serialization.MapCodec
<? 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.steps()
Returns the value of thesteps
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. -
steps
The field for thesteps
record component. -
CODEC
public static final com.mojang.serialization.MapCodec<ForgeBiomeModifiers.RemoveFeaturesBiomeModifier> CODEC
-
-
Constructor Details
-
RemoveFeaturesBiomeModifier
public RemoveFeaturesBiomeModifier(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features, Set<GenerationStep.Decoration> steps) Creates an instance of aRemoveFeaturesBiomeModifier
record class.
-
-
Method Details
-
allSteps
public static ForgeBiomeModifiers.RemoveFeaturesBiomeModifier allSteps(HolderSet<Biome> biomes, HolderSet<PlacedFeature> features) Creates a modifier that removes the given features from all decoration steps in the given biomes.- Parameters:
biomes
- Biomes to remove features from.features
- PlacedFeatures to remove from biomes.
-
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
-
steps
Returns the value of thesteps
record component.- Returns:
- the value of the
steps
record component
-