godot/doc/classes/AudioEffectAmplify.xml
Rémi Verschelde 967bfb0c4a doc: Remove revision.module_config from version string
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00

38 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0-alpha">
<brief_description>
Adds a Amplify audio effect to an Audio bus.
Increases or decreases the volume of the selected audio bus.
</brief_description>
<description>
Increases or decreases the volume being routed through the audio bus.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_volume_db" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_volume_db">
<return type="void">
</return>
<argument index="0" name="volume" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
Amount of amplification. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24. Default value: [code]0[/code].
</member>
</members>
<constants>
</constants>
</class>