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

Interface BiomeModificationContext.GenerationSettingsContext

Enclosing interface:
BiomeModificationContext
public static interface BiomeModificationContext.GenerationSettingsContext

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    addBuiltInCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.world.gen.carver.ConfiguredCarver<?> configuredCarver)
    Adds a configured carver from BuiltinRegistries.CONFIGURED_CARVER to this biome.
    default void
    addBuiltInFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.world.gen.feature.ConfiguredFeature<?,​?> configuredFeature)
    Adds a configured feature from BuiltinRegistries.CONFIGURED_FEATURE to this biome.
    default void
    addBuiltInStructure​(net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?> configuredStructure)
    Allows a configured structure from BuiltinRegistries.CONFIGURED_STRUCTURE_FEATURE to start in this biome.
    void
    addCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.carver.ConfiguredCarver<?>> carverKey)
    Adds a configured carver to one of this biomes generation steps.
    void
    addFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredFeature<?,​?>> configuredFeatureKey)
    Adds a feature to one of this biomes generation steps, identified by the configured feature's registry key.
    void
    addStructure​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?>> configuredStructureKey)
    Allows a configured structure to start in this biome.
    default boolean
    removeBuiltInCarver​(net.minecraft.world.gen.carver.ConfiguredCarver<?> configuredCarver)
    removeCarver(RegistryKey) for built-in carvers (see addBuiltInCarver(GenerationStep.Carver, ConfiguredCarver)).
    default boolean
    removeBuiltInCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.world.gen.carver.ConfiguredCarver<?> configuredCarver)
    removeCarver(GenerationStep.Carver, RegistryKey) for built-in carvers (see addBuiltInCarver(GenerationStep.Carver, ConfiguredCarver)).
    default boolean
    removeBuiltInFeature​(net.minecraft.world.gen.feature.ConfiguredFeature<?,​?> configuredFeature)
    removeFeature(RegistryKey) for built-in features (see addBuiltInFeature(GenerationStep.Feature, ConfiguredFeature)).
    default boolean
    removeBuiltInFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.world.gen.feature.ConfiguredFeature<?,​?> configuredFeature)
    removeFeature(GenerationStep.Feature, RegistryKey) for built-in features (see addBuiltInFeature(GenerationStep.Feature, ConfiguredFeature)).
    default boolean
    removeBuiltInStructure​(net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?> configuredStructure)
    removeStructure(RegistryKey) for built-in structures (see addBuiltInStructure(ConfiguredStructureFeature)).
    default boolean
    removeCarver​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.carver.ConfiguredCarver<?>> configuredCarverKey)
    Removes all carvers with the given key from all of this biomes generation steps.
    boolean
    removeCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.carver.ConfiguredCarver<?>> configuredCarverKey)
    Removes all carvers with the given key from one of this biomes generation steps.
    default boolean
    removeFeature​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredFeature<?,​?>> configuredFeatureKey)
    Removes a feature from all of this biomes generation steps, and returns if any features were removed.
    boolean
    removeFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredFeature<?,​?>> configuredFeatureKey)
    Removes a feature from one of this biomes generation steps, and returns if any features were removed.
    boolean
    removeStructure​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?>> configuredStructureKey)
    Removes a configured structure from the structures that are allowed to start in this biome.
    boolean
    removeStructure​(net.minecraft.world.gen.feature.StructureFeature<?> structure)
    Removes a structure from the structures that are allowed to start in this biome.
    default void
    setBuiltInSurfaceBuilder​(net.minecraft.world.gen.surfacebuilder.ConfiguredSurfaceBuilder<?> configuredSurfaceBuilder)
    Sets the biomes surface builder to a surface builder registered in BuiltinRegistries.CONFIGURED_SURFACE_BUILDER.
    void
    setSurfaceBuilder​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.surfacebuilder.ConfiguredSurfaceBuilder<?>> surfaceBuilderKey)
    Sets the biomes surface builder to the surface builder identified by the given key.

  • Method Details

    • setBuiltInSurfaceBuilder

      default void setBuiltInSurfaceBuilder​(net.minecraft.world.gen.surfacebuilder.ConfiguredSurfaceBuilder<?> configuredSurfaceBuilder)
      Sets the biomes surface builder to a surface builder registered in BuiltinRegistries.CONFIGURED_SURFACE_BUILDER.

      This method is intended for use with the surface builders found in ConfiguredSurfaceBuilders.

      NOTE: In case the configured surface builder is overridden in a datapack, the datapacks version will be used.

    • setSurfaceBuilder

      void setSurfaceBuilder​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.surfacebuilder.ConfiguredSurfaceBuilder<?>> surfaceBuilderKey)
      Sets the biomes surface builder to the surface builder identified by the given key.

    • removeFeature

      boolean removeFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredFeature<?,​?>> configuredFeatureKey)
      Removes a feature from one of this biomes generation steps, and returns if any features were removed.

    • removeFeature

      default boolean removeFeature​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredFeature<?,​?>> configuredFeatureKey)
      Removes a feature from all of this biomes generation steps, and returns if any features were removed.

    • removeBuiltInFeature

      default boolean removeBuiltInFeature​(net.minecraft.world.gen.feature.ConfiguredFeature<?,​?> configuredFeature)
      removeFeature(RegistryKey) for built-in features (see addBuiltInFeature(GenerationStep.Feature, ConfiguredFeature)).

    • removeBuiltInFeature

      default boolean removeBuiltInFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.world.gen.feature.ConfiguredFeature<?,​?> configuredFeature)
      removeFeature(GenerationStep.Feature, RegistryKey) for built-in features (see addBuiltInFeature(GenerationStep.Feature, ConfiguredFeature)).

    • addFeature

      void addFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredFeature<?,​?>> configuredFeatureKey)
      Adds a feature to one of this biomes generation steps, identified by the configured feature's registry key.

    • addBuiltInFeature

      default void addBuiltInFeature​(net.minecraft.world.gen.GenerationStep.Feature step, net.minecraft.world.gen.feature.ConfiguredFeature<?,​?> configuredFeature)
      Adds a configured feature from BuiltinRegistries.CONFIGURED_FEATURE to this biome.

      This method is intended for use with the configured features found in ConfiguredFeatures.

      NOTE: In case the configured feature is overridden in a datapack, the datapacks version will be used.

    • addCarver

      void addCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.carver.ConfiguredCarver<?>> carverKey)
      Adds a configured carver to one of this biomes generation steps.

    • addBuiltInCarver

      default void addBuiltInCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.world.gen.carver.ConfiguredCarver<?> configuredCarver)
      Adds a configured carver from BuiltinRegistries.CONFIGURED_CARVER to this biome.

      This method is intended for use with the configured carvers found in ConfiguredCarvers.

      NOTE: In case the configured carver is overridden in a datapack, the datapacks version will be used.

    • removeCarver

      boolean removeCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.carver.ConfiguredCarver<?>> configuredCarverKey)
      Removes all carvers with the given key from one of this biomes generation steps.
      Returns:
      True if any carvers were removed.

    • removeCarver

      default boolean removeCarver​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.carver.ConfiguredCarver<?>> configuredCarverKey)
      Removes all carvers with the given key from all of this biomes generation steps.
      Returns:
      True if any carvers were removed.

    • removeBuiltInCarver

      default boolean removeBuiltInCarver​(net.minecraft.world.gen.carver.ConfiguredCarver<?> configuredCarver)
      removeCarver(RegistryKey) for built-in carvers (see addBuiltInCarver(GenerationStep.Carver, ConfiguredCarver)).

    • removeBuiltInCarver

      default boolean removeBuiltInCarver​(net.minecraft.world.gen.GenerationStep.Carver step, net.minecraft.world.gen.carver.ConfiguredCarver<?> configuredCarver)
      removeCarver(GenerationStep.Carver, RegistryKey) for built-in carvers (see addBuiltInCarver(GenerationStep.Carver, ConfiguredCarver)).

    • addStructure

      void addStructure​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?>> configuredStructureKey)
      Allows a configured structure to start in this biome.

      Structures added this way may start in this biome, with respect to the StructureConfig set in the ChunkGenerator, but structure pieces can always generate in chunks adjacent to a started structure, regardless of biome.

      Configured structures that have the same underlying StructureFeature as the given structure will be removed before adding the new structure, since only one of them could actually generate.

      See Also:
      GenerationSettings.Builder.structureFeature(ConfiguredStructureFeature)

    • addBuiltInStructure

      default void addBuiltInStructure​(net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?> configuredStructure)
      Allows a configured structure from BuiltinRegistries.CONFIGURED_STRUCTURE_FEATURE to start in this biome.

      This method is intended for use with the configured structures found in ConfiguredStructureFeatures.

      NOTE: In case the configured structure is overridden using a datapack, the definition from the datapack will be added to the biome.

      Structures added this way may start in this biome, with respect to the StructureConfig set in the ChunkGenerator, but structure pieces can always generate in chunks adjacent to a started structure, regardless of biome.

      Configured structures that have the same underlying StructureFeature as the given structure will be removed before adding the new structure, since only one of them could actually generate.

    • removeStructure

      boolean removeStructure​(net.minecraft.util.registry.RegistryKey<net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?>> configuredStructureKey)
      Removes a configured structure from the structures that are allowed to start in this biome.

      Please see the note on addStructure(RegistryKey) about structures pieces still generating if adjacent biomes allow the structure to start.

      Returns:
      True if any structures were removed.

    • removeStructure

      boolean removeStructure​(net.minecraft.world.gen.feature.StructureFeature<?> structure)
      Removes a structure from the structures that are allowed to start in this biome.

      This will remove all configured variations of the given structure from this biome.

      This can be used with modded structures or Vanilla structures from StructureFeature.

      Returns:
      True if any structures were removed.

    • removeBuiltInStructure

      default boolean removeBuiltInStructure​(net.minecraft.world.gen.feature.ConfiguredStructureFeature<?,​?> configuredStructure)
      removeStructure(RegistryKey) for built-in structures (see addBuiltInStructure(ConfiguredStructureFeature)).