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 
[ci skip]
This commit is contained in:
Rémi Verschelde 2017-09-23 10:59:35 +02:00
parent a11a9ddffc
commit 210ebb5cdb
10 changed files with 131 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/Animation.xml
View file

@ -368,9 +368,9 @@
</argument>
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="loc" type="Vector3">
<argument index="2" name="location" type="Vector3">
</argument>
<argument index="3" name="rot" type="Quat">
<argument index="3" name="rotation" type="Quat">
</argument>
<argument index="4" name="scale" type="Vector3">
</argument>

2
doc/classes/Array.xml
View file

@ -213,7 +213,7 @@
</description>
</method>
<method name="resize">
<argument index="0" name="position" type="int">
<argument index="0" name="size" type="int">
</argument>
<description>
Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null.

6
doc/classes/AudioStreamPlayer2D.xml
View file

@ -36,12 +36,6 @@
<description>
</description>
</method>
<method name="get_position">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_stream" qualifiers="const">
<return type="AudioStream">
</return>

2
doc/classes/CanvasItem.xml
View file

@ -172,7 +172,7 @@
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<argument index="1" name="rot" type="float">
<argument index="1" name="rotation" type="float">
</argument>
<argument index="2" name="scale" type="Vector2">
</argument>

29
doc/classes/EditorResourceConversionPlugin.xml Normal file
View file

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorResourceConversionPlugin" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="_convert" qualifiers="virtual">
<return type="Resource">
</return>
<argument index="0" name="resource" type="Resource">
</argument>
<description>
</description>
</method>
<method name="_converts_to" qualifiers="virtual">
<return type="bool">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>

2
doc/classes/EditorSpatialGizmo.xml
View file

@ -24,6 +24,8 @@
</return>
<argument index="0" name="triangles" type="TriangleMesh">
</argument>
<argument index="1" name="bounds" type="Rect3">
</argument>
<description>
Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw].
</description>

6
doc/classes/GraphEdit.xml
View file

@ -228,9 +228,11 @@
<constants>
</constants>
<theme_items>
<theme_item name="SnapGrid" type="Texture">
</theme_item>
<theme_item name="bezier_len_neg" type="int">
</theme_item>
<theme_item name="bezier_len_position" type="int">
<theme_item name="bezier_len_pos" type="int">
</theme_item>
<theme_item name="bg" type="StyleBox">
</theme_item>
@ -244,7 +246,5 @@
</theme_item>
<theme_item name="reset" type="Texture">
</theme_item>
<theme_item name="snap" type="Texture">
</theme_item>
</theme_items>
</class>

12
doc/classes/RichTextLabel.xml
View file

@ -47,6 +47,12 @@
<description>
</description>
</method>
<method name="get_line_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_percent_visible" qualifiers="const">
<return type="float">
</return>
@ -84,6 +90,12 @@
<description>
</description>
</method>
<method name="get_visible_line_count" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="is_meta_underlined" qualifiers="const">
<return type="bool">
</return>

80
doc/classes/SpatialMaterial.xml
View file

@ -105,6 +105,18 @@
<description>
</description>
</method>
<method name="get_distance_fade_max_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_distance_fade_min_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_emission" qualifiers="const">
<return type="Color">
</return>
@ -187,6 +199,12 @@
<description>
</description>
</method>
<method name="get_proximity_fade_distance" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="get_refraction" qualifiers="const">
<return type="float">
</return>
@ -297,12 +315,24 @@
<description>
</description>
</method>
<method name="is_distance_fade_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_grow_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="is_proximity_fade_enabled" qualifiers="const">
<return type="bool">
</return>
<description>
</description>
</method>
<method name="set_albedo">
<return type="void">
</return>
@ -439,6 +469,30 @@
<description>
</description>
</method>
<method name="set_distance_fade">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_distance_fade_max_distance">
<return type="void">
</return>
<argument index="0" name="distance" type="float">
</argument>
<description>
</description>
</method>
<method name="set_distance_fade_min_distance">
<return type="void">
</return>
<argument index="0" name="distance" type="float">
</argument>
<description>
</description>
</method>
<method name="set_emission">
<return type="void">
</return>
@ -555,6 +609,22 @@
<description>
</description>
</method>
<method name="set_proximity_fade">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_proximity_fade_distance">
<return type="void">
</return>
<argument index="0" name="distance" type="float">
</argument>
<description>
</description>
</method>
<method name="set_refraction">
<return type="void">
</return>
@ -745,6 +815,12 @@
</member>
<member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="SpatialMaterial.DetailUV">
</member>
<member name="distance_fade_enable" type="bool" setter="set_distance_fade" getter="is_distance_fade_enabled">
</member>
<member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance">
</member>
<member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance">
</member>
<member name="emission" type="Color" setter="set_emission" getter="get_emission">
</member>
<member name="emission_enabled" type="bool" setter="set_feature" getter="get_feature">
@ -811,6 +887,10 @@
</member>
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
</member>
<member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance">
</member>
<member name="proximity_fade_enable" type="bool" setter="set_proximity_fade" getter="is_proximity_fade_enabled">
</member>
<member name="refraction_enabled" type="bool" setter="set_feature" getter="get_feature">
</member>
<member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction">

2
doc/classes/Transform2D.xml
View file

@ -36,7 +36,7 @@
<method name="Transform2D">
<return type="Transform2D">
</return>
<argument index="0" name="rot" type="float">
<argument index="0" name="rotation" type="float">
</argument>
<argument index="1" name="position" type="Vector2">
</argument>