Interface AttachedToLeavesDecorator

All Superinterfaces:

TreeDecorator, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface AttachedToLeavesDecorator
extends TreeDecorator

Attaches blocks to exposed faces of all foliage blocks in specified directions.

Since:

3.0.0

See Also:

• Tree definition (Decorator)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
BlockStateProvider	blockProvider()	The block of the decoration.
static AttachedToLeavesDecorator.Builder	builder()	Creates a new builder.
List<BlockFace>	directions()	The directions to generate.
int	exclusionRadiusXZ()	The minimum horizontal distance between two decorations, between 0 and 16 (inclusive).
int	exclusionRadiusY()	The minimum vertical distance between two decorations, between 0 and 16 (inclusive).
static AttachedToLeavesDecorator	of(float probability, int exclusionRadiusXZ, int exclusionRadiusY, BlockStateProvider blockProvider, int requiredEmptyBlocks, List<BlockFace> directions)	Creates a new attached to leaves decorator.
float	probability()	The probability of attaching a block, between 0.0F and 1.0F (inclusive).
int	requiredEmptyBlocks()	The number of empty blocks required by the decoration, between 0 and 16 (inclusive).
default AttachedToLeavesDecorator.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

probability

@AsOf("3.0.0")
float probability()

The probability of attaching a block, between 0.0F and 1.0F (inclusive).

Returns:

the probability

Since:

3.0.0

exclusionRadiusXZ

@AsOf("3.0.0")
int exclusionRadiusXZ()

The minimum horizontal distance between two decorations, between 0 and 16 (inclusive).

Returns:

the horizontal exclusion radius

Since:

3.0.0

exclusionRadiusY

@AsOf("3.0.0")
int exclusionRadiusY()

The minimum vertical distance between two decorations, between 0 and 16 (inclusive).

Returns:

the vertical exclusion radius

Since:

3.0.0

blockProvider

@AsOf("3.0.0")
BlockStateProvider blockProvider()

The block of the decoration.

Returns:

the block state provider

Since:

3.0.0

requiredEmptyBlocks

@AsOf("3.0.0")
int requiredEmptyBlocks()

The number of empty blocks required by the decoration, between 0 and 16 (inclusive).

Returns:

the number of required empty blocks

Since:

3.0.0

directions

@AsOf("3.0.0")
List<BlockFace> directions()

The directions to generate. Cannot be empty.

Returns:

the directions

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default AttachedToLeavesDecorator.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 AttachedToLeavesDecorator of(float probability,
 int exclusionRadiusXZ,
 int exclusionRadiusY,
 BlockStateProvider blockProvider,
 int requiredEmptyBlocks,
 List<BlockFace> directions)

Creates a new attached to leaves decorator.

Parameters:

probability - the probability of attaching a block, between 0.0F and 1.0F (inclusive)

exclusionRadiusXZ - the minimum horizontal distance between two decorations, between 0 and 16 (inclusive)

exclusionRadiusY - the minimum vertical distance between two decorations, between 0 and 16 (inclusive)

blockProvider - the block of the decoration

requiredEmptyBlocks - the number of empty blocks required by the decoration, between 0 and 16 (inclusive)

directions - the directions to generate, cannot be empty

Returns:

a new attached to leaves decorator

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0