Files
godot-docs/classes/class_audioeffectpanner.rst
Rémi Verschelde ab3f908221 classref: Add property overview and setter/getter like in editor docs
Output from godotengine/godot#22013.
Fixes #1729.
2018-09-13 11:06:52 +02:00

46 lines
1.2 KiB
ReStructuredText

.. 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>`
**Category:** Core
Brief Description
-----------------
Adds a Panner audio effect to an Audio bus. Pans sound left or right.
Properties
----------
+---------------------------+-----------------------------------------+
| :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_pan>` |
+---------------------------+-----------------------------------------+
Description
-----------
Determines how much of an audio signal is sent to the left and right buses.
Property Descriptions
---------------------
.. _class_AudioEffectPanner_pan:
- :ref:`float<class_float>` **pan**
+----------+----------------+
| *Setter* | set_pan(value) |
+----------+----------------+
| *Getter* | get_pan() |
+----------+----------------+
Pan position. Value can range from -1 (fully left) to 1 (fully right).