From 09fb05bc05d924f86b4ad89156b161a0b5a02bf0 Mon Sep 17 00:00:00 2001 From: Dan Boorstein Date: Tue, 9 Aug 2022 16:31:12 -0800 Subject: [PATCH] Add note about using AudioListener2D There was no mention of the effect of AudioListener2D in this documentation, making it unclear if there was a relationship. The new text is copied and modified from the AudioStreamPlayer3D documentation. Use 'an' as article before 'AudioListener3D' (cherry picked from commit a7ebc6fb18bcbcf817895955eed619588b3cd8b8) --- doc/classes/AudioStreamPlayer2D.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 2ffaeb7f2e5..72f1a949a70 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -4,7 +4,8 @@ Plays positional sound in 2D space. - Plays audio that dampens with distance from screen center. + Plays audio that dampens with distance from a given position. + By default, audio is heard from the screen center. This can be changed by adding a [Listener2D] node to the scene and enabling it by calling [method Listener2D.make_current] on it. 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).