Interface NoiseFunction

All Superinterfaces:

DensityFunction, Keyed, NoiseParameterFunction, Registerable<NoiseParameterFunction>, Wrapper

All Known Subinterfaces:

MappedNoiseFunction

@NullMarked
@AsOf("3.0.0")
public interface NoiseFunction
extends NoiseParameterFunction

Samples noise after optionally shifting each input coordinate.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	NoiseFunction.AbstractBuilder<B extends NoiseFunction.AbstractBuilder<B>>	The shared base for NoiseFunction builders.
static final class	NoiseFunction.Builder	Builder for NoiseFunction.

Method Summary

Modifier and Type	Method	Description
static NoiseFunction.Builder	builder()	Creates a new builder.
static NoiseFunction	of(@Nullable ResourceKey resourceKey, NoiseParameters noiseParameters, double xzScale, double yScale)	Creates a new noise function.
static NoiseFunction	of(@Nullable ResourceKey resourceKey, NoiseParameters noiseParameters, double xzScale, double yScale, DensityFunction shiftX, DensityFunction shiftY, DensityFunction shiftZ)	Creates a new noise function with coordinate shifts.
static NoiseFunction	of(NoiseParameters noiseParameters, double xzScale, double yScale)	Creates a new noise function.
DensityFunction	shiftX()	The density function added to the X coordinate before sampling.
DensityFunction	shiftY()	The density function added to the Y coordinate before sampling.
DensityFunction	shiftZ()	The density function added to the Z coordinate before sampling.
default NoiseFunction.AbstractBuilder<?>	toBuilder()	Converts this object back to a builder.
double	xzScale()	The xz scale of the noise function.
double	yScale()	The y scale of the noise function.

Methods inherited from interface DensityFunction

abs, add, blendDensity, cache2d, cacheAllInCell, cacheOnce, clamp, cube, findTopSurface, flatCache, halfNegative, interpolated, invert, max, min, mul, quarterNegative, rangeChoice, resourceKey, square, squeeze, wrap

Methods inherited from interface Keyed

key

Methods inherited from interface NoiseParameterFunction

noiseParameters

Methods inherited from interface Registerable

register

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

xzScale

@AsOf("3.0.0")
double xzScale()

The xz scale of the noise function.

Returns:

the xz scale

Since:

3.0.0

yScale

@AsOf("3.0.0")
double yScale()

The y scale of the noise function.

Returns:

the y scale

Since:

3.0.0

shiftX

@AsOf("4.0.0")
DensityFunction shiftX()

The density function added to the X coordinate before sampling.

Returns:

the X-coordinate shift

Since:

4.0.0

shiftY

@AsOf("4.0.0")
DensityFunction shiftY()

The density function added to the Y coordinate before sampling.

Returns:

the Y-coordinate shift

Since:

4.0.0

shiftZ

@AsOf("4.0.0")
DensityFunction shiftZ()

The density function added to the Z coordinate before sampling.

Returns:

the Z-coordinate shift

Since:

4.0.0

toBuilder

@AsOf("3.0.0")
default NoiseFunction.AbstractBuilder<?> 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 NoiseFunction of(@Nullable ResourceKey resourceKey,
 NoiseParameters noiseParameters,
 double xzScale,
 double yScale)

Creates a new noise function.

Parameters:

resourceKey - the resource key, or null

noiseParameters - the parameters of the noise

xzScale - the xz scale of the noise function

yScale - the y scale of the noise function

Returns:

a new noise function

Since:

3.0.0

of

@AsOf("4.0.0")
static NoiseFunction of(@Nullable ResourceKey resourceKey,
 NoiseParameters noiseParameters,
 double xzScale,
 double yScale,
 DensityFunction shiftX,
 DensityFunction shiftY,
 DensityFunction shiftZ)

Creates a new noise function with coordinate shifts.

Parameters:

resourceKey - the resource key, or null

noiseParameters - the parameters of the noise

xzScale - the X and Z scale

yScale - the Y scale

shiftX - the X-coordinate shift

shiftY - the Y-coordinate shift

shiftZ - the Z-coordinate shift

Returns:

a new noise function

Since:

4.0.0

of

@AsOf("3.0.0")
static NoiseFunction of(NoiseParameters noiseParameters,
 double xzScale,
 double yScale)

Creates a new noise function.

Parameters:

noiseParameters - the parameters of the noise

xzScale - the xz scale of the noise function

yScale - the y scale of the noise function

Returns:

a new noise function

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0