diff options
Diffstat (limited to 'doc/classes/AudioStreamPlayer.xml')
| -rw-r--r-- | doc/classes/AudioStreamPlayer.xml | 24 |
1 files changed, 9 insertions, 15 deletions
diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 55190c5f9f..a6c437f875 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -5,6 +5,7 @@ </brief_description> <description> Plays an audio stream non-positionally. + To play audio positionally, use [AudioStreamPlayer2D] or [AudioStreamPlayer3D] instead of [AudioStreamPlayer]. </description> <tutorials> <link title="Audio streams">https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link> @@ -16,40 +17,33 @@ </tutorials> <methods> <method name="get_playback_position"> - <return type="float"> - </return> + <return type="float" /> <description> Returns the position in the [AudioStream] in seconds. </description> </method> <method name="get_stream_playback"> - <return type="AudioStreamPlayback"> - </return> + <return type="AudioStreamPlayback" /> <description> Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer]. </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 [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> @@ -59,7 +53,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="mix_target" type="int" setter="set_mix_target" getter="get_mix_target" enum="AudioStreamPlayer.MixTarget" default="0"> |