From f3a564f9a5bf7f5a9c99253b7d9ac37fb65bff8e Mon Sep 17 00:00:00 2001 From: "Wilson E. Alvarez" Date: Thu, 16 Sep 2021 15:28:20 -0400 Subject: Rename Listener2D/Listener3D to AudioListener2D/AudioListener3D --- doc/classes/AudioListener2D.xml | 35 ++++++++++++++++++++++++++++++++ doc/classes/AudioListener3D.xml | 40 +++++++++++++++++++++++++++++++++++++ doc/classes/AudioStreamPlayer3D.xml | 2 +- doc/classes/Listener2D.xml | 35 -------------------------------- doc/classes/Listener3D.xml | 40 ------------------------------------- 5 files changed, 76 insertions(+), 76 deletions(-) create mode 100644 doc/classes/AudioListener2D.xml create mode 100644 doc/classes/AudioListener3D.xml delete mode 100644 doc/classes/Listener2D.xml delete mode 100644 doc/classes/Listener3D.xml (limited to 'doc/classes') diff --git a/doc/classes/AudioListener2D.xml b/doc/classes/AudioListener2D.xml new file mode 100644 index 0000000000..86dc870926 --- /dev/null +++ b/doc/classes/AudioListener2D.xml @@ -0,0 +1,35 @@ + + + + Overrides the location sounds are heard from. + + + Once added to the scene tree and enabled using [method make_current], this node will override the location sounds are heard from. Only one [AudioListener2D] can be current. Using [method make_current] will disable the previous [AudioListener2D]. + If there is no active [AudioListener2D] in the current [Viewport], center of the screen will be used as a hearing point for the audio. [AudioListener2D] needs to be inside [SceneTree] to function. + + + + + + + + Disables the [AudioListener2D]. If it's not set as current, this method will have no effect. + + + + + + Returns [code]true[/code] if this [AudioListener2D] is currently active. + + + + + + Makes the [AudioListener2D] active, setting it as the hearing point for the sounds. If there is already another active [AudioListener2D], it will be disabled. + This method will have no effect if the [AudioListener2D] is not added to [SceneTree]. + + + + + + diff --git a/doc/classes/AudioListener3D.xml b/doc/classes/AudioListener3D.xml new file mode 100644 index 0000000000..ed1f7fcc8f --- /dev/null +++ b/doc/classes/AudioListener3D.xml @@ -0,0 +1,40 @@ + + + + Overrides the location sounds are heard from. + + + Once added to the scene tree and enabled using [method make_current], this node will override the location sounds are heard from. This can be used to listen from a location different from the [Camera3D]. + + + + + + + + Disables the listener to use the current camera's listener instead. + + + + + + Returns the listener's global orthonormalized [Transform3D]. + + + + + + Returns [code]true[/code] if the listener was made current using [method make_current], [code]false[/code] otherwise. + [b]Note:[/b] There may be more than one AudioListener3D marked as "current" in the scene tree, but only the one that was made current last will be used. + + + + + + Enables the listener. This will override the current camera's listener. + + + + + + diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index fa2fa5a8e3..c848812011 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -5,7 +5,7 @@ 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 [Listener3D] node to the scene and enabling it by calling [method Listener3D.make_current] on it. + 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. 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). diff --git a/doc/classes/Listener2D.xml b/doc/classes/Listener2D.xml deleted file mode 100644 index 27ee63d201..0000000000 --- a/doc/classes/Listener2D.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - Overrides the location sounds are heard from. - - - Once added to the scene tree and enabled using [method make_current], this node will override the location sounds are heard from. Only one [Listener2D] can be current. Using [method make_current] will disable the previous [Listener2D]. - If there is no active [Listener2D] in the current [Viewport], center of the screen will be used as a hearing point for the audio. [Listener2D] needs to be inside [SceneTree] to function. - - - - - - - - Disables the [Listener2D]. If it's not set as current, this method will have no effect. - - - - - - Returns [code]true[/code] if this [Listener2D] is currently active. - - - - - - Makes the [Listener2D] active, setting it as the hearing point for the sounds. If there is already another active [Listener2D], it will be disabled. - This method will have no effect if the [Listener2D] is not added to [SceneTree]. - - - - - - diff --git a/doc/classes/Listener3D.xml b/doc/classes/Listener3D.xml deleted file mode 100644 index 5e1b2ce7fc..0000000000 --- a/doc/classes/Listener3D.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Overrides the location sounds are heard from. - - - Once added to the scene tree and enabled using [method make_current], this node will override the location sounds are heard from. This can be used to listen from a location different from the [Camera3D]. - - - - - - - - Disables the listener to use the current camera's listener instead. - - - - - - Returns the listener's global orthonormalized [Transform3D]. - - - - - - Returns [code]true[/code] if the listener was made current using [method make_current], [code]false[/code] otherwise. - [b]Note:[/b] There may be more than one Listener3D marked as "current" in the scene tree, but only the one that was made current last will be used. - - - - - - Enables the listener. This will override the current camera's listener. - - - - - - -- cgit v1.2.3