b087538119
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
40 lines
1.5 KiB
XML
40 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Listener" inherits="Spatial" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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 [Camera].
|
|
</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="Transform" />
|
|
<description>
|
|
Returns the listener's global orthonormalized [Transform].
|
|
</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 Listener 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>
|