1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AudioStreamRandomPitch.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AudioStreamRandomPitch:
- AudioStreamRandomPitch
- ======================
- **Inherits:** :ref:`AudioStream<class_audiostream>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Plays audio with random pitch tweaking.
- Member Functions
- ----------------
- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`AudioStream<class_audiostream>` | :ref:`get_audio_stream<class_AudioStreamRandomPitch_get_audio_stream>` **(** **)** const |
- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_random_pitch<class_AudioStreamRandomPitch_get_random_pitch>` **(** **)** const |
- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_audio_stream<class_AudioStreamRandomPitch_set_audio_stream>` **(** :ref:`AudioStream<class_audiostream>` stream **)** |
- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_random_pitch<class_AudioStreamRandomPitch_set_random_pitch>` **(** :ref:`float<class_float>` scale **)** |
- +----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- Member Variables
- ----------------
- - :ref:`AudioStream<class_audiostream>` **audio_stream** - The current [AudioStream].
- - :ref:`float<class_float>` **random_pitch** - The intensity of random pitch variation.
- Description
- -----------
- Randomly varies pitch on each start.
- Member Function Description
- ---------------------------
- .. _class_AudioStreamRandomPitch_get_audio_stream:
- - :ref:`AudioStream<class_audiostream>` **get_audio_stream** **(** **)** const
- .. _class_AudioStreamRandomPitch_get_random_pitch:
- - :ref:`float<class_float>` **get_random_pitch** **(** **)** const
- .. _class_AudioStreamRandomPitch_set_audio_stream:
- - void **set_audio_stream** **(** :ref:`AudioStream<class_audiostream>` stream **)**
- .. _class_AudioStreamRandomPitch_set_random_pitch:
- - void **set_random_pitch** **(** :ref:`float<class_float>` scale **)**
|