class_audiostreamrandompitch.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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. Member Functions
  13. ----------------
  14. +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`AudioStream<class_audiostream>` | :ref:`get_audio_stream<class_AudioStreamRandomPitch_get_audio_stream>` **(** **)** const |
  16. +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`float<class_float>` | :ref:`get_random_pitch<class_AudioStreamRandomPitch_get_random_pitch>` **(** **)** const |
  18. +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`set_audio_stream<class_AudioStreamRandomPitch_set_audio_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
  20. +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_random_pitch<class_AudioStreamRandomPitch_set_random_pitch>` **(** :ref:`float<class_float>` scale **)** |
  22. +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
  23. Member Variables
  24. ----------------
  25. - :ref:`AudioStream<class_audiostream>` **audio_stream** - The current [AudioStream].
  26. - :ref:`float<class_float>` **random_pitch** - The intensity of random pitch variation.
  27. Description
  28. -----------
  29. Randomly varies pitch on each start.
  30. Member Function Description
  31. ---------------------------
  32. .. _class_AudioStreamRandomPitch_get_audio_stream:
  33. - :ref:`AudioStream<class_audiostream>` **get_audio_stream** **(** **)** const
  34. .. _class_AudioStreamRandomPitch_get_random_pitch:
  35. - :ref:`float<class_float>` **get_random_pitch** **(** **)** const
  36. .. _class_AudioStreamRandomPitch_set_audio_stream:
  37. - void **set_audio_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
  38. .. _class_AudioStreamRandomPitch_set_random_pitch:
  39. - void **set_random_pitch** **(** :ref:`float<class_float>` scale **)**