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

classref: Use code markup for default values/overrides

Browse Source 
Sync with godotengine/godot#35357.
Fixes #3071.
This commit is contained in:
Rémi Verschelde
2020-01-20 12:41:27 +01:00
parent 0ac1767a3f
commit 782dd64a19
410 changed files with 9572 additions and 9572 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
classes/class_audioeffectchorus.rst
View File

@@ -21,61 +21,61 @@ Adds a chorus audio effect. The effect applies a filter with voices to duplicate
Properties
----------
+---------------------------+------------------------------------------------------------------------------+--------+
| :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 |
+---------------------------+------------------------------------------------------------------------------+--------+
+---------------------------+------------------------------------------------------------------------------+------------+
| :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`` |
+---------------------------+------------------------------------------------------------------------------+------------+
Methods
-------
@@ -114,7 +114,7 @@ Property Descriptions
- :ref:`float<class_float>` **dry**
+-----------+----------------+
| *Default* | 1.0 |
| *Default* | ``1.0`` |
+-----------+----------------+
| *Setter* | set_dry(value) |
+-----------+----------------+
@@ -130,7 +130,7 @@ The effect's raw signal.
- :ref:`float<class_float>` **voice/1/cutoff_hz**
+-----------+----------------------------+
| *Default* | 8000.0 |
| *Default* | ``8000.0`` |
+-----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
@@ -146,7 +146,7 @@ The voice's cutoff frequency.
- :ref:`float<class_float>` **voice/1/delay_ms**
+-----------+---------------------------+
| *Default* | 15.0 |
| *Default* | ``15.0`` |
+-----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+-----------+---------------------------+
@@ -162,7 +162,7 @@ The voice's signal delay.
- :ref:`float<class_float>` **voice/1/depth_ms**
+-----------+---------------------------+
| *Default* | 2.0 |
| *Default* | ``2.0`` |
+-----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+-----------+---------------------------+
@@ -178,7 +178,7 @@ The voice filter's depth.
- :ref:`float<class_float>` **voice/1/level_db**
+-----------+---------------------------+
| *Default* | 0.0 |
| *Default* | ``0.0`` |
+-----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+-----------+---------------------------+
@@ -194,7 +194,7 @@ The voice's volume.
- :ref:`float<class_float>` **voice/1/pan**
+-----------+----------------------+
| *Default* | -0.5 |
| *Default* | ``-0.5`` |
+-----------+----------------------+
| *Setter* | set_voice_pan(value) |
+-----------+----------------------+
@@ -210,7 +210,7 @@ The voice's pan level.
- :ref:`float<class_float>` **voice/1/rate_hz**
+-----------+--------------------------+
| *Default* | 0.8 |
| *Default* | ``0.8`` |
+-----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+-----------+--------------------------+
@@ -226,7 +226,7 @@ The voice's filter rate.
- :ref:`float<class_float>` **voice/2/cutoff_hz**
+-----------+----------------------------+
| *Default* | 8000.0 |
| *Default* | ``8000.0`` |
+-----------+----------------------------+
| *Setter* | set_voice_cutoff_hz(value) |
+-----------+----------------------------+
@@ -242,7 +242,7 @@ The voice's cutoff frequency.
- :ref:`float<class_float>` **voice/2/delay_ms**
+-----------+---------------------------+
| *Default* | 20.0 |
| *Default* | ``20.0`` |
+-----------+---------------------------+
| *Setter* | set_voice_delay_ms(value) |
+-----------+---------------------------+
@@ -258,7 +258,7 @@ The voice's signal delay.
- :ref:`float<class_float>` **voice/2/depth_ms**
+-----------+---------------------------+
| *Default* | 3.0 |
| *Default* | ``3.0`` |
+-----------+---------------------------+
| *Setter* | set_voice_depth_ms(value) |
+-----------+---------------------------+
@@ -274,7 +274,7 @@ The voice filter's depth.
- :ref:`float<class_float>` **voice/2/level_db**
+-----------+---------------------------+
| *Default* | 0.0 |
| *Default* | ``0.0`` |
+-----------+---------------------------+
| *Setter* | set_voice_level_db(value) |
+-----------+---------------------------+
@@ -290,7 +290,7 @@ The voice's volume.
- :ref:`float<class_float>` **voice/2/pan**
+-----------+----------------------+
| *Default* | 0.5 |
| *Default* | ``0.5`` |
+-----------+----------------------+
| *Setter* | set_voice_pan(value) |
+-----------+----------------------+
@@ -306,7 +306,7 @@ The voice's pan level.
- :ref:`float<class_float>` **voice/2/rate_hz**
+-----------+--------------------------+
| *Default* | 1.2 |
| *Default* | ``1.2`` |
+-----------+--------------------------+
| *Setter* | set_voice_rate_hz(value) |
+-----------+--------------------------+
@@ -490,7 +490,7 @@ The voice's filter rate.
- :ref:`int<class_int>` **voice_count**
+-----------+------------------------+
| *Default* | 2 |
| *Default* | ``2`` |
+-----------+------------------------+
| *Setter* | set_voice_count(value) |
+-----------+------------------------+
@@ -506,7 +506,7 @@ The amount of voices in the effect.
- :ref:`float<class_float>` **wet**
+-----------+----------------+
| *Default* | 0.5 |
| *Default* | ``0.5`` |
+-----------+----------------+
| *Setter* | set_wet(value) |
+-----------+----------------+