Rename Listener2D/Listener3D to AudioListener2D/AudioListener3D
This commit is contained in:
40
doc/classes/AudioListener3D.xml
Normal file
40
doc/classes/AudioListener3D.xml
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="AudioListener3D" inherits="Node3D" 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. This can be used to listen from a location different from the [Camera3D].
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="clear_current">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Disables the listener to use the current camera's listener instead.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_listener_transform" qualifiers="const">
|
||||
<return type="Transform3D" />
|
||||
<description>
|
||||
Returns the listener's global orthonormalized [Transform3D].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_current" qualifiers="const">
|
||||
<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 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">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Enables the listener. This will override the current camera's listener.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<constants>
|
||||
</constants>
|
||||
</class>
|
||||
Reference in New Issue
Block a user