:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/AudioEffectReverb.xml. .. _class_AudioEffectReverb: AudioEffectReverb ================= **Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Adds a reverberation audio effect to an Audio bus. Simulates the sound of acoustic environments such as rooms, concert halls, caverns, or an open spaces. Description ----------- Simulates rooms of different sizes. Its parameters can be adjusted to simulate the sound of a specific room. Tutorials --------- - `Third Person Shooter Demo `__ Properties ---------- +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`damping` | ``0.5`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`dry` | ``1.0`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`hipass` | ``0.0`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`predelay_feedback` | ``0.4`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`predelay_msec` | ``150.0`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`room_size` | ``0.8`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`spread` | ``1.0`` | +---------------------------+------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`wet` | ``0.5`` | +---------------------------+------------------------------------------------------------------------------+-----------+ Property Descriptions --------------------- .. _class_AudioEffectReverb_property_damping: - :ref:`float` **damping** +-----------+--------------------+ | *Default* | ``0.5`` | +-----------+--------------------+ | *Setter* | set_damping(value) | +-----------+--------------------+ | *Getter* | get_damping() | +-----------+--------------------+ Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. ---- .. _class_AudioEffectReverb_property_dry: - :ref:`float` **dry** +-----------+----------------+ | *Default* | ``1.0`` | +-----------+----------------+ | *Setter* | set_dry(value) | +-----------+----------------+ | *Getter* | get_dry() | +-----------+----------------+ Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1. ---- .. _class_AudioEffectReverb_property_hipass: - :ref:`float` **hipass** +-----------+----------------+ | *Default* | ``0.0`` | +-----------+----------------+ | *Setter* | set_hpf(value) | +-----------+----------------+ | *Getter* | get_hpf() | +-----------+----------------+ High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1. ---- .. _class_AudioEffectReverb_property_predelay_feedback: - :ref:`float` **predelay_feedback** +-----------+------------------------------+ | *Default* | ``0.4`` | +-----------+------------------------------+ | *Setter* | set_predelay_feedback(value) | +-----------+------------------------------+ | *Getter* | get_predelay_feedback() | +-----------+------------------------------+ Output percent of predelay. Value can range from 0 to 1. ---- .. _class_AudioEffectReverb_property_predelay_msec: - :ref:`float` **predelay_msec** +-----------+--------------------------+ | *Default* | ``150.0`` | +-----------+--------------------------+ | *Setter* | set_predelay_msec(value) | +-----------+--------------------------+ | *Getter* | get_predelay_msec() | +-----------+--------------------------+ Time between the original signal and the early reflections of the reverb signal, in milliseconds. ---- .. _class_AudioEffectReverb_property_room_size: - :ref:`float` **room_size** +-----------+----------------------+ | *Default* | ``0.8`` | +-----------+----------------------+ | *Setter* | set_room_size(value) | +-----------+----------------------+ | *Getter* | get_room_size() | +-----------+----------------------+ Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. ---- .. _class_AudioEffectReverb_property_spread: - :ref:`float` **spread** +-----------+-------------------+ | *Default* | ``1.0`` | +-----------+-------------------+ | *Setter* | set_spread(value) | +-----------+-------------------+ | *Getter* | get_spread() | +-----------+-------------------+ Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1. ---- .. _class_AudioEffectReverb_property_wet: - :ref:`float` **wet** +-----------+----------------+ | *Default* | ``0.5`` | +-----------+----------------+ | *Setter* | set_wet(value) | +-----------+----------------+ | *Getter* | get_wet() | +-----------+----------------+ Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1. .. |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.)`