diff options
Diffstat (limited to 'doc/classes/AudioStreamPlayer2D.xml')
| -rw-r--r-- | doc/classes/AudioStreamPlayer2D.xml | 27 |
1 files changed, 11 insertions, 16 deletions
diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index d8b9385736..c40c223091 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -1,50 +1,45 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="AudioStreamPlayer2D" inherits="Node2D" version="4.0"> <brief_description> - Plays audio in 2D. + Plays positional sound in 2D space. </brief_description> <description> Plays audio that dampens with distance from screen center. + See also [AudioStreamPlayer] to play a sound non-positionally. + [b]Note:[/b] Hiding an [AudioStreamPlayer2D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer2D]'s audio output, set [member volume_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing). </description> <tutorials> <link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> </tutorials> <methods> <method name="get_playback_position"> - <return type="float"> - </return> + <return type="float" /> <description> Returns the position in the [AudioStream]. </description> </method> <method name="get_stream_playback"> - <return type="AudioStreamPlayback"> - </return> + <return type="AudioStreamPlayback" /> <description> Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer2D]. </description> </method> <method name="play"> - <return type="void"> - </return> - <argument index="0" name="from_position" type="float" default="0.0"> - </argument> + <return type="void" /> + <argument index="0" name="from_position" type="float" default="0.0" /> <description> Plays the audio from the given position [code]from_position[/code], in seconds. </description> </method> <method name="seek"> - <return type="void"> - </return> - <argument index="0" name="to_position" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="to_position" type="float" /> <description> Sets the position from which audio will be played, in seconds. </description> </method> <method name="stop"> - <return type="void"> - </return> + <return type="void" /> <description> Stops the audio. </description> @@ -60,7 +55,7 @@ <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. </member> - <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="@"Master""> + <member name="bus" type="StringName" setter="set_bus" getter="get_bus" default="&"Master""> Bus on which this audio is playing. </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="2000.0"> |