godot-module-template/doc/classes/AudioEffectPanner.xml
2026-02-24 18:53:39 -03:00

20 lines
1.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioEffectPanner" inherits="AudioEffect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Adds a panner audio effect to an audio bus.
Pans the sound left or right.
</brief_description>
<description>
Determines how much of the audio signal is sent to the left and right channels. This helps with audio spatialization, giving sounds distinct places in a mix.
[AudioStreamPlayer2D] and [AudioStreamPlayer3D] handle panning automatically, following where the source of the sound is on the screen.
</description>
<tutorials>
<link title="Audio buses">$DOCS_URL/tutorials/audio/audio_buses.html</link>
<link title="Audio effects">$DOCS_URL/tutorials/audio/audio_effects.html</link>
</tutorials>
<members>
<member name="pan" type="float" setter="set_pan" getter="get_pan" default="0.0">
Pan position. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.
</member>
</members>
</class>