seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-07-02 12:04:26 +02:00
parent c08877777d
commit 266dc732ba
5 changed files with 23 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
doc/classes/AudioServer.xml
View File

@ -68,13 +68,6 @@
Returns the amount of channels of the bus at index [code]bus_idx[/code]. Returns the amount of channels of the bus at index [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="get_bus_count" qualifiers="const">
<return type="int">
</return>
<description>
Returns the number of available buses.
</description>
</method>
<method name="get_bus_effect"> <method name="get_bus_effect">
<return type="AudioEffect"> <return type="AudioEffect">
</return> </return>
@ -165,36 +158,25 @@
Returns the volume of the bus at index [code]bus_idx[/code] in dB. Returns the volume of the bus at index [code]bus_idx[/code] in dB.
</description> </description>
</method> </method>
<method name="get_device">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_device_list"> <method name="get_device_list">
<return type="Array"> <return type="Array">
</return> </return>
<description> <description>
</description> Returns the names of all audio devices detected on the system.
</method>
<method name="get_global_rate_scale">
<return type="float">
</return>
<description>
Returns the global rate scale at which audio is being played.
</description> </description>
</method> </method>
<method name="get_mix_rate" qualifiers="const"> <method name="get_mix_rate" qualifiers="const">
<return type="float"> <return type="float">
</return> </return>
<description> <description>
Returns the sample rate at the output of the audioserver. Returns the sample rate at the output of the [AudioServer].
</description> </description>
</method> </method>
<method name="get_output_latency" qualifiers="const"> <method name="get_output_latency" qualifiers="const">
<return type="float"> <return type="float">
</return> </return>
<description> <description>
Returns the audio driver's output latency.
</description> </description>
</method> </method>
<method name="get_speaker_mode" qualifiers="const"> <method name="get_speaker_mode" qualifiers="const">
@ -258,7 +240,7 @@
<return type="void"> <return type="void">
</return> </return>
<description> <description>
Locks the audio drivers mainloop. Remember to unlock it afterwards. Locks the audio driver's main loop. Remember to unlock it afterwards.
</description> </description>
</method> </method>
<method name="move_bus"> <method name="move_bus">
@ -303,15 +285,6 @@
If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
</description> </description>
</method> </method>
<method name="set_bus_count">
<return type="void">
</return>
<argument index="0" name="amount" type="int">
</argument>
<description>
Adds and removes buses to make the number of buses match [code]amount[/code].
</description>
</method>
<method name="set_bus_effect_enabled"> <method name="set_bus_effect_enabled">
<return type="void"> <return type="void">
</return> </return>
@ -389,23 +362,6 @@
Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code].
</description> </description>
</method> </method>
<method name="set_device">
<return type="void">
</return>
<argument index="0" name="device" type="String">
</argument>
<description>
</description>
</method>
<method name="set_global_rate_scale">
<return type="void">
</return>
<argument index="0" name="scale" type="float">
</argument>
<description>
Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast).
</description>
</method>
<method name="swap_bus_effects"> <method name="swap_bus_effects">
<return type="void"> <return type="void">
</return> </return>
@ -428,12 +384,13 @@
</method> </method>
</methods> </methods>
<members> <members>
<member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count"> <member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count" default="1">
Adds and removes buses to make the number of buses match [code]amount[/code]. Number of available audio buses.
</member> </member>
<member name="device" type="string" setter="set_device" getter="get_device"> <member name="device" type="String" setter="set_device" getter="get_device" default="&quot;Default&quot;">
Name of the current device (see [method get_device_list]).
</member> </member>
<member name="global_rate_scale" type="float" setter="set_global_rate_scale" getter="get_global_rate_scale"> <member name="global_rate_scale" type="float" setter="set_global_rate_scale" getter="get_global_rate_scale" default="1.0">
Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast). Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast).
</member> </member>
</members> </members>
@ -446,15 +403,16 @@
</signals> </signals>
<constants> <constants>
<constant name="SPEAKER_MODE_STEREO" value="0" enum="SpeakerMode"> <constant name="SPEAKER_MODE_STEREO" value="0" enum="SpeakerMode">
Two or fewer speakers are detected. Two or fewer speakers were detected.
</constant> </constant>
<constant name="SPEAKER_SURROUND_31" value="1" enum="SpeakerMode"> <constant name="SPEAKER_SURROUND_31" value="1" enum="SpeakerMode">
A 3.1 channel surround setup was detected.
</constant> </constant>
<constant name="SPEAKER_SURROUND_51" value="2" enum="SpeakerMode"> <constant name="SPEAKER_SURROUND_51" value="2" enum="SpeakerMode">
A 5.1 channel surround setup detected. A 5.1 channel surround setup was detected.
</constant> </constant>
<constant name="SPEAKER_SURROUND_71" value="3" enum="SpeakerMode"> <constant name="SPEAKER_SURROUND_71" value="3" enum="SpeakerMode">
A 7.1 channel surround setup detected. A 7.1 channel surround setup was detected.
</constant> </constant>
</constants> </constants>
</class> </class>

3
doc/classes/CPUParticles.xml
View File

@ -82,6 +82,9 @@
<member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0"> <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
Damping randomness ratio. Damping randomness ratio.
</member> </member>
<member name="direction" type="Vector3" setter="set_direction" getter="get_direction" default="Vector3( 1, 0, 0 )">
Unit vector specifying the particles' emission direction.
</member>
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles.DrawOrder" default="0"> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles.DrawOrder" default="0">
Particle draw order. Uses [enum DrawOrder] values. Particle draw order. Uses [enum DrawOrder] values.
</member> </member>

3
doc/classes/CPUParticles2D.xml
View File

@ -83,6 +83,9 @@
<member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0"> <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
Damping randomness ratio. Damping randomness ratio.
</member> </member>
<member name="direction" type="Vector2" setter="set_direction" getter="get_direction" default="Vector2( 1, 0 )">
Unit vector specifying the particles' emission direction.
</member>
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles2D.DrawOrder" default="0"> <member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles2D.DrawOrder" default="0">
Particle draw order. Uses [enum DrawOrder] values. Particle draw order. Uses [enum DrawOrder] values.
</member> </member>

2
doc/classes/Line2D.xml
View File

@ -99,7 +99,7 @@
<member name="width" type="float" setter="set_width" getter="get_width" default="10.0"> <member name="width" type="float" setter="set_width" getter="get_width" default="10.0">
The line's width. The line's width.
</member> </member>
<member name="width_curve" type="Curve" setter="set_curve" getter="get_curve"> <member name="width_curve" type="Curve" setter="set_curve" getter="get_curve" default="null">
The line's width varies with the curve. The original width is simply multiply by the value of the Curve. The line's width varies with the curve. The original width is simply multiply by the value of the Curve.
</member> </member>
</members> </members>

3
doc/classes/ParticlesMaterial.xml
View File

@ -66,6 +66,9 @@
<member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0"> <member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
Damping randomness ratio. Damping randomness ratio.
</member> </member>
<member name="direction" type="Vector3" setter="set_direction" getter="get_direction" default="Vector3( 1, 0, 0 )">
Unit vector specifying the particles' emission direction.
</member>
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents"> <member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX]. The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX].
</member> </member>