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

classref: Sync with current upstream master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-09-23 11:01:36 +02:00
parent 5e952ae7d5
commit 0cc4b36524
467 changed files with 5484 additions and 2561 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_audiostreamplayer2d.rst
+28 -20
View File
@@ -1,5 +1,6 @@
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. DO NOT EDIT THIS FILE, but the AudioStreamPlayer2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_AudioStreamPlayer2D:
@@ -13,7 +14,7 @@ AudioStreamPlayer2D
Brief Description
-----------------
Plays audio in 2D.
Member Functions
----------------
@@ -27,8 +28,6 @@ Member Functions
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_max_distance<class_AudioStreamPlayer2D_get_max_distance>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayer2D_get_pos>` **(** **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`AudioStream<class_audiostream>` | :ref:`get_stream<class_AudioStreamPlayer2D_get_stream>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_AudioStreamPlayer2D_get_volume_db>` **(** **)** const |
@@ -37,9 +36,9 @@ Member Functions
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayer2D_is_playing>` **(** **)** const |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioStreamPlayer2D_play>` **(** :ref:`float<class_float>` from_pos=0.0 **)** |
| 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_pos **)** |
| void | :ref:`seek<class_AudioStreamPlayer2D_seek>` **(** :ref:`float<class_float>` to_position **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_area_mask<class_AudioStreamPlayer2D_set_area_mask>` **(** :ref:`int<class_int>` mask **)** |
+----------------------------------------+--------------------------------------------------------------------------------------------------------------------+
@@ -62,18 +61,25 @@ Signals
-------
- **finished** **(** **)**
Emitted when the audio stops playing.
Member Variables
----------------
- :ref:`int<class_int>` **area_mask**
- :ref:`float<class_float>` **attenuation**
- :ref:`bool<class_bool>` **autoplay**
- :ref:`String<class_string>` **bus**
- :ref:`float<class_float>` **max_distance**
- :ref:`bool<class_bool>` **playing**
- :ref:`AudioStream<class_audiostream>` **stream**
- :ref:`float<class_float>` **volume_db**
- :ref:`int<class_int>` **area_mask** - Areas in which this sound plays.
- :ref:`float<class_float>` **attenuation** - Dampens audio over distance with this as an exponent.
- :ref:`bool<class_bool>` **autoplay** - If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
- :ref:`String<class_string>` **bus** - Bus on which this audio is playing.
- :ref:`float<class_float>` **max_distance** - Maximum distance from which audio is still hearable.
- :ref:`bool<class_bool>` **playing** - If [code]true[/code], audio is playing.
- :ref:`AudioStream<class_audiostream>` **stream** - The [AudioStream] object to be played.
- :ref:`float<class_float>` **volume_db** - Base volume without dampening.
Description
-----------
Plays audio that dampens with distance from screen center.
Member Function Description
---------------------------
@@ -94,10 +100,6 @@ Member Function Description
- :ref:`float<class_float>` **get_max_distance** **(** **)** const
.. _class_AudioStreamPlayer2D_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)**
.. _class_AudioStreamPlayer2D_get_stream:
- :ref:`AudioStream<class_audiostream>` **get_stream** **(** **)** const
@@ -116,11 +118,15 @@ Member Function Description
.. _class_AudioStreamPlayer2D_play:
- void **play** **(** :ref:`float<class_float>` from_pos=0.0 **)**
- void **play** **(** :ref:`float<class_float>` from_position=0.0 **)**
Plays the audio from the given position 'from_position', in seconds.
.. _class_AudioStreamPlayer2D_seek:
- void **seek** **(** :ref:`float<class_float>` to_pos **)**
- void **seek** **(** :ref:`float<class_float>` to_position **)**
Sets the position from which audio will be played, in seconds.
.. _class_AudioStreamPlayer2D_set_area_mask:
@@ -154,4 +160,6 @@ Member Function Description
- void **stop** **(** **)**
Stops the audio.