Record Class FloatProvider.ClampedNormal

java.lang.Object

java.lang.Record

dev.wyck.wrapper.worldgen.valueproviders.FloatProvider.ClampedNormal

All Implemented Interfaces:

Wrapper, FloatProvider

Enclosing interface:

FloatProvider

@AsOf("2.3.0")
public static record FloatProvider.ClampedNormal(float mean, float deviation, float min, float max)
extends Record
implements FloatProvider

Since:

2.3.0

Nested Class Summary

Nested classes/interfaces inherited from interface FloatProvider

FloatProvider.ClampedNormal, FloatProvider.Constant, FloatProvider.Factory, FloatProvider.Trapezoid, FloatProvider.Uniform

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields inherited from interface FloatProvider

WIRE

Constructor Summary

Constructors

Constructor	Description
ClampedNormal(float mean, float deviation, float min, float max)	Creates an instance of a ClampedNormal record class.

Method Summary

Modifier and Type	Method	Description
float	deviation()	Returns the value of the deviation 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.
float	max()	Returns the value of the max record component.
float	maxValue()
float	mean()	Returns the value of the mean record component.
float	min()	Returns the value of the min record component.
float	minValue()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface FloatProvider

toMinecraft

Methods inherited from interface Wrapper

asHandle

Constructor Details

ClampedNormal

public ClampedNormal(float mean,
 float deviation,
 float min,
 float max)

Creates an instance of a ClampedNormal record class.

Parameters:

mean - the value for the mean record component

deviation - the value for the deviation record component

min - the value for the min record component

max - the value for the max record component

Method Details

minValue

public float minValue()

Specified by:

minValue in interface FloatProvider

Returns:

the smallest value this provider can yield.

maxValue

public float maxValue()

Specified by:

maxValue in interface FloatProvider

Returns:

the largest value this provider can yield.

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. All components in this record class 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.

mean

public float mean()

Returns the value of the mean record component.

Returns:

the value of the mean record component

deviation

public float deviation()

Returns the value of the deviation record component.

Returns:

the value of the deviation record component

min

public float min()

Returns the value of the min record component.

Returns:

the value of the min record component

max

public float max()

Returns the value of the max record component.

Returns:

the value of the max record component