godot_voxel/doc/source/api/FastNoiseLite.md

FastNoiseLite

Inherits: Resource

Generates coherent and fractal noise using the FastNoiseLite library.

Properties:

Type	Name	Default
int	cellular_distance_function	1
float	cellular_jitter	1.0
int	cellular_return_type	1
float	fractal_gain	0.5
float	fractal_lacunarity	2.0
int	fractal_octaves	3
float	fractal_ping_pong_strength	2.0
int	fractal_type	1
float	fractal_weighted_strength	0.0
int	noise_type	0
float	period	64.0
int	rotation_type_3d	0
int	seed	0
FastNoiseLiteGradient	warp_noise

Methods:

Return	Signature
float	get_noise_2d ( float x, float y )
float	get_noise_2dv ( Vector2 position )
float	get_noise_3d ( float x, float y, float z )
float	get_noise_3dv ( Vector3 position )

Enumerations:

enum NoiseType:

• TYPE_OPEN_SIMPLEX_2 = 0
• TYPE_OPEN_SIMPLEX_2S = 1
• TYPE_CELLULAR = 2
• TYPE_PERLIN = 3
• TYPE_VALUE_CUBIC = 4
• TYPE_VALUE = 5

enum FractalType:

• FRACTAL_NONE = 0
• FRACTAL_FBM = 1
• FRACTAL_RIDGED = 2
• FRACTAL_PING_PONG = 3

enum RotationType3D:

• ROTATION_3D_NONE = 0
• ROTATION_3D_IMPROVE_XY_PLANES = 1
• ROTATION_3D_IMPROVE_XZ_PLANES = 2

enum CellularDistanceFunction:

• CELLULAR_DISTANCE_EUCLIDEAN = 0
• CELLULAR_DISTANCE_EUCLIDEAN_SQ = 1
• CELLULAR_DISTANCE_MANHATTAN = 2
• CELLULAR_DISTANCE_HYBRID = 3

enum CellularReturnType:

• CELLULAR_RETURN_CELL_VALUE = 0
• CELLULAR_RETURN_DISTANCE = 1
• CELLULAR_RETURN_DISTANCE_2 = 2
• CELLULAR_RETURN_DISTANCE_2_ADD = 3
• CELLULAR_RETURN_DISTANCE_2_SUB = 4
• CELLULAR_RETURN_DISTANCE_2_MUL = 5
• CELLULAR_RETURN_DISTANCE_2_DIV = 6

Property Descriptions

• int cellular_distance_function = 1

• float cellular_jitter = 1.0

• int cellular_return_type = 1

• float fractal_gain = 0.5

• float fractal_lacunarity = 2.0

• int fractal_octaves = 3

• float fractal_ping_pong_strength = 2.0

• int fractal_type = 1

• float fractal_weighted_strength = 0.0

• int noise_type = 0

• float period = 64.0

• int rotation_type_3d = 0

• int seed = 0

• FastNoiseLiteGradient warp_noise

Method Descriptions

• float get_noise_2d( float x, float y )

• float get_noise_2dv( Vector2 position )

• float get_noise_3d( float x, float y, float z )

• float get_noise_3dv( Vector3 position )

Generated on Apr 10, 2021