godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve the AudioStreamPlayer(2D/3D) class descriptions

Browse Source 
(cherry picked from commit b90adec417)
This commit is contained in:
Hugo Locurcio 2021-05-05 20:37:35 +02:00 committed by Rémi Verschelde
parent c03c6ae299
commit 9b01143380
No known key found for this signature in database
GPG Key ID: C3336907360768E1
3 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/classes/AudioStreamPlayer.xml
View File

@ -5,6 +5,7 @@
</brief_description> </brief_description>
<description> <description>
Plays an audio stream non-positionally. Plays an audio stream non-positionally.
To play audio positionally, use [AudioStreamPlayer2D] or [AudioStreamPlayer3D] instead of [AudioStreamPlayer].
</description> </description>
<tutorials> <tutorials>
<link title="Audio streams">https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link> <link title="Audio streams">https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link>

4
doc/classes/AudioStreamPlayer2D.xml
View File

@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer2D" inherits="Node2D" version="3.4"> <class name="AudioStreamPlayer2D" inherits="Node2D" version="3.4">
<brief_description> <brief_description>
Plays audio in 2D. Plays positional sound in 2D space.
</brief_description> </brief_description>
<description> <description>
Plays audio that dampens with distance from screen center. 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> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link> <link>https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link>

4
doc/classes/AudioStreamPlayer3D.xml
View File

@ -1,11 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer3D" inherits="Spatial" version="3.4"> <class name="AudioStreamPlayer3D" inherits="Spatial" version="3.4">
<brief_description> <brief_description>
Plays 3D sound in 3D space. Plays positional sound in 3D space.
</brief_description> </brief_description>
<description> <description>
Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. For greater realism, a low-pass filter is automatically applied to distant sounds. This can be disabled by setting [member attenuation_filter_cutoff_hz] to [code]20500[/code]. Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. For greater realism, a low-pass filter is automatically applied to distant sounds. This can be disabled by setting [member attenuation_filter_cutoff_hz] to [code]20500[/code].
By default, audio is heard from the camera position. This can be changed by adding a [Listener] node to the scene and enabling it by calling [method Listener.make_current] on it. By default, audio is heard from the camera position. This can be changed by adding a [Listener] node to the scene and enabling it by calling [method Listener.make_current] on it.
See also [AudioStreamPlayer] to play a sound non-positionally.
[b]Note:[/b] Hiding an [AudioStreamPlayer3D] node does not disable its audio output. To temporarily disable an [AudioStreamPlayer3D]'s audio output, set [member unit_db] to a very low value like [code]-100[/code] (which isn't audible to human hearing).
</description> </description>
<tutorials> <tutorials>
<link>https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link> <link>https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link>