class_audioeffectpanner.rst 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.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. Adds a panner audio effect to an Audio bus. Pans sound left or right.
  10. Description
  11. -----------
  12. Determines how much of an audio signal is sent to the left and right buses.
  13. Properties
  14. ----------
  15. +---------------------------+--------------------------------------------------+---------+
  16. | :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | ``0.0`` |
  17. +---------------------------+--------------------------------------------------+---------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_AudioEffectPanner_property_pan:
  21. - :ref:`float<class_float>` **pan**
  22. +-----------+----------------+
  23. | *Default* | ``0.0`` |
  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).
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`