class_audioeffectpanner.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the AudioEffectPanner.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_AudioEffectPanner:
  6. AudioEffectPanner
  7. =================
  8. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Adds a panner audio effect to an Audio bus. Pans sound left or right.
  13. Properties
  14. ----------
  15. +---------------------------+--------------------------------------------------+-----+
  16. | :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | 0.0 |
  17. +---------------------------+--------------------------------------------------+-----+
  18. Description
  19. -----------
  20. Determines how much of an audio signal is sent to the left and right buses.
  21. Property Descriptions
  22. ---------------------
  23. .. _class_AudioEffectPanner_property_pan:
  24. - :ref:`float<class_float>` **pan**
  25. +-----------+----------------+
  26. | *Default* | 0.0 |
  27. +-----------+----------------+
  28. | *Setter* | set_pan(value) |
  29. +-----------+----------------+
  30. | *Getter* | get_pan() |
  31. +-----------+----------------+
  32. Pan position. Value can range from -1 (fully left) to 1 (fully right).