Interface CanyonWorldCarver.Shape

All Superinterfaces:

Wrapper

Enclosing interface:

CanyonWorldCarver

@NullMarked
@AsOf("4.0.0")
public static interface CanyonWorldCarver.Shape
extends Wrapper

The settings used to shape a CanyonWorldCarver.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CanyonWorldCarver.Shape.Builder	Builder for CanyonWorldCarver.Shape.

Method Summary

Modifier and Type	Method	Description
static CanyonWorldCarver.Shape.Builder	builder()	Creates a new canyon shape builder.
static CanyonWorldCarver.Shape	decode(Object minecraftShape)	Reads a Minecraft canyon shape.
FloatProvider	distanceFactor()	The factor controlling the canyon's distance-based horizontal shape.
FloatProvider	horizontalRadiusFactor()	The factor applied to the canyon's horizontal radius.
static CanyonWorldCarver.Shape	of(FloatProvider distanceFactor, FloatProvider thickness, int widthSmoothness, FloatProvider horizontalRadiusFactor, float verticalRadiusDefaultFactor, float verticalRadiusCenterFactor, FloatProvider yScale)	Creates a canyon shape.
FloatProvider	thickness()	The base thickness of the canyon.
default CanyonWorldCarver.Shape.Builder	toBuilder()	Converts this canyon shape back to a builder.
float	verticalRadiusCenterFactor()	The factor applied to the canyon's vertical radius near its center.
float	verticalRadiusDefaultFactor()	The default factor applied to the canyon's vertical radius.
int	widthSmoothness()	The number of steps over which canyon width changes are smoothed.
FloatProvider	yScale()	The vertical scale applied while shaping the canyon.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

distanceFactor

@AsOf("4.0.0")
FloatProvider distanceFactor()

The factor controlling the canyon's distance-based horizontal shape.

Returns:

the distance factor

Since:

4.0.0

thickness

@AsOf("4.0.0")
FloatProvider thickness()

The base thickness of the canyon.

Returns:

the canyon thickness

Since:

4.0.0

widthSmoothness

@AsOf("4.0.0")
int widthSmoothness()

The number of steps over which canyon width changes are smoothed.

Returns:

the width smoothness

Since:

4.0.0

horizontalRadiusFactor

@AsOf("4.0.0")
FloatProvider horizontalRadiusFactor()

The factor applied to the canyon's horizontal radius.

Returns:

the horizontal radius factor

Since:

4.0.0

verticalRadiusDefaultFactor

@AsOf("4.0.0")
float verticalRadiusDefaultFactor()

The default factor applied to the canyon's vertical radius.

Returns:

the default vertical radius factor

Since:

4.0.0

verticalRadiusCenterFactor

@AsOf("4.0.0")
float verticalRadiusCenterFactor()

The factor applied to the canyon's vertical radius near its center.

Returns:

the center vertical radius factor

Since:

4.0.0

yScale

@AsOf("4.0.0")
FloatProvider yScale()

The vertical scale applied while shaping the canyon.

Returns:

the canyon's vertical scale

Since:

4.0.0

toBuilder

@AsOf("4.0.0")
default CanyonWorldCarver.Shape.Builder toBuilder()

Converts this canyon shape back to a builder.

Returns:

a builder containing this shape's values

Since:

4.0.0

of

@AsOf("4.0.0")
static CanyonWorldCarver.Shape of(FloatProvider distanceFactor,
 FloatProvider thickness,
 int widthSmoothness,
 FloatProvider horizontalRadiusFactor,
 float verticalRadiusDefaultFactor,
 float verticalRadiusCenterFactor,
 FloatProvider yScale)

Creates a canyon shape.

Parameters:

distanceFactor - the distance-based horizontal shape factor

thickness - the base canyon thickness

widthSmoothness - the number of steps over which width changes are smoothed

horizontalRadiusFactor - the horizontal radius factor

verticalRadiusDefaultFactor - the default vertical radius factor

verticalRadiusCenterFactor - the center vertical radius factor

yScale - the vertical scale applied while shaping the canyon

Returns:

a new canyon shape

Since:

4.0.0

builder

@AsOf("4.0.0")
static CanyonWorldCarver.Shape.Builder builder()

Creates a new canyon shape builder.

Returns:

a new builder

Since:

4.0.0

decode

@AsOf("4.0.0")
static CanyonWorldCarver.Shape decode(Object minecraftShape)

Reads a Minecraft canyon shape.

Parameters:

minecraftShape - the Minecraft canyon shape to read

Returns:

the decoded canyon shape

Since:

4.0.0