API reference / @jsprismarine/worldgen / PerlinNoise

Class: PerlinNoise

Defined in: noise/PerlinNoise.ts:15

One octave of improved Perlin noise, the building block every other noise kind stacks.

Java Edition 26.3 computes the lattice dot products and the interpolation in single precision and only the coordinates in double, which this reproduces step for step.

Extends

• GradientNoise

Extended by

• SmearedPerlinNoise

Constructors

Constructor

new PerlinNoise(random, noiseOffsetScale?): PerlinNoise

Defined in: noise/PerlinNoise.ts:19

Parameters

random

RandomSource

noiseOffsetScale?

number = 256

Returns

PerlinNoise

Overrides

GradientNoise.constructor

Properties

offsetX

readonly offsetX: number

Defined in: noise/GradientNoise.ts:58

The random offset applied to the x coordinate before lookup.

Inherited from

GradientNoise.offsetX

---

offsetY

readonly offsetY: number

Defined in: noise/GradientNoise.ts:60

The random offset applied to the y coordinate before lookup.

Inherited from

GradientNoise.offsetY

---

offsetZ

readonly offsetZ: number

Defined in: noise/GradientNoise.ts:62

The random offset applied to the z coordinate before lookup.

Inherited from

GradientNoise.offsetZ

---

STANDARD_DEVIATION

readonly static STANDARD_DEVIATION: 0.2702247831245211 = 0.2702247831245211

Defined in: noise/PerlinNoise.ts:17

The standard deviation of a single octave, used when normalizing a noise stack.

Methods

get2()

get2(x, z): number

Defined in: noise/PerlinNoise.ts:38

Samples at a 2D position, which Java treats as y = 0.

Parameters

x

number

z

number

Returns

number

Overrides

GradientNoise.get2

---

get3()

get3(x, y, z): number

Defined in: noise/PerlinNoise.ts:24

Samples at a 3D position.

Parameters

x

number

y

number

z

number

Returns

number

Overrides

GradientNoise.get3