Interface VegetationPatchConfiguration

All Superinterfaces:
FeatureConfiguration, Wrapper
@NullMarked @AsOf("3.0.1") public interface VegetationPatchConfiguration extends FeatureConfiguration
A feature that places a patch of ground blocks, then a vegetation feature on top, searching either up from a floor or down from a ceiling. Used by vanilla for lush cave floors and dripleaf patches.
Since:
3.0.1
See Also:

  • Method Details

    • replaceable

      @AsOf("3.1.0") TagSet<Material> replaceable()
      The blocks that the patch is allowed to replace.
      Returns:
      the replaceable materials
      Since:
      3.1.0

    • groundState

      @AsOf("3.0.1") BlockStateProvider groundState()
      The block used to build the patch (the "ground").
      Returns:
      the ground state provider
      Since:
      3.0.1

    • vegetationFeature

      @AsOf("3.0.1") PlacedFeature vegetationFeature()
      The placed feature to place on top of each found position.
      Returns:
      the vegetation feature
      Since:
      3.0.1

    • surface

      @AsOf("3.0.1") CaveSurface surface()
      Which surface to search from and place against, either CaveSurface.FLOOR or CaveSurface.CEILING.
      Returns:
      the surface
      Since:
      3.0.1

    • depth

      @AsOf("3.0.1") IntProvider depth()
      The number of blocks the patch replaces per column, between 1 and 128.
      Returns:
      the depth
      Since:
      3.0.1

    • extraBottomBlockChance

      @AsOf("3.0.1") float extraBottomBlockChance()
      The chance to add one extra block to the depth() of a column, between 0.0 and 1.0.
      Returns:
      the extra bottom block chance
      Since:
      3.0.1

    • verticalRange

      @AsOf("3.0.1") int verticalRange()
      The vertical distance a column searches for an available position, between 1 and 256.
      Returns:
      the vertical range
      Since:
      3.0.1

    • vegetationChance

      @AsOf("3.0.1") float vegetationChance()
      The chance of placing the vegetationFeature() on a found position, between 0.0 and 1.0.
      Returns:
      the vegetation chance
      Since:
      3.0.1

    • xzRadius

      @AsOf("3.0.1") IntProvider xzRadius()
      The XZ radius searched for available positions. The x and z radii are sampled independently from this provider.
      Returns:
      the xz radius
      Since:
      3.0.1

    • extraEdgeColumnChance

      @AsOf("3.0.1") float extraEdgeColumnChance()
      The chance to add a search position adjacent to the initial rectangle, between 0.0 and 1.0.
      Returns:
      the extra edge column chance
      Since:
      3.0.1

    • toBuilder

      @AsOf("3.0.1") default VegetationPatchConfiguration.Builder toBuilder()
      Converts this object back to a builder.
      Returns:
      a new builder with the same values as this object
      Since:
      3.0.1

    • of

      @AsOf("3.0.1") static VegetationPatchConfiguration of(TagSet<Material> replaceable, BlockStateProvider groundState, PlacedFeature vegetationFeature, CaveSurface surface, IntProvider depth, float extraBottomBlockChance, int verticalRange, float vegetationChance, IntProvider xzRadius, float extraEdgeColumnChance)
      Creates a new vegetation patch configuration.
      Parameters:
      replaceable - the blocks that the patch is allowed to replace
      groundState - the block used to build the patch
      vegetationFeature - the placed feature to place on top of each found position
      surface - which surface to search from and place against
      depth - the number of blocks the patch replaces per column
      extraBottomBlockChance - the chance to add one extra block to the depth of a column
      verticalRange - the vertical distance a column searches for an available position
      vegetationChance - the chance of placing the vegetation feature on a found position
      xzRadius - the XZ radius searched for available positions
      extraEdgeColumnChance - the chance to add a search position adjacent to the initial rectangle
      Returns:
      a new vegetation patch configuration
      Since:
      3.0.1

    • builder

      @AsOf("3.0.1") static VegetationPatchConfiguration.Builder builder()
      Creates a new builder.
      Returns:
      a new builder
      Since:
      3.0.1