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

(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
3 changed files with 7 additions and 2 deletions

View File

@@ -1,10 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer2D" inherits="Node2D" version="3.4">
<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>https://docs.godotengine.org/en/3.3/tutorials/audio/audio_streams.html</link>