Record Class CanyonShapeConfiguration

java.lang.Object

java.lang.Record

dev.wyck.wrapper.worldgen.carver.CanyonShapeConfiguration

All Implemented Interfaces:

Wrapper

@NullMarked
@AsOf("2.3.0")
public record CanyonShapeConfiguration(FloatProvider distanceFactor, FloatProvider thickness, int widthSmoothness, FloatProvider horizontalRadiusFactor, float verticalRadiusDefaultFactor, float verticalRadiusCenterFactor)
extends Record
implements Wrapper

Wraps Minecraft's CanyonCarverConfiguration.CanyonShapeConfiguration. The shape parameters that drive a canyon's length, thickness, and radius profile.

Since:

2.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CanyonShapeConfiguration.Builder	A builder for creating a CanyonShapeConfiguration.

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Constructor Summary

Constructors

Constructor	Description
CanyonShapeConfiguration(FloatProvider distanceFactor, FloatProvider thickness, int widthSmoothness, FloatProvider horizontalRadiusFactor, float verticalRadiusDefaultFactor, float verticalRadiusCenterFactor)	Creates an instance of a CanyonShapeConfiguration record class.

Method Summary

Modifier and Type	Method	Description
static CanyonShapeConfiguration.Builder	builder()	Creates a new Builder for CanyonShapeConfiguration.
FloatProvider	distanceFactor()	Returns the value of the distanceFactor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
FloatProvider	horizontalRadiusFactor()	Returns the value of the horizontalRadiusFactor record component.
FloatProvider	thickness()	Returns the value of the thickness record component.
Object	toMinecraft()	Converts this CanyonShapeConfiguration to an NMS CanyonShapeConfiguration.
final String	toString()	Returns a string representation of this record class.
float	verticalRadiusCenterFactor()	Returns the value of the verticalRadiusCenterFactor record component.
float	verticalRadiusDefaultFactor()	Returns the value of the verticalRadiusDefaultFactor record component.
int	widthSmoothness()	Returns the value of the widthSmoothness record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Wrapper

asHandle

Constructor Details

CanyonShapeConfiguration

@AsOf("2.3.0")
public CanyonShapeConfiguration(FloatProvider distanceFactor,
 FloatProvider thickness,
 int widthSmoothness,
 FloatProvider horizontalRadiusFactor,
 float verticalRadiusDefaultFactor,
 float verticalRadiusCenterFactor)

Creates an instance of a CanyonShapeConfiguration record class.

Parameters:

distanceFactor - the value for the distanceFactor record component

thickness - the value for the thickness record component

widthSmoothness - the value for the widthSmoothness record component

horizontalRadiusFactor - the value for the horizontalRadiusFactor record component

verticalRadiusDefaultFactor - the value for the verticalRadiusDefaultFactor record component

verticalRadiusCenterFactor - the value for the verticalRadiusCenterFactor record component

Method Details

builder

@AsOf("2.3.0")
public static CanyonShapeConfiguration.Builder builder()

Creates a new Builder for CanyonShapeConfiguration.

Returns:

a new Builder for CanyonShapeConfiguration

Since:

2.3.0

toMinecraft

@AsOf("2.3.0")
public Object toMinecraft()

Converts this CanyonShapeConfiguration to an NMS CanyonShapeConfiguration.

Specified by:

toMinecraft in interface Wrapper

Returns:

the NMS CanyonShapeConfiguration

Since:

2.3.0

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

distanceFactor

public FloatProvider distanceFactor()

Returns the value of the distanceFactor record component.

Returns:

the value of the distanceFactor record component

thickness

public FloatProvider thickness()

Returns the value of the thickness record component.

Returns:

the value of the thickness record component

widthSmoothness

public int widthSmoothness()

Returns the value of the widthSmoothness record component.

Returns:

the value of the widthSmoothness record component

horizontalRadiusFactor

public FloatProvider horizontalRadiusFactor()

Returns the value of the horizontalRadiusFactor record component.

Returns:

the value of the horizontalRadiusFactor record component

verticalRadiusDefaultFactor

public float verticalRadiusDefaultFactor()

Returns the value of the verticalRadiusDefaultFactor record component.

Returns:

the value of the verticalRadiusDefaultFactor record component

verticalRadiusCenterFactor

public float verticalRadiusCenterFactor()

Returns the value of the verticalRadiusCenterFactor record component.

Returns:

the value of the verticalRadiusCenterFactor record component