godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Add property overview and setter/getter like in editor docs

Browse Source 
Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
classes/class_audioeffectlimiter.rst
View File

@@ -8,6 +8,7 @@ AudioEffectLimiter
==================
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -15,6 +16,19 @@ Brief Description
Adds a soft clip Limiter audio effect to an Audio bus.
Properties
----------
+---------------------------+------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ceiling_db<class_AudioEffectLimiter_ceiling_db>` |
+---------------------------+------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`soft_clip_db<class_AudioEffectLimiter_soft_clip_db>` |
+---------------------------+------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`soft_clip_ratio<class_AudioEffectLimiter_soft_clip_ratio>` |
+---------------------------+------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`threshold_db<class_AudioEffectLimiter_threshold_db>` |
+---------------------------+------------------------------------------------------------------+
Description
-----------
@@ -27,18 +41,47 @@ Property Descriptions
.. _class_AudioEffectLimiter_ceiling_db:
- :ref:`float<class_float>` **ceiling_db** - The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
- :ref:`float<class_float>` **ceiling_db**
+----------+-----------------------+
| *Setter* | set_ceiling_db(value) |
+----------+-----------------------+
| *Getter* | get_ceiling_db() |
+----------+-----------------------+
The waveform's maximum allowed value. Value can range from -20 to -0.1. Default value: ``-0.1dB``.
.. _class_AudioEffectLimiter_soft_clip_db:
- :ref:`float<class_float>` **soft_clip_db** - Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``.
- :ref:`float<class_float>` **soft_clip_db**
+----------+-------------------------+
| *Setter* | set_soft_clip_db(value) |
+----------+-------------------------+
| *Getter* | get_soft_clip_db() |
+----------+-------------------------+
Applies a gain to the limited waves. Value can range from 0 to 6. Default value: ``2dB``.
.. _class_AudioEffectLimiter_soft_clip_ratio:
- :ref:`float<class_float>` **soft_clip_ratio**
+----------+----------------------------+
| *Setter* | set_soft_clip_ratio(value) |
+----------+----------------------------+
| *Getter* | get_soft_clip_ratio() |
+----------+----------------------------+
.. _class_AudioEffectLimiter_threshold_db:
- :ref:`float<class_float>` **threshold_db** - Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``.
- :ref:`float<class_float>` **threshold_db**
+----------+-------------------------+
| *Setter* | set_threshold_db(value) |
+----------+-------------------------+
| *Getter* | get_threshold_db() |
+----------+-------------------------+
Threshold from which the limiter begins to be active. Value can range from -30 to 0. Default value: ``0dB``.