You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-04 12:00:25 +00:00
2f5b97c7f9
Remove default value from `volume_linear` property documentation Remove `volume_linear` internal property from `AudioBusLayout` Update doc/classes/AudioEffectAmplify.xml [no ci] Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> Make documentation more concise [no ci]
22 lines
1.2 KiB
XML
22 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="AudioEffectAmplify" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Adds an amplifying audio effect to an audio bus.
|
|
</brief_description>
|
|
<description>
|
|
Increases or decreases the volume being routed through the audio bus.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
|
|
</tutorials>
|
|
<members>
|
|
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
|
|
Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.
|
|
</member>
|
|
<member name="volume_linear" type="float" setter="set_volume_linear" getter="get_volume_linear">
|
|
Amount of amplification as a linear value.
|
|
[b]Note:[/b] This member modifies [member volume_db] for convenience. The returned value is equivalent to the result of [method @GlobalScope.db_to_linear] on [member volume_db]. Setting this member is equivalent to setting [member volume_db] to the result of [method @GlobalScope.linear_to_db] on a value.
|
|
</member>
|
|
</members>
|
|
</class>
|