Interface CaveWorldCarver

All Superinterfaces:
CarverConfiguration, Wrapper

@NullMarked @AsOf("4.0.0") public interface CaveWorldCarver extends CarverConfiguration
A direct Minecraft cave world carver.
Since:
4.0.0
See Also:
  • Method Details

    • count

      @AsOf("4.0.0") IntProvider count()
      The number of cave tunnels attempted by the carver.
      Returns:
      the cave tunnel count
      Since:
      4.0.0
    • thickness

      @AsOf("4.0.0") FloatProvider thickness()
      The base thickness of each cave tunnel.
      Returns:
      the cave tunnel thickness
      Since:
      4.0.0
    • weirdThicknessBias

      @AsOf("4.0.0") boolean weirdThicknessBias()
      Whether the carver applies Minecraft's biased thickness calculation.
      Returns:
      whether the thickness calculation is biased
      Since:
      4.0.0
    • roomVerticalRadiusMultiplier

      @AsOf("4.0.0") FloatProvider roomVerticalRadiusMultiplier()
      The vertical radius multiplier used for cave rooms.
      Returns:
      the room vertical radius multiplier
      Since:
      4.0.0
    • horizontalRadiusMultiplier

      @AsOf("4.0.0") FloatProvider horizontalRadiusMultiplier()
      The horizontal radius multiplier used for cave tunnels.
      Returns:
      the horizontal radius multiplier
      Since:
      4.0.0
    • verticalRadiusMultiplier

      @AsOf("4.0.0") FloatProvider verticalRadiusMultiplier()
      The vertical radius multiplier used for cave tunnels.
      Returns:
      the vertical radius multiplier
      Since:
      4.0.0
    • startVerticalRadiusMultiplier

      @AsOf("4.0.0") FloatProvider startVerticalRadiusMultiplier()
      The vertical radius multiplier used at the start of a cave tunnel.
      Returns:
      the starting vertical radius multiplier
      Since:
      4.0.0
    • floorLevel

      @AsOf("4.0.0") FloatProvider floorLevel()
      The relative floor level below which the cave is not carved.
      Returns:
      the cave floor level
      Since:
      4.0.0
    • toBuilder

      @AsOf("4.0.0") default CaveWorldCarver.Builder toBuilder()
      Converts this cave carver back to a builder.
      Returns:
      a builder containing this carver's values
      Since:
      4.0.0
    • of

      @AsOf("4.0.0") static CaveWorldCarver of(float probability, HeightProvider y, IntProvider count, FloatProvider thickness, boolean weirdThicknessBias, FloatProvider roomVerticalRadiusMultiplier, FloatProvider horizontalRadiusMultiplier, FloatProvider verticalRadiusMultiplier, FloatProvider startVerticalRadiusMultiplier, FloatProvider floorLevel)
      Creates a cave world carver.
      Parameters:
      probability - the probability that the carver starts in an eligible chunk
      y - the provider used to select the starting y-coordinate
      count - the number of cave tunnels attempted
      thickness - the base thickness of each cave tunnel
      weirdThicknessBias - whether to apply the biased thickness calculation
      roomVerticalRadiusMultiplier - the vertical radius multiplier for cave rooms
      horizontalRadiusMultiplier - the horizontal radius multiplier for cave tunnels
      verticalRadiusMultiplier - the vertical radius multiplier for cave tunnels
      startVerticalRadiusMultiplier - the vertical radius multiplier at the start of a tunnel
      floorLevel - the relative floor level below which the cave is not carved
      Returns:
      a new cave world carver
      Since:
      4.0.0
    • builder

      @AsOf("4.0.0") static CaveWorldCarver.Builder builder()
      Creates a new cave world carver builder.
      Returns:
      a new builder
      Since:
      4.0.0