class_audioeffectpanner.rst 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AudioEffectPanner.xml.
  6. .. _class_AudioEffectPanner:
  7. AudioEffectPanner
  8. =================
  9. **Inherits:** :ref:`AudioEffect<class_AudioEffect>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Adds a panner audio effect to an audio bus. Pans sound left or right.
  11. Description
  12. -----------
  13. Determines how much of an audio signal is sent to the left and right buses.
  14. Tutorials
  15. ---------
  16. - :doc:`Audio buses <../tutorials/audio/audio_buses>`
  17. Properties
  18. ----------
  19. +---------------------------+--------------------------------------------------+---------+
  20. | :ref:`float<class_float>` | :ref:`pan<class_AudioEffectPanner_property_pan>` | ``0.0`` |
  21. +---------------------------+--------------------------------------------------+---------+
  22. Property Descriptions
  23. ---------------------
  24. .. _class_AudioEffectPanner_property_pan:
  25. - :ref:`float<class_float>` **pan**
  26. +-----------+----------------+
  27. | *Default* | ``0.0`` |
  28. +-----------+----------------+
  29. | *Setter* | set_pan(value) |
  30. +-----------+----------------+
  31. | *Getter* | get_pan() |
  32. +-----------+----------------+
  33. Pan position. Value can range from -1 (fully left) to 1 (fully right).
  34. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  35. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  36. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  37. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  38. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  39. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`