| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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>`
- Plays audio with random pitch shifting.
- Description
- -----------
- Randomly varies pitch on each start.
- Properties
- ----------
- +---------------------------------------+-------------------------------------------------------------------------+---------+
- | :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_property_audio_stream>` | |
- +---------------------------------------+-------------------------------------------------------------------------+---------+
- | :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_property_random_pitch>` | ``1.1`` |
- +---------------------------------------+-------------------------------------------------------------------------+---------+
- Property Descriptions
- ---------------------
- .. _class_AudioStreamRandomPitch_property_audio_stream:
- - :ref:`AudioStream<class_AudioStream>` **audio_stream**
- +----------+-------------------------+
- | *Setter* | set_audio_stream(value) |
- +----------+-------------------------+
- | *Getter* | get_audio_stream() |
- +----------+-------------------------+
- The current :ref:`AudioStream<class_AudioStream>`.
- ----
- .. _class_AudioStreamRandomPitch_property_random_pitch:
- - :ref:`float<class_float>` **random_pitch**
- +-----------+-------------------------+
- | *Default* | ``1.1`` |
- +-----------+-------------------------+
- | *Setter* | set_random_pitch(value) |
- +-----------+-------------------------+
- | *Getter* | get_random_pitch() |
- +-----------+-------------------------+
- The intensity of random pitch variation.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
