stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with changes from godotengine/godot#24640

Browse Source
This commit is contained in:
Rémi Verschelde
2019-01-07 10:14:12 +01:00
parent 4f5d503b25
commit f70354d01c
521 changed files with 27321 additions and 22169 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_audiostreamplayer2d.rst
+45 -45
View File
@@ -19,45 +19,45 @@ Plays audio in 2D.
Properties
----------
+---------------------------------------+---------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_area_mask>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_attenuation>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_autoplay>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_bus>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_max_distance>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_pitch_scale>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_playing>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_stream>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_stream_paused>` |
+---------------------------------------+---------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_volume_db>` |
+---------------------------------------+---------------------------------------------------------------+
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`area_mask<class_AudioStreamPlayer2D_property_area_mask>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`attenuation<class_AudioStreamPlayer2D_property_attenuation>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`autoplay<class_AudioStreamPlayer2D_property_autoplay>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`bus<class_AudioStreamPlayer2D_property_bus>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max_distance<class_AudioStreamPlayer2D_property_max_distance>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pitch_scale<class_AudioStreamPlayer2D_property_pitch_scale>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`playing<class_AudioStreamPlayer2D_property_playing>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`AudioStream<class_AudioStream>` | :ref:`stream<class_AudioStreamPlayer2D_property_stream>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`stream_paused<class_AudioStreamPlayer2D_property_stream_paused>` |
+---------------------------------------+------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`volume_db<class_AudioStreamPlayer2D_property_volume_db>` |
+---------------------------------------+------------------------------------------------------------------------+
Methods
-------
+----------------------------+-----------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer2D_get_playback_position>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_position **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AudioStreamPlayer2D_stop>` **(** **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------+
+---------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_playback_position<class_AudioStreamPlayer2D_method_get_playback_position>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioStreamPlayer2D_method_play>` **(** :ref:`float<class_float>` from_position=0.0 **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AudioStreamPlayer2D_method_seek>` **(** :ref:`float<class_float>` to_position **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AudioStreamPlayer2D_method_stop>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_AudioStreamPlayer2D_finished:
.. _class_AudioStreamPlayer2D_signal_finished:
- **finished** **(** **)**
@@ -78,7 +78,7 @@ Tutorials
Property Descriptions
---------------------
.. _class_AudioStreamPlayer2D_area_mask:
.. _class_AudioStreamPlayer2D_property_area_mask:
- :ref:`int<class_int>` **area_mask**
@@ -90,7 +90,7 @@ Property Descriptions
Areas in which this sound plays.
.. _class_AudioStreamPlayer2D_attenuation:
.. _class_AudioStreamPlayer2D_property_attenuation:
- :ref:`float<class_float>` **attenuation**
@@ -102,7 +102,7 @@ Areas in which this sound plays.
Dampens audio over distance with this as an exponent.
.. _class_AudioStreamPlayer2D_autoplay:
.. _class_AudioStreamPlayer2D_property_autoplay:
- :ref:`bool<class_bool>` **autoplay**
@@ -114,7 +114,7 @@ Dampens audio over distance with this as an exponent.
If ``true``, audio plays when added to scene tree. Default value: ``false``.
.. _class_AudioStreamPlayer2D_bus:
.. _class_AudioStreamPlayer2D_property_bus:
- :ref:`String<class_String>` **bus**
@@ -126,7 +126,7 @@ If ``true``, audio plays when added to scene tree. Default value: ``false``.
Bus on which this audio is playing.
.. _class_AudioStreamPlayer2D_max_distance:
.. _class_AudioStreamPlayer2D_property_max_distance:
- :ref:`float<class_float>` **max_distance**
@@ -138,7 +138,7 @@ Bus on which this audio is playing.
Maximum distance from which audio is still hearable.
.. _class_AudioStreamPlayer2D_pitch_scale:
.. _class_AudioStreamPlayer2D_property_pitch_scale:
- :ref:`float<class_float>` **pitch_scale**
@@ -150,7 +150,7 @@ Maximum distance from which audio is still hearable.
Changes the pitch and the tempo of the audio.
.. _class_AudioStreamPlayer2D_playing:
.. _class_AudioStreamPlayer2D_property_playing:
- :ref:`bool<class_bool>` **playing**
@@ -160,7 +160,7 @@ Changes the pitch and the tempo of the audio.
If ``true``, audio is playing.
.. _class_AudioStreamPlayer2D_stream:
.. _class_AudioStreamPlayer2D_property_stream:
- :ref:`AudioStream<class_AudioStream>` **stream**
@@ -172,7 +172,7 @@ If ``true``, audio is playing.
The :ref:`AudioStream<class_AudioStream>` object to be played.
.. _class_AudioStreamPlayer2D_stream_paused:
.. _class_AudioStreamPlayer2D_property_stream_paused:
- :ref:`bool<class_bool>` **stream_paused**
@@ -182,7 +182,7 @@ The :ref:`AudioStream<class_AudioStream>` object to be played.
| *Getter* | get_stream_paused() |
+----------+--------------------------+
.. _class_AudioStreamPlayer2D_volume_db:
.. _class_AudioStreamPlayer2D_property_volume_db:
- :ref:`float<class_float>` **volume_db**
@@ -197,25 +197,25 @@ Base volume without dampening.
Method Descriptions
-------------------
.. _class_AudioStreamPlayer2D_get_playback_position:
.. _class_AudioStreamPlayer2D_method_get_playback_position:
- :ref:`float<class_float>` **get_playback_position** **(** **)**
Returns the position in the :ref:`AudioStream<class_AudioStream>`.
.. _class_AudioStreamPlayer2D_play:
.. _class_AudioStreamPlayer2D_method_play:
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
Plays the audio from the given position 'from_position', in seconds.
.. _class_AudioStreamPlayer2D_seek:
.. _class_AudioStreamPlayer2D_method_seek:
- void **seek** **(** :ref:`float<class_float>` to_position **)**
Sets the position from which audio will be played, in seconds.
.. _class_AudioStreamPlayer2D_stop:
.. _class_AudioStreamPlayer2D_method_stop:
- void **stop** **(** **)**