Interface RandomSpreadFoliagePlacer

All Superinterfaces:

FoliagePlacer, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface RandomSpreadFoliagePlacer
extends FoliagePlacer

Randomly spreads foliage within the given radius and height, used by trees such as the mangrove.

Since:

3.0.0

See Also:

• Tree definition (Foliage placer)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RandomSpreadFoliagePlacer.Builder	Builder for RandomSpreadFoliagePlacer.

Nested classes/interfaces inherited from interface FoliagePlacer

FoliagePlacer.FoliagePlacerBuilder<T,P>

Method Summary

Modifier and Type	Method	Description
static RandomSpreadFoliagePlacer.Builder	builder()	Creates a new builder.
IntProvider	foliageHeight()	The foliage's height, between 1 and 512 (inclusive).
int	leafPlacementAttempts()	The number of leaf placement attempts, between 0 and 256 (inclusive).
static RandomSpreadFoliagePlacer	of(IntProvider radius, IntProvider offset, IntProvider foliageHeight, int leafPlacementAttempts)	Creates a new random spread foliage placer.
default RandomSpreadFoliagePlacer.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface FoliagePlacer

offset, radius

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

foliageHeight

@AsOf("3.0.0")
IntProvider foliageHeight()

The foliage's height, between 1 and 512 (inclusive).

Returns:

the foliage height

Since:

3.0.0

leafPlacementAttempts

@AsOf("3.0.0")
int leafPlacementAttempts()

The number of leaf placement attempts, between 0 and 256 (inclusive).

Returns:

the number of leaf placement attempts

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default RandomSpreadFoliagePlacer.Builder toBuilder()

Converts this object back to a builder.

Returns:

a builder with the same values as this object

Since:

3.0.0

of

@AsOf("3.0.0")
static RandomSpreadFoliagePlacer of(IntProvider radius,
 IntProvider offset,
 IntProvider foliageHeight,
 int leafPlacementAttempts)

Creates a new random spread foliage placer.

Parameters:

radius - the radius of the foliage

offset - the vertical offset from the top of the trunk to the top of the foliage

foliageHeight - the foliage's height, between 1 and 512 (inclusive)

leafPlacementAttempts - the number of leaf placement attempts, between 0 and 256 (inclusive)

Returns:

a new random spread foliage placer

Since:

3.0.0

builder

@AsOf("3.0.0")
static RandomSpreadFoliagePlacer.Builder builder()

Creates a new builder.

Returns:

a new builder

Since:

3.0.0