asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2019-04-30 14:23:59 +02:00
parent bd30188786
commit c991379b81
6 changed files with 52 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/classes/AudioStreamPlayer.xml
View file

@ -10,15 +10,6 @@
<link>https://docs.godotengine.org/en/latest/tutorials/audio/audio_streams.html</link>
</tutorials>
<methods>
<method name="get_mix_time" qualifiers="const">
<return type="float">
</return>
<description>
Returns the actual amount of time this stream player was mixing since play() was pressed.
To know the exact position this song is mixing right now, add the value to [method AudioServer.get_time_since_last_mix].
Also consider substracting [method AudioServer.get_output_latency] to that result.
</description>
</method>
<method name="get_playback_position">
<return type="float">
</return>

4
doc/classes/ColorPicker.xml
View file

@ -45,6 +45,10 @@
<member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha">
If [code]true[/code], shows an alpha channel slider (transparency).
</member>
<member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled">
</member>
<member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible">
</member>
<member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode">
If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR).
</member>

8
doc/classes/Object.xml
View file

@ -327,6 +327,14 @@
<description>
</description>
</method>
<method name="remove_meta">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="set">
<return type="void">
</return>

8
doc/classes/Physics2DServer.xml
View file

@ -18,6 +18,8 @@
</argument>
<argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
</argument>
<argument index="3" name="disabled" type="bool" default="false">
</argument>
<description>
Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
</description>
@ -251,7 +253,7 @@
</argument>
<argument index="1" name="shape_idx" type="int">
</argument>
<argument index="2" name="disable" type="bool">
<argument index="2" name="disabled" type="bool">
</argument>
<description>
Disables a given shape in an area.
@ -346,6 +348,8 @@
</argument>
<argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )">
</argument>
<argument index="3" name="disabled" type="bool" default="false">
</argument>
<description>
Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
</description>
@ -746,7 +750,7 @@
</argument>
<argument index="1" name="shape_idx" type="int">
</argument>
<argument index="2" name="disable" type="bool">
<argument index="2" name="disabled" type="bool">
</argument>
<description>
Disables shape in body if [code]disable[/code] is [code]true[/code].

28
doc/classes/PhysicsServer.xml
View file

@ -18,6 +18,8 @@
</argument>
<argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</argument>
<argument index="3" name="disabled" type="bool" default="false">
</argument>
<description>
Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
</description>
@ -246,6 +248,18 @@
Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID].
</description>
</method>
<method name="area_set_shape_disabled">
<return type="void">
</return>
<argument index="0" name="area" type="RID">
</argument>
<argument index="1" name="shape_idx" type="int">
</argument>
<argument index="2" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="area_set_shape_transform">
<return type="void">
</return>
@ -334,6 +348,8 @@
</argument>
<argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )">
</argument>
<argument index="3" name="disabled" type="bool" default="false">
</argument>
<description>
Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index.
</description>
@ -750,6 +766,18 @@
Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID].
</description>
</method>
<method name="body_set_shape_disabled">
<return type="void">
</return>
<argument index="0" name="body" type="RID">
</argument>
<argument index="1" name="shape_idx" type="int">
</argument>
<argument index="2" name="disabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="body_set_shape_transform">
<return type="void">
</return>

6
doc/classes/TextEdit.xml
View file

@ -524,8 +524,14 @@
</theme_item>
<theme_item name="current_line_color" type="Color">
</theme_item>
<theme_item name="executing_line_color" type="Color">
</theme_item>
<theme_item name="focus" type="StyleBox">
</theme_item>
<theme_item name="fold" type="Texture">
</theme_item>
<theme_item name="folded" type="Texture">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
<theme_item name="font_color" type="Color">