godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-07-02 14:03:23 +02:00
parent 5402f28f59
commit a203daa272
397 changed files with 21934 additions and 16529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

290
classes/class_audioeffectchorus.rst
View File

@@ -19,61 +19,61 @@ Adds a chorus audio effect.
Properties
----------
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_property_voice/3/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_property_voice/3/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_property_voice/3/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_property_voice/3/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_property_voice/3/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_property_voice/3/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_property_voice/4/cutoff_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_property_voice/4/delay_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_property_voice/4/depth_ms>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_property_voice/4/level_db>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_property_voice/4/pan>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_property_voice/4/rate_hz>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_count<class_AudioEffectChorus_property_voice_count>` |
+---------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` |
+---------------------------+------------------------------------------------------------------------------+
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`dry<class_AudioEffectChorus_property_dry>` | 1.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/1/cutoff_hz<class_AudioEffectChorus_property_voice/1/cutoff_hz>` | 8000.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/1/delay_ms<class_AudioEffectChorus_property_voice/1/delay_ms>` | 15.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/1/depth_ms<class_AudioEffectChorus_property_voice/1/depth_ms>` | 2.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/1/level_db<class_AudioEffectChorus_property_voice/1/level_db>` | 0.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/1/pan<class_AudioEffectChorus_property_voice/1/pan>` | -0.5 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/1/rate_hz<class_AudioEffectChorus_property_voice/1/rate_hz>` | 0.8 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/2/cutoff_hz<class_AudioEffectChorus_property_voice/2/cutoff_hz>` | 8000.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/2/delay_ms<class_AudioEffectChorus_property_voice/2/delay_ms>` | 20.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/2/depth_ms<class_AudioEffectChorus_property_voice/2/depth_ms>` | 3.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/2/level_db<class_AudioEffectChorus_property_voice/2/level_db>` | 0.0 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/2/pan<class_AudioEffectChorus_property_voice/2/pan>` | 0.5 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/2/rate_hz<class_AudioEffectChorus_property_voice/2/rate_hz>` | 1.2 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/3/cutoff_hz<class_AudioEffectChorus_property_voice/3/cutoff_hz>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/3/delay_ms<class_AudioEffectChorus_property_voice/3/delay_ms>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/3/depth_ms<class_AudioEffectChorus_property_voice/3/depth_ms>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/3/level_db<class_AudioEffectChorus_property_voice/3/level_db>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/3/pan<class_AudioEffectChorus_property_voice/3/pan>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/3/rate_hz<class_AudioEffectChorus_property_voice/3/rate_hz>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/4/cutoff_hz<class_AudioEffectChorus_property_voice/4/cutoff_hz>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/4/delay_ms<class_AudioEffectChorus_property_voice/4/delay_ms>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/4/depth_ms<class_AudioEffectChorus_property_voice/4/depth_ms>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/4/level_db<class_AudioEffectChorus_property_voice/4/level_db>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/4/pan<class_AudioEffectChorus_property_voice/4/pan>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`voice/4/rate_hz<class_AudioEffectChorus_property_voice/4/rate_hz>` | |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`int<class_int>` | :ref:`voice_count<class_AudioEffectChorus_property_voice_count>` | 2 |
+---------------------------+------------------------------------------------------------------------------+--------+
| :ref:`float<class_float>` | :ref:`wet<class_AudioEffectChorus_property_wet>` | 0.5 |
+---------------------------+------------------------------------------------------------------------------+--------+
Description
-----------
@@ -87,11 +87,13 @@ Property Descriptions
- :ref:`float<class_float>` **dry**
+----------+----------------+
| *Setter* | set_dry(value) |
+----------+----------------+
| *Getter* | get_dry() |
+----------+----------------+
+-----------+----------------+
| *Default* | 1.0 |
+-----------+----------------+
| *Setter* | set_dry(value) |
+-----------+----------------+
| *Getter* | get_dry() |
+-----------+----------------+
The effect's raw signal.
@@ -99,11 +101,13 @@ The effect's raw signal.
- :ref:`float<class_float>` **voice/1/cutoff_hz**
+----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 8000.0 |
+-----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+-----------+----------------------------+
The voice's cutoff frequency.
@@ -111,11 +115,13 @@ The voice's cutoff frequency.
- :ref:`float<class_float>` **voice/1/delay_ms**
+----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 15.0 |
+-----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+-----------+---------------------------+
The voice's signal delay.
@@ -123,11 +129,13 @@ The voice's signal delay.
- :ref:`float<class_float>` **voice/1/depth_ms**
+----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 2.0 |
+-----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+-----------+---------------------------+
The voice filter's depth.
@@ -135,11 +143,13 @@ The voice filter's depth.
- :ref:`float<class_float>` **voice/1/level_db**
+----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+----------+---------------------------+
| *Getter* | get_voice_level_db() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0.0 |
+-----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+-----------+---------------------------+
| *Getter* | get_voice_level_db() |
+-----------+---------------------------+
The voice's volume.
@@ -147,11 +157,13 @@ The voice's volume.
- :ref:`float<class_float>` **voice/1/pan**
+----------+----------------------+
| *Setter* | set_voice_pan(value) |
+----------+----------------------+
| *Getter* | get_voice_pan() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | -0.5 |
+-----------+----------------------+
| *Setter* | set_voice_pan(value) |
+-----------+----------------------+
| *Getter* | get_voice_pan() |
+-----------+----------------------+
The voice's pan level.
@@ -159,11 +171,13 @@ The voice's pan level.
- :ref:`float<class_float>` **voice/1/rate_hz**
+----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 0.8 |
+-----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+-----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+-----------+--------------------------+
The voice's filter rate.
@@ -171,11 +185,13 @@ The voice's filter rate.
- :ref:`float<class_float>` **voice/2/cutoff_hz**
+----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+----------+----------------------------+
+-----------+----------------------------+
| *Default* | 8000.0 |
+-----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
| *Getter* | get_voice_cutoff_hz() |
+-----------+----------------------------+
The voice's cutoff frequency.
@@ -183,11 +199,13 @@ The voice's cutoff frequency.
- :ref:`float<class_float>` **voice/2/delay_ms**
+----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 20.0 |
+-----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_delay_ms() |
+-----------+---------------------------+
The voice's signal delay.
@@ -195,11 +213,13 @@ The voice's signal delay.
- :ref:`float<class_float>` **voice/2/depth_ms**
+----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 3.0 |
+-----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+-----------+---------------------------+
| *Getter* | get_voice_depth_ms() |
+-----------+---------------------------+
The voice filter's depth.
@@ -207,11 +227,13 @@ The voice filter's depth.
- :ref:`float<class_float>` **voice/2/level_db**
+----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+----------+---------------------------+
| *Getter* | get_voice_level_db() |
+----------+---------------------------+
+-----------+---------------------------+
| *Default* | 0.0 |
+-----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+-----------+---------------------------+
| *Getter* | get_voice_level_db() |
+-----------+---------------------------+
The voice's volume.
@@ -219,11 +241,13 @@ The voice's volume.
- :ref:`float<class_float>` **voice/2/pan**
+----------+----------------------+
| *Setter* | set_voice_pan(value) |
+----------+----------------------+
| *Getter* | get_voice_pan() |
+----------+----------------------+
+-----------+----------------------+
| *Default* | 0.5 |
+-----------+----------------------+
| *Setter* | set_voice_pan(value) |
+-----------+----------------------+
| *Getter* | get_voice_pan() |
+-----------+----------------------+
The voice's pan level.
@@ -231,11 +255,13 @@ The voice's pan level.
- :ref:`float<class_float>` **voice/2/rate_hz**
+----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+----------+--------------------------+
+-----------+--------------------------+
| *Default* | 1.2 |
+-----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+-----------+--------------------------+
| *Getter* | get_voice_rate_hz() |
+-----------+--------------------------+
The voice's filter rate.
@@ -387,11 +413,13 @@ The voice's filter rate.
- :ref:`int<class_int>` **voice_count**
+----------+------------------------+
| *Setter* | set_voice_count(value) |
+----------+------------------------+
| *Getter* | get_voice_count() |
+----------+------------------------+
+-----------+------------------------+
| *Default* | 2 |
+-----------+------------------------+
| *Setter* | set_voice_count(value) |
+-----------+------------------------+
| *Getter* | get_voice_count() |
+-----------+------------------------+
The amount of voices in the effect.
@@ -399,11 +427,13 @@ The amount of voices in the effect.
- :ref:`float<class_float>` **wet**
+----------+----------------+
| *Setter* | set_wet(value) |
+----------+----------------+
| *Getter* | get_wet() |
+----------+----------------+
+-----------+----------------+
| *Default* | 0.5 |
+-----------+----------------+
| *Setter* | set_wet(value) |
+-----------+----------------+
| *Getter* | get_wet() |
+-----------+----------------+
The effect's processed signal.