.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/noise/doc_classes/FastNoiseLite.xml. .. _class_FastNoiseLite: FastNoiseLite ============= **Inherits:** :ref:`Noise` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`CellularDistanceFunction` | :ref:`cellular_distance_function` | ``0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`cellular_jitter` | ``1.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`CellularReturnType` | :ref:`cellular_return_type` | ``1`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`domain_warp_amplitude` | ``30.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`bool` | :ref:`domain_warp_enabled` | ``false`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`domain_warp_fractal_gain` | ``0.5`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`domain_warp_fractal_lacunarity` | ``6.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`domain_warp_fractal_octaves` | ``5`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`DomainWarpFractalType` | :ref:`domain_warp_fractal_type` | ``1`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`domain_warp_frequency` | ``0.05`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`DomainWarpType` | :ref:`domain_warp_type` | ``0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`fractal_gain` | ``0.5`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`fractal_lacunarity` | ``2.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`fractal_octaves` | ``5`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`fractal_ping_pong_strength` | ``2.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`FractalType` | :ref:`fractal_type` | ``1`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`fractal_weighted_strength` | ``0.0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`float` | :ref:`frequency` | ``0.01`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`NoiseType` | :ref:`noise_type` | ``1`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`Vector3` | :ref:`offset` | ``Vector3(0, 0, 0)`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ | :ref:`int` | :ref:`seed` | ``0`` | +------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_FastNoiseLite_NoiseType: .. rst-class:: classref-enumeration enum **NoiseType**: .. _class_FastNoiseLite_constant_TYPE_VALUE: .. rst-class:: classref-enumeration-constant :ref:`NoiseType` **TYPE_VALUE** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_TYPE_VALUE_CUBIC: .. rst-class:: classref-enumeration-constant :ref:`NoiseType` **TYPE_VALUE_CUBIC** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_TYPE_PERLIN: .. rst-class:: classref-enumeration-constant :ref:`NoiseType` **TYPE_PERLIN** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_TYPE_CELLULAR: .. rst-class:: classref-enumeration-constant :ref:`NoiseType` **TYPE_CELLULAR** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_TYPE_SIMPLEX: .. rst-class:: classref-enumeration-constant :ref:`NoiseType` **TYPE_SIMPLEX** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_TYPE_SIMPLEX_SMOOTH: .. rst-class:: classref-enumeration-constant :ref:`NoiseType` **TYPE_SIMPLEX_SMOOTH** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_FastNoiseLite_FractalType: .. rst-class:: classref-enumeration enum **FractalType**: .. _class_FastNoiseLite_constant_FRACTAL_NONE: .. rst-class:: classref-enumeration-constant :ref:`FractalType` **FRACTAL_NONE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_FRACTAL_FBM: .. rst-class:: classref-enumeration-constant :ref:`FractalType` **FRACTAL_FBM** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_FRACTAL_RIDGED: .. rst-class:: classref-enumeration-constant :ref:`FractalType` **FRACTAL_RIDGED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_FRACTAL_PING_PONG: .. rst-class:: classref-enumeration-constant :ref:`FractalType` **FRACTAL_PING_PONG** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_FastNoiseLite_CellularDistanceFunction: .. rst-class:: classref-enumeration enum **CellularDistanceFunction**: .. _class_FastNoiseLite_constant_DISTANCE_EUCLIDEAN: .. rst-class:: classref-enumeration-constant :ref:`CellularDistanceFunction` **DISTANCE_EUCLIDEAN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DISTANCE_EUCLIDEAN_SQUARED: .. rst-class:: classref-enumeration-constant :ref:`CellularDistanceFunction` **DISTANCE_EUCLIDEAN_SQUARED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DISTANCE_MANHATTAN: .. rst-class:: classref-enumeration-constant :ref:`CellularDistanceFunction` **DISTANCE_MANHATTAN** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DISTANCE_HYBRID: .. rst-class:: classref-enumeration-constant :ref:`CellularDistanceFunction` **DISTANCE_HYBRID** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_FastNoiseLite_CellularReturnType: .. rst-class:: classref-enumeration enum **CellularReturnType**: .. _class_FastNoiseLite_constant_RETURN_CELL_VALUE: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_CELL_VALUE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_RETURN_DISTANCE: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_DISTANCE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_RETURN_DISTANCE2: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_DISTANCE2** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_RETURN_DISTANCE2_ADD: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_DISTANCE2_ADD** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_RETURN_DISTANCE2_SUB: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_DISTANCE2_SUB** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_RETURN_DISTANCE2_MUL: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_DISTANCE2_MUL** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_RETURN_DISTANCE2_DIV: .. rst-class:: classref-enumeration-constant :ref:`CellularReturnType` **RETURN_DISTANCE2_DIV** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_FastNoiseLite_DomainWarpType: .. rst-class:: classref-enumeration enum **DomainWarpType**: .. _class_FastNoiseLite_constant_DOMAIN_WARP_SIMPLEX: .. rst-class:: classref-enumeration-constant :ref:`DomainWarpType` **DOMAIN_WARP_SIMPLEX** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DOMAIN_WARP_SIMPLEX_REDUCED: .. rst-class:: classref-enumeration-constant :ref:`DomainWarpType` **DOMAIN_WARP_SIMPLEX_REDUCED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DOMAIN_WARP_BASIC_GRID: .. rst-class:: classref-enumeration-constant :ref:`DomainWarpType` **DOMAIN_WARP_BASIC_GRID** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_FastNoiseLite_DomainWarpFractalType: .. rst-class:: classref-enumeration enum **DomainWarpFractalType**: .. _class_FastNoiseLite_constant_DOMAIN_WARP_FRACTAL_NONE: .. rst-class:: classref-enumeration-constant :ref:`DomainWarpFractalType` **DOMAIN_WARP_FRACTAL_NONE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DOMAIN_WARP_FRACTAL_PROGRESSIVE: .. rst-class:: classref-enumeration-constant :ref:`DomainWarpFractalType` **DOMAIN_WARP_FRACTAL_PROGRESSIVE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_FastNoiseLite_constant_DOMAIN_WARP_FRACTAL_INDEPENDENT: .. rst-class:: classref-enumeration-constant :ref:`DomainWarpFractalType` **DOMAIN_WARP_FRACTAL_INDEPENDENT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_FastNoiseLite_property_cellular_distance_function: .. rst-class:: classref-property :ref:`CellularDistanceFunction` **cellular_distance_function** = ``0`` .. rst-class:: classref-property-setget - void **set_cellular_distance_function** **(** :ref:`CellularDistanceFunction` value **)** - :ref:`CellularDistanceFunction` **get_cellular_distance_function** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_cellular_jitter: .. rst-class:: classref-property :ref:`float` **cellular_jitter** = ``1.0`` .. rst-class:: classref-property-setget - void **set_cellular_jitter** **(** :ref:`float` value **)** - :ref:`float` **get_cellular_jitter** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_cellular_return_type: .. rst-class:: classref-property :ref:`CellularReturnType` **cellular_return_type** = ``1`` .. rst-class:: classref-property-setget - void **set_cellular_return_type** **(** :ref:`CellularReturnType` value **)** - :ref:`CellularReturnType` **get_cellular_return_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_amplitude: .. rst-class:: classref-property :ref:`float` **domain_warp_amplitude** = ``30.0`` .. rst-class:: classref-property-setget - void **set_domain_warp_amplitude** **(** :ref:`float` value **)** - :ref:`float` **get_domain_warp_amplitude** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_enabled: .. rst-class:: classref-property :ref:`bool` **domain_warp_enabled** = ``false`` .. rst-class:: classref-property-setget - void **set_domain_warp_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_domain_warp_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_fractal_gain: .. rst-class:: classref-property :ref:`float` **domain_warp_fractal_gain** = ``0.5`` .. rst-class:: classref-property-setget - void **set_domain_warp_fractal_gain** **(** :ref:`float` value **)** - :ref:`float` **get_domain_warp_fractal_gain** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_fractal_lacunarity: .. rst-class:: classref-property :ref:`float` **domain_warp_fractal_lacunarity** = ``6.0`` .. rst-class:: classref-property-setget - void **set_domain_warp_fractal_lacunarity** **(** :ref:`float` value **)** - :ref:`float` **get_domain_warp_fractal_lacunarity** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_fractal_octaves: .. rst-class:: classref-property :ref:`int` **domain_warp_fractal_octaves** = ``5`` .. rst-class:: classref-property-setget - void **set_domain_warp_fractal_octaves** **(** :ref:`int` value **)** - :ref:`int` **get_domain_warp_fractal_octaves** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_fractal_type: .. rst-class:: classref-property :ref:`DomainWarpFractalType` **domain_warp_fractal_type** = ``1`` .. rst-class:: classref-property-setget - void **set_domain_warp_fractal_type** **(** :ref:`DomainWarpFractalType` value **)** - :ref:`DomainWarpFractalType` **get_domain_warp_fractal_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_frequency: .. rst-class:: classref-property :ref:`float` **domain_warp_frequency** = ``0.05`` .. rst-class:: classref-property-setget - void **set_domain_warp_frequency** **(** :ref:`float` value **)** - :ref:`float` **get_domain_warp_frequency** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_domain_warp_type: .. rst-class:: classref-property :ref:`DomainWarpType` **domain_warp_type** = ``0`` .. rst-class:: classref-property-setget - void **set_domain_warp_type** **(** :ref:`DomainWarpType` value **)** - :ref:`DomainWarpType` **get_domain_warp_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_fractal_gain: .. rst-class:: classref-property :ref:`float` **fractal_gain** = ``0.5`` .. rst-class:: classref-property-setget - void **set_fractal_gain** **(** :ref:`float` value **)** - :ref:`float` **get_fractal_gain** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_fractal_lacunarity: .. rst-class:: classref-property :ref:`float` **fractal_lacunarity** = ``2.0`` .. rst-class:: classref-property-setget - void **set_fractal_lacunarity** **(** :ref:`float` value **)** - :ref:`float` **get_fractal_lacunarity** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_fractal_octaves: .. rst-class:: classref-property :ref:`int` **fractal_octaves** = ``5`` .. rst-class:: classref-property-setget - void **set_fractal_octaves** **(** :ref:`int` value **)** - :ref:`int` **get_fractal_octaves** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_fractal_ping_pong_strength: .. rst-class:: classref-property :ref:`float` **fractal_ping_pong_strength** = ``2.0`` .. rst-class:: classref-property-setget - void **set_fractal_ping_pong_strength** **(** :ref:`float` value **)** - :ref:`float` **get_fractal_ping_pong_strength** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_fractal_type: .. rst-class:: classref-property :ref:`FractalType` **fractal_type** = ``1`` .. rst-class:: classref-property-setget - void **set_fractal_type** **(** :ref:`FractalType` value **)** - :ref:`FractalType` **get_fractal_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_fractal_weighted_strength: .. rst-class:: classref-property :ref:`float` **fractal_weighted_strength** = ``0.0`` .. rst-class:: classref-property-setget - void **set_fractal_weighted_strength** **(** :ref:`float` value **)** - :ref:`float` **get_fractal_weighted_strength** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_frequency: .. rst-class:: classref-property :ref:`float` **frequency** = ``0.01`` .. rst-class:: classref-property-setget - void **set_frequency** **(** :ref:`float` value **)** - :ref:`float` **get_frequency** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_noise_type: .. rst-class:: classref-property :ref:`NoiseType` **noise_type** = ``1`` .. rst-class:: classref-property-setget - void **set_noise_type** **(** :ref:`NoiseType` value **)** - :ref:`NoiseType` **get_noise_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_offset: .. rst-class:: classref-property :ref:`Vector3` **offset** = ``Vector3(0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_offset** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_FastNoiseLite_property_seed: .. rst-class:: classref-property :ref:`int` **seed** = ``0`` .. rst-class:: classref-property-setget - void **set_seed** **(** :ref:`int` value **)** - :ref:`int` **get_seed** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`