Interface CherryFoliagePlacer

All Superinterfaces:

FoliagePlacer, Wrapper

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

Places the foliage of a cherry tree, optionally with holes and hanging leaves.

Since:

3.0.0

See Also:

• Tree definition (Foliage placer)

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface FoliagePlacer

FoliagePlacer.FoliagePlacerBuilder<T,P>

Method Summary

Modifier and Type	Method	Description
static CherryFoliagePlacer.Builder	builder()	Creates a new builder.
float	cornerHoleChance()	The probability of a hole in the corners, between 0.0F and 1.0F (inclusive).
float	hangingLeavesChance()	The probability of generating hanging leaves, between 0.0F and 1.0F (inclusive).
float	hangingLeavesExtensionChance()	The probability of extending hanging leaves, between 0.0F and 1.0F (inclusive).
IntProvider	height()	The foliage's height, between 4 and 16 (inclusive).
static CherryFoliagePlacer	of(IntProvider radius, IntProvider offset, IntProvider height, float wideBottomLayerHoleChance, float cornerHoleChance, float hangingLeavesChance, float hangingLeavesExtensionChance)	Creates a new cherry foliage placer.
default CherryFoliagePlacer.Builder	toBuilder()	Converts this object back to a builder.
float	wideBottomLayerHoleChance()	The probability of a hole in the wide bottom layer, between 0.0F and 1.0F (inclusive).

Methods inherited from interface FoliagePlacer

offset, radius

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

height

@AsOf("3.0.0")
IntProvider height()

The foliage's height, between 4 and 16 (inclusive).

Returns:

the height

Since:

3.0.0

wideBottomLayerHoleChance

@AsOf("3.0.0")
float wideBottomLayerHoleChance()

The probability of a hole in the wide bottom layer, between 0.0F and 1.0F (inclusive).

Returns:

the wide bottom layer hole chance

Since:

3.0.0

cornerHoleChance

@AsOf("3.0.0")
float cornerHoleChance()

The probability of a hole in the corners, between 0.0F and 1.0F (inclusive).

Returns:

the corner hole chance

Since:

3.0.0

hangingLeavesChance

@AsOf("3.0.0")
float hangingLeavesChance()

The probability of generating hanging leaves, between 0.0F and 1.0F (inclusive).

Returns:

the hanging leaves chance

Since:

3.0.0

hangingLeavesExtensionChance

@AsOf("3.0.0")
float hangingLeavesExtensionChance()

The probability of extending hanging leaves, between 0.0F and 1.0F (inclusive).

Returns:

the hanging leaves extension chance

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default CherryFoliagePlacer.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 CherryFoliagePlacer of(IntProvider radius,
 IntProvider offset,
 IntProvider height,
 float wideBottomLayerHoleChance,
 float cornerHoleChance,
 float hangingLeavesChance,
 float hangingLeavesExtensionChance)

Creates a new cherry 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

height - the foliage's height, between 4 and 16 (inclusive)

wideBottomLayerHoleChance - the probability of a hole in the wide bottom layer, between 0.0F and 1.0F (inclusive)

cornerHoleChance - the probability of a hole in the corners, between 0.0F and 1.0F (inclusive)

hangingLeavesChance - the probability of generating hanging leaves, between 0.0F and 1.0F (inclusive)

hangingLeavesExtensionChance - the probability of extending hanging leaves, between 0.0F and 1.0F (inclusive)

Returns:

a new cherry foliage placer

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0