Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

FastNoiseLite

Inherits: Noise < Resource < RefCounted < Object

Generates noise using the FastNoiseLite library.

Description

This class generates noise using the FastNoiseLite library, which is a collection of several noise algorithms including Cellular, Perlin, Value, and more.

Most generated noise values are in the range of [-1, 1], but not always. Some of the cellular noise algorithms return results above 1.

Properties

CellularDistanceFunction	cellular_distance_function	0
float	cellular_jitter	1.0
CellularReturnType	cellular_return_type	1
float	domain_warp_amplitude	30.0
bool	domain_warp_enabled	false
float	domain_warp_fractal_gain	0.5
float	domain_warp_fractal_lacunarity	6.0
int	domain_warp_fractal_octaves	5
DomainWarpFractalType	domain_warp_fractal_type	1
float	domain_warp_frequency	0.05
DomainWarpType	domain_warp_type	0
float	fractal_gain	0.5
float	fractal_lacunarity	2.0
int	fractal_octaves	5
float	fractal_ping_pong_strength	2.0
FractalType	fractal_type	1
float	fractal_weighted_strength	0.0
float	frequency	0.01
NoiseType	noise_type	1
Vector3	offset	Vector3(0, 0, 0)
int	seed	0

---

Enumerations

enum NoiseType:

NoiseType TYPE_VALUE = 5

A lattice of points are assigned random values then interpolated based on neighboring values.

NoiseType TYPE_VALUE_CUBIC = 4

Similar to Value noise, but slower. Has more variance in peaks and valleys.

Cubic noise can be used to avoid certain artifacts when using value noise to create a bumpmap. In general, you should always use this mode if the value noise is being used for a heightmap or bumpmap.

NoiseType TYPE_PERLIN = 3

A lattice