Files
godot-docs/classes/class_audioeffectpanner.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +01:00

45 lines
1.3 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioEffectPanner:
AudioEffectPanner
=================
**Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Adds a panner audio effect to an Audio bus. Pans sound left or right.
Description
-----------
Determines how much of an audio signal is sent to the left and right buses.
Properties
----------
+---------------------------+--------------------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | ``0.0`` |
+---------------------------+--------------------------------------------------+---------+
Property Descriptions
---------------------
.. _class_AudioEffectPanner_property_pan:
- :ref:`float<class_float>` **pan**
+-----------+----------------+
| *Default* | ``0.0`` |
+-----------+----------------+
| *Setter* | set_pan(value) |
+-----------+----------------+
| *Getter* | get_pan() |
+-----------+----------------+
Pan position. Value can range from -1 (fully left) to 1 (fully right).