Interface MangroveRootPlacement

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("3.0.0")
public interface MangroveRootPlacement
extends Wrapper

The mangrove root placement parameters used by a MangroveRootPlacer.

Since:

3.0.0

See Also:

• Tree definition (Root placer)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MangroveRootPlacement.Builder	builder()	Creates a new builder.
Set<Material>	canGrowThrough()	The blocks that roots can grow through.
int	maxRootLength()	The maximum length of the root, between 1 and 64 (inclusive).
int	maxRootWidth()	The maximum width of the root, between 1 and 12 (inclusive).
Set<Material>	muddyRootsIn()	The blocks in which roots turn into muddy root blocks.
BlockStateProvider	muddyRootsProvider()	The blocks used as muddy roots.
static MangroveRootPlacement	of(Set<Material> canGrowThrough, Set<Material> muddyRootsIn, BlockStateProvider muddyRootsProvider, int maxRootWidth, int maxRootLength)	Creates a new mangrove root placement.
static MangroveRootPlacement	of(Set<Material> canGrowThrough, Set<Material> muddyRootsIn, BlockStateProvider muddyRootsProvider, int maxRootWidth, int maxRootLength, float randomSkewChance)
float	randomSkewChance()	The probability of random skew, between 0.0F and 1.0F (inclusive).
default MangroveRootPlacement.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

canGrowThrough

@AsOf("3.0.0")
Set<Material> canGrowThrough()

The blocks that roots can grow through.

Returns:

the blocks roots can grow through

Since:

3.0.0

muddyRootsIn

@AsOf("3.0.0")
Set<Material> muddyRootsIn()

The blocks in which roots turn into muddy root blocks.

Returns:

the blocks that turn roots muddy

Since:

3.0.0

muddyRootsProvider

@AsOf("3.0.0")
BlockStateProvider muddyRootsProvider()

The blocks used as muddy roots.

Returns:

the muddy roots block state provider

Since:

3.0.0

maxRootWidth

@AsOf("3.0.0")
int maxRootWidth()

The maximum width of the root, between 1 and 12 (inclusive).

Returns:

the maximum root width

Since:

3.0.0

maxRootLength

@AsOf("3.0.0")
int maxRootLength()

The maximum length of the root, between 1 and 64 (inclusive).

Returns:

the maximum root length

Since:

3.0.0

randomSkewChance

@AsOf("3.0.0")
float randomSkewChance()

The probability of random skew, between 0.0F and 1.0F (inclusive).

Returns:

the random skew chance

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default MangroveRootPlacement.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 MangroveRootPlacement of(Set<Material> canGrowThrough,
 Set<Material> muddyRootsIn,
 BlockStateProvider muddyRootsProvider,
 int maxRootWidth,
 int maxRootLength)

Creates a new mangrove root placement.

Parameters:

canGrowThrough - the blocks that roots can grow through

muddyRootsIn - the blocks in which roots turn into muddy root blocks

muddyRootsProvider - the blocks used as muddy roots

maxRootWidth - the maximum width of the root, between 1 and 12 (inclusive)

maxRootLength - the maximum length of the root, between 1 and 64 (inclusive)

Returns:

a new mangrove root placement

Since:

3.0.0

of

@Internal
static MangroveRootPlacement of(Set<Material> canGrowThrough,
 Set<Material> muddyRootsIn,
 BlockStateProvider muddyRootsProvider,
 int maxRootWidth,
 int maxRootLength,
 float randomSkewChance)

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0