diff options
| author | Dan Boorstein <dan@boorstein.net> | 2022-08-09 16:31:12 -0800 |
|---|---|---|
| committer | danboo <dan@boorstein.net> | 2022-08-09 21:58:42 -0800 |
| commit | a7ebc6fb18bcbcf817895955eed619588b3cd8b8 (patch) | |
| tree | 236d8895920cc703b681e531dc13f8f0baa446d5 /doc/classes/AudioStreamPlayer2D.xml | |
| parent | 317ced8204d80367c445963fc989de320c6f9a68 (diff) | |
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'
Diffstat (limited to 'doc/classes/AudioStreamPlayer2D.xml')
| -rw-r--r-- | doc/classes/AudioStreamPlayer2D.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index 4c3e675c41..ee71651b42 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -4,7 +4,8 @@ Plays positional sound in 2D space. </brief_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 an [AudioListener2D] node to the scene and enabling it by calling [method AudioListener2D.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). </description> |