Added Documentation of AudioStreamPlayer2D

Fixxed according to comments
Somehow that fix was messed up again
Forgot some quotationmarks
updated autoplay, tried again
This commit is contained in:
Grosskopf 2017-09-16 19:31:43 +02:00
parent 27cd90f2b0
commit 0babf9cd0c

View file

@ -1,10 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <class name="AudioStreamPlayer2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
<brief_description> <brief_description>
Plays audio in 2D.
</brief_description> </brief_description>
<description> <description>
Plays audio that dampens with distance from screen center.
</description> </description>
<tutorials> <tutorials>
http://docs.godotengine.org/en/latest/learning/features/audio/index.html
</tutorials> </tutorials>
<demos> <demos>
</demos> </demos>
@ -69,6 +72,7 @@
<argument index="0" name="from_pos" type="float" default="0.0"> <argument index="0" name="from_pos" type="float" default="0.0">
</argument> </argument>
<description> <description>
Plays the audio from the given position 'from_pos', in seconds.
</description> </description>
</method> </method>
<method name="seek"> <method name="seek">
@ -77,6 +81,7 @@
<argument index="0" name="to_pos" type="float"> <argument index="0" name="to_pos" type="float">
</argument> </argument>
<description> <description>
Sets the position from which audio will be played, in seconds.
</description> </description>
</method> </method>
<method name="set_area_mask"> <method name="set_area_mask">
@ -139,30 +144,40 @@
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Stops the audio.
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask"> <member name="area_mask" type="int" setter="set_area_mask" getter="get_area_mask">
Areas in which this sound plays.
</member> </member>
<member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation"> <member name="attenuation" type="float" setter="set_attenuation" getter="get_attenuation">
Dampens audio over distance with this as an exponent.
</member> </member>
<member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled"> <member name="autoplay" type="bool" setter="set_autoplay" getter="is_autoplay_enabled">
If [code]true[/code], audio plays when added to scene tree. Default value: [code]false[/code].
</member> </member>
<member name="bus" type="String" setter="set_bus" getter="get_bus"> <member name="bus" type="String" setter="set_bus" getter="get_bus">
Bus on which this audio is playing.
</member> </member>
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
Maximum distance from which audio is still hearable.
</member> </member>
<member name="playing" type="bool" setter="_set_playing" getter="is_playing"> <member name="playing" type="bool" setter="_set_playing" getter="is_playing">
If [code]true[/code], audio is playing.
</member> </member>
<member name="stream" type="AudioStream" setter="set_stream" getter="get_stream"> <member name="stream" type="AudioStream" setter="set_stream" getter="get_stream">
The [AudioStream] object to be played.
</member> </member>
<member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db"> <member name="volume_db" type="float" setter="set_volume_db" getter="get_volume_db">
Base volume without dampening.
</member> </member>
</members> </members>
<signals> <signals>
<signal name="finished"> <signal name="finished">
<description> <description>
Emitted when the audio stops playing.
</description> </description>
</signal> </signal>
</signals> </signals>