summaryrefslogtreecommitdiff
path: root/doc/classes/AudioStreamPlayer2D.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2019-06-29 12:38:01 +0200
committerRémi Verschelde <rverschelde@gmail.com>2019-06-30 13:58:07 +0200
commitc6cea6e9b372f403a5906813bf5db8583d747d06 (patch)
treee34ffb412701b436f44feedd3f317d0e1e84afa9 /doc/classes/AudioStreamPlayer2D.xml
parent82604195b4c2c80777f7ecaa547194c6a208e8cf (diff)
doc: Add default values to all properties
Thanks to @bojidar-bg's impressive work in #29380.
Diffstat (limited to 'doc/classes/AudioStreamPlayer2D.xml')
-rw-r--r--doc/classes/AudioStreamPlayer2D.xml20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml
index c8c01b0426..01d6c0c914 100644
--- a/doc/classes/AudioStreamPlayer2D.xml
+++ b/doc/classes/AudioStreamPlayer2D.xml
@@ -50,33 +50,33 @@
</method>
</methods>
<members>
- <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask">
+ <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask" default="1">
Areas in which this sound plays.
</member>
- <member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation">
+ <member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation" default="1.0">
Dampens audio over distance with this as an exponent.
</member>
- <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled">
+ <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled" default="false">
If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
</member>
- <member name="bus" type="String" setter="set_bus" getter="get_bus">
+ <member name="bus" type="String" setter="set_bus" getter="get_bus" default="&quot;Master&quot;">
Bus on which this audio is playing.
</member>
- <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
+ <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0">
Maximum distance from which audio is still hearable.
</member>
- <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale">
+ <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale" default="1.0">
Changes the pitch and the tempo of the audio.
</member>
- <member name="playing" type="bool" setter="_set_playing" getter="is_playing">
+ <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">
If [code]true[/code], audio is playing.
</member>
- <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
+ <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream" default="null">
The [AudioStream] object to be played.
</member>
- <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused">
+ <member name="stream_paused" type="bool" setter="set_stream_paused" getter="get_stream_paused" default="false">
</member>
- <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
+ <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db" default="0.0">
Base volume without dampening.
</member>
</members>