class_audioeffectpanner.rst 1.2 KB

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