diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-08-10 12:38:33 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-10 12:38:33 +0200 |
| commit | 9e3b2561a400fc338d22ef898bed564aa58136e3 (patch) | |
| tree | 2fdddceb3de089223501ade043ef020551041f75 | |
| parent | abe98a95c54b366962f3bbd37eca107ab207e060 (diff) | |
| parent | a7ebc6fb18bcbcf817895955eed619588b3cd8b8 (diff) | |
Merge pull request #64192 from danboo/danboo-mention-audiolistener2d
| -rw-r--r-- | doc/classes/AudioStreamPlayer2D.xml | 3 | ||||
| -rw-r--r-- | doc/classes/AudioStreamPlayer3D.xml | 2 |
2 files changed, 3 insertions, 2 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> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 9b86a93e74..0219562eca 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -5,7 +5,7 @@ </brief_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]. - By default, audio is heard from the camera position. This can be changed by adding a [AudioListener3D] node to the scene and enabling it by calling [method AudioListener3D.make_current] on it. + By default, audio is heard from the camera position. This can be changed by adding an [AudioListener3D] node to the scene and enabling it by calling [method AudioListener3D.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> |