.. 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/doc/classes/AudioEffectDistortion.xml. .. _class_AudioEffectDistortion: AudioEffectDistortion ===================== **Inherits:** :ref:`AudioEffect` **<** :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:`float` | :ref:`drive` | ``0.0`` | +----------------------------------------------+--------------------------------------------------------------------+-------------+ | :ref:`float` | :ref:`keep_hf_hz` | ``16000.0`` | +----------------------------------------------+--------------------------------------------------------------------+-------------+ | :ref:`Mode` | :ref:`mode` | ``0`` | +----------------------------------------------+--------------------------------------------------------------------+-------------+ | :ref:`float` | :ref:`post_gain` | ``0.0`` | +----------------------------------------------+--------------------------------------------------------------------+-------------+ | :ref:`float` | :ref:`pre_gain` | ``0.0`` | +----------------------------------------------+--------------------------------------------------------------------+-------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AudioEffectDistortion_Mode: .. rst-class:: classref-enumeration enum **Mode**: .. _class_AudioEffectDistortion_constant_MODE_CLIP: .. rst-class:: classref-enumeration-constant :ref:`Mode` **MODE_CLIP** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioEffectDistortion_constant_MODE_ATAN: .. rst-class:: classref-enumeration-constant :ref:`Mode` **MODE_ATAN** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioEffectDistortion_constant_MODE_LOFI: .. rst-class:: classref-enumeration-constant :ref:`Mode` **MODE_LOFI** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioEffectDistortion_constant_MODE_OVERDRIVE: .. rst-class:: classref-enumeration-constant :ref:`Mode` **MODE_OVERDRIVE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AudioEffectDistortion_constant_MODE_WAVESHAPE: .. rst-class:: classref-enumeration-constant :ref:`Mode` **MODE_WAVESHAPE** = ``4`` .. 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_AudioEffectDistortion_property_drive: .. rst-class:: classref-property :ref:`float` **drive** = ``0.0`` .. rst-class:: classref-property-setget - void **set_drive** **(** :ref:`float` value **)** - :ref:`float` **get_drive** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioEffectDistortion_property_keep_hf_hz: .. rst-class:: classref-property :ref:`float` **keep_hf_hz** = ``16000.0`` .. rst-class:: classref-property-setget - void **set_keep_hf_hz** **(** :ref:`float` value **)** - :ref:`float` **get_keep_hf_hz** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioEffectDistortion_property_mode: .. rst-class:: classref-property :ref:`Mode` **mode** = ``0`` .. rst-class:: classref-property-setget - void **set_mode** **(** :ref:`Mode` value **)** - :ref:`Mode` **get_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioEffectDistortion_property_post_gain: .. rst-class:: classref-property :ref:`float` **post_gain** = ``0.0`` .. rst-class:: classref-property-setget - void **set_post_gain** **(** :ref:`float` value **)** - :ref:`float` **get_post_gain** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AudioEffectDistortion_property_pre_gain: .. rst-class:: classref-property :ref:`float` **pre_gain** = ``0.0`` .. rst-class:: classref-property-setget - void **set_pre_gain** **(** :ref:`float` value **)** - :ref:`float` **get_pre_gain** **(** **)** .. 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.)`