Browse Source

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)
Dan Boorstein 3 years ago
parent
commit
9a037a0727
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/classes/AudioStreamPlayer2D.xml

+ 2 - 1
doc/classes/AudioStreamPlayer2D.xml

@@ -4,7 +4,8 @@
 		Plays positional sound in 2D space.
 		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 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.
 		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).
 		[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>