diff options
| author | Juan Linietsky | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/AudioEffectAmplify.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
| download | godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.zst godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.zip | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/AudioEffectAmplify.xml')
| -rw-r--r-- | doc/classes/AudioEffectAmplify.xml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/classes/AudioEffectAmplify.xml b/doc/classes/AudioEffectAmplify.xml new file mode 100644 index 000000000..637ffa30a --- /dev/null +++ b/doc/classes/AudioEffectAmplify.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectAmplify" inherits="AudioEffect" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Amplifies the volume of an audio source. + </brief_description> + <description> + Amplifies the volume of an audio source. Increase gain of the audio being routed through the bus. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_volume_db" qualifiers="const"> + <return type="float"> + </return> + <description> + Returns the set maximum volume. + </description> + </method> + <method name="set_volume_db"> + <return type="void"> + </return> + <argument index="0" name="volume" type="float"> + </argument> + <description> + Sets the maximum volume. + </description> + </method> + </methods> + <members> + <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" brief=""> + The effect's volume limit. + </member> + </members> + <constants> + </constants> +</class> |