class_audioeffectpanner.rst 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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>` |
  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. | *Setter* | set_pan(value) |
  27. +----------+----------------+
  28. | *Getter* | get_pan() |
  29. +----------+----------------+
  30. Pan position. Value can range from -1 (fully left) to 1 (fully right).