class_audiostreamrandompitch.rst 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the AudioStreamRandomPitch.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_AudioStreamRandomPitch:
  5. AudioStreamRandomPitch
  6. ======================
  7. **Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Plays audio with random pitch tweaking.
  12. Properties
  13. ----------
  14. +---------------------------------------+----------------------------------------------------------------+
  15. | :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_audio_stream>` |
  16. +---------------------------------------+----------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_random_pitch>` |
  18. +---------------------------------------+----------------------------------------------------------------+
  19. Description
  20. -----------
  21. Randomly varies pitch on each start.
  22. Property Descriptions
  23. ---------------------
  24. .. _class_AudioStreamRandomPitch_audio_stream:
  25. - :ref:`AudioStream<class_AudioStream>` **audio_stream**
  26. +----------+-------------------------+
  27. | *Setter* | set_audio_stream(value) |
  28. +----------+-------------------------+
  29. | *Getter* | get_audio_stream() |
  30. +----------+-------------------------+
  31. The current :ref:`AudioStream<class_AudioStream>`.
  32. .. _class_AudioStreamRandomPitch_random_pitch:
  33. - :ref:`float<class_float>` **random_pitch**
  34. +----------+-------------------------+
  35. | *Setter* | set_random_pitch(value) |
  36. +----------+-------------------------+
  37. | *Getter* | get_random_pitch() |
  38. +----------+-------------------------+
  39. The intensity of random pitch variation.