diff options
| author | Juan Linietsky <reduzio@gmail.com> | 2021-09-09 19:19:10 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-09 19:19:10 -0300 |
| commit | d0a7eeaaffb0e79ccde9b794c383342d342744ce (patch) | |
| tree | 6100e9cc98dbc2c376457bd6928c6cf70d96e2aa /doc | |
| parent | 7c9cdea8365850aaf8101972c5853838759453bc (diff) | |
| parent | f2cb0a8d4b5226a0425d3a53caf23e353f231fed (diff) | |
Merge pull request #44844 from KoBeWi/hey_listen!_but_2d
Add Listener2D
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Listener2D.xml | 35 | ||||
| -rw-r--r-- | doc/classes/Listener3D.xml | 1 |
2 files changed, 35 insertions, 1 deletions
diff --git a/doc/classes/Listener2D.xml b/doc/classes/Listener2D.xml new file mode 100644 index 0000000000..27ee63d201 --- /dev/null +++ b/doc/classes/Listener2D.xml @@ -0,0 +1,35 @@ +<?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> diff --git a/doc/classes/Listener3D.xml b/doc/classes/Listener3D.xml index 9cc803f241..5e1b2ce7fc 100644 --- a/doc/classes/Listener3D.xml +++ b/doc/classes/Listener3D.xml @@ -5,7 +5,6 @@ </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. This can be used to listen from a location different from the [Camera3D]. - [b]Note:[/b] There is no 2D equivalent for this node yet. </description> <tutorials> </tutorials> |