Files
godot-docs/classes/class_audiostreamrandompitch.rst
Rémi Verschelde ab3f908221 classref: Add property overview and setter/getter like in editor docs
Output from godotengine/godot#22013.
Fixes #1729.
2018-09-13 11:06:52 +02:00

60 lines
1.9 KiB
ReStructuredText

.. 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.
Properties
----------
+---------------------------------------+----------------------------------------------------------------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`audio_stream<class_AudioStreamRandomPitch_audio_stream>` |
+---------------------------------------+----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`random_pitch<class_AudioStreamRandomPitch_random_pitch>` |
+---------------------------------------+----------------------------------------------------------------+
Description
-----------
Randomly varies pitch on each start.
Property Descriptions
---------------------
.. _class_AudioStreamRandomPitch_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_random_pitch:
- :ref:`float<class_float>` **random_pitch**
+----------+-------------------------+
| *Setter* | set_random_pitch(value) |
+----------+-------------------------+
| *Getter* | get_random_pitch() |
+----------+-------------------------+
The intensity of random pitch variation.