diff options
author | Wilson E. Alvarez <wilson.e.alvarez1@gmail.com> | 2021-09-16 15:28:20 -0400 |
---|---|---|
committer | Wilson E. Alvarez <wilson.e.alvarez1@gmail.com> | 2021-09-16 17:51:51 -0400 |
commit | f3a564f9a5bf7f5a9c99253b7d9ac37fb65bff8e (patch) | |
tree | 1c69b67416382df32ff0aae33f5eaadd01840e6a /doc | |
parent | 3581b893ed2dc1e444618ac40dc26dd58fe1219a (diff) | |
download | redot-engine-f3a564f9a5bf7f5a9c99253b7d9ac37fb65bff8e.tar.gz |
Rename Listener2D/Listener3D to AudioListener2D/AudioListener3D
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/AudioListener2D.xml | 35 | ||||
-rw-r--r-- | doc/classes/AudioListener3D.xml (renamed from doc/classes/Listener3D.xml) | 4 | ||||
-rw-r--r-- | doc/classes/AudioStreamPlayer3D.xml | 2 | ||||
-rw-r--r-- | doc/classes/Listener2D.xml | 35 |
4 files changed, 38 insertions, 38 deletions
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 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioListener2D" inherits="Node2D" version="4.0"> + <brief_description> + Overrides the location sounds are heard from. + </brief_description> + <description> + 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. + </description> + <tutorials> + </tutorials> + <methods> + <method name="clear_current"> + <return type="void" /> + <description> + Disables the [AudioListener2D]. If it's not set as current, this method will have no effect. + </description> + </method> + <method name="is_current" qualifiers="const"> + <return type="bool" /> + <description> + Returns [code]true[/code] if this [AudioListener2D] is currently active. + </description> + </method> + <method name="make_current"> + <return type="void" /> + <description> + 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]. + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Listener3D.xml b/doc/classes/AudioListener3D.xml index 5e1b2ce7fc..ed1f7fcc8f 100644 --- a/doc/classes/Listener3D.xml +++ b/doc/classes/AudioListener3D.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Listener3D" inherits="Node3D" version="4.0"> +<class name="AudioListener3D" inherits="Node3D" version="4.0"> <brief_description> Overrides the location sounds are heard from. </brief_description> @@ -25,7 +25,7 @@ <return type="bool" /> <description> 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. + [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. </description> </method> <method name="make_current"> 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 @@ </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 [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). </description> 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 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="Listener2D" inherits="Node2D" version="4.0"> - <brief_description> - Overrides the location sounds are heard from. - </brief_description> - <description> - 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. - </description> - <tutorials> - </tutorials> - <methods> - <method name="clear_current"> - <return type="void" /> - <description> - Disables the [Listener2D]. If it's not set as current, this method will have no effect. - </description> - </method> - <method name="is_current" qualifiers="const"> - <return type="bool" /> - <description> - Returns [code]true[/code] if this [Listener2D] is currently active. - </description> - </method> - <method name="make_current"> - <return type="void" /> - <description> - 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]. - </description> - </method> - </methods> - <constants> - </constants> -</class> |