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

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2021-03-25 12:19:51 +01:00
parent 5953f4d766
commit 3a5929abf3
No known key found for this signature in database
GPG key ID: C3336907360768E1
11 changed files with 69 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/BoxContainer.xml
View file

@ -10,7 +10,7 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_spacer"> <method name="add_spacer">
<return type="void"> <return type="Control">
</return> </return>
<argument index="0" name="begin" type="bool"> <argument index="0" name="begin" type="bool">
</argument> </argument>

8
doc/classes/CheckBox.xml
View file

@ -24,6 +24,8 @@
<theme_item name="checked" type="Texture2D"> <theme_item name="checked" type="Texture2D">
The check icon to display when the [CheckBox] is checked. The check icon to display when the [CheckBox] is checked.
</theme_item> </theme_item>
<theme_item name="checked_disabled" type="Texture2D">
</theme_item>
<theme_item name="disabled" type="StyleBox"> <theme_item name="disabled" type="StyleBox">
The [StyleBox] to display as a background when the [CheckBox] is disabled. The [StyleBox] to display as a background when the [CheckBox] is disabled.
</theme_item> </theme_item>
@ -75,11 +77,17 @@
<theme_item name="radio_checked" type="Texture2D"> <theme_item name="radio_checked" type="Texture2D">
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked. If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is checked.
</theme_item> </theme_item>
<theme_item name="radio_checked_disabled" type="Texture2D">
</theme_item>
<theme_item name="radio_unchecked" type="Texture2D"> <theme_item name="radio_unchecked" type="Texture2D">
If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked. If the [CheckBox] is configured as a radio button, the icon to display when the [CheckBox] is unchecked.
</theme_item> </theme_item>
<theme_item name="radio_unchecked_disabled" type="Texture2D">
</theme_item>
<theme_item name="unchecked" type="Texture2D"> <theme_item name="unchecked" type="Texture2D">
The check icon to display when the [CheckBox] is unchecked. The check icon to display when the [CheckBox] is unchecked.
</theme_item> </theme_item>
<theme_item name="unchecked_disabled" type="Texture2D">
</theme_item>
</theme_items> </theme_items>
</class> </class>

6
doc/classes/ConfigFile.xml
View file

@ -49,6 +49,12 @@
<tutorials> <tutorials>
</tutorials> </tutorials>
<methods> <methods>
<method name="clear">
<return type="void">
</return>
<description>
</description>
</method>
<method name="erase_section"> <method name="erase_section">
<return type="void"> <return type="void">
</return> </return>

16
doc/classes/EditorSceneImporter.xml
View file

@ -74,21 +74,11 @@
</constant> </constant>
<constant name="IMPORT_ANIMATION" value="2"> <constant name="IMPORT_ANIMATION" value="2">
</constant> </constant>
<constant name="IMPORT_ANIMATION_DETECT_LOOP" value="4"> <constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="4">
</constant> </constant>
<constant name="IMPORT_ANIMATION_OPTIMIZE" value="8"> <constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="8">
</constant> </constant>
<constant name="IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS" value="16"> <constant name="IMPORT_USE_NAMED_SKIN_BINDS" value="16">
</constant>
<constant name="IMPORT_ANIMATION_KEEP_VALUE_TRACKS" value="32">
</constant>
<constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="256">
</constant>
<constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="512">
</constant>
<constant name="IMPORT_MATERIALS_IN_INSTANCES" value="1024">
</constant>
<constant name="IMPORT_USE_COMPRESSION" value="2048">
</constant> </constant>
</constants> </constants>
</class> </class>

16
doc/classes/EditorSceneImporterMesh.xml
View file

@ -60,9 +60,17 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_lightmap_size_hint" qualifiers="const">
<return type="Vector2i">
</return>
<description>
</description>
</method>
<method name="get_mesh"> <method name="get_mesh">
<return type="ArrayMesh"> <return type="ArrayMesh">
</return> </return>
<argument index="0" name="arg0" type="Mesh">
</argument>
<description> <description>
</description> </description>
</method> </method>
@ -150,6 +158,14 @@
<description> <description>
</description> </description>
</method> </method>
<method name="set_lightmap_size_hint">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2i">
</argument>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="_data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;surfaces&quot;: [ ]}"> <member name="_data" type="Dictionary" setter="_set_data" getter="_get_data" default="{&quot;surfaces&quot;: [ ]}">

7
doc/classes/EditorScenePostImport.xml
View file

@ -62,13 +62,6 @@
Returns the source file path which got imported (e.g. [code]res://scene.dae[/code]). Returns the source file path which got imported (e.g. [code]res://scene.dae[/code]).
</description> </description>
</method> </method>
<method name="get_source_folder" qualifiers="const">
<return type="String">
</return>
<description>
Returns the resource folder the imported scene file is located in.
</description>
</method>
<method name="post_import" qualifiers="virtual"> <method name="post_import" qualifiers="virtual">
<return type="Object"> <return type="Object">
</return> </return>

13
doc/classes/PhysicsServer3D.xml
View file

@ -1241,6 +1241,14 @@
Gets a slider_joint parameter (see [enum SliderJointParam] constants). Gets a slider_joint parameter (see [enum SliderJointParam] constants).
</description> </description>
</method> </method>
<method name="soft_body_get_bounds" qualifiers="const">
<return type="AABB">
</return>
<argument index="0" name="body" type="RID">
</argument>
<description>
</description>
</method>
<method name="space_create"> <method name="space_create">
<return type="RID"> <return type="RID">
</return> </return>
@ -1543,7 +1551,10 @@
<constant name="SHAPE_HEIGHTMAP" value="8" enum="ShapeType"> <constant name="SHAPE_HEIGHTMAP" value="8" enum="ShapeType">
The [Shape3D] is a [HeightMapShape3D]. The [Shape3D] is a [HeightMapShape3D].
</constant> </constant>
<constant name="SHAPE_CUSTOM" value="9" enum="ShapeType"> <constant name="SHAPE_SOFT_BODY" value="9" enum="ShapeType">
The [Shape3D] is a [SoftBody3D].
</constant>
<constant name="SHAPE_CUSTOM" value="10" enum="ShapeType">
This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. This constant is used internally by the engine. Any attempt to create this kind of shape results in an error.
</constant> </constant>
<constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter"> <constant name="AREA_PARAM_GRAVITY" value="0" enum="AreaParameter">

14
doc/classes/SoftBody3D.xml
View file

@ -44,6 +44,12 @@
Returns an individual bit on the collision mask. Returns an individual bit on the collision mask.
</description> </description>
</method> </method>
<method name="get_physics_rid" qualifiers="const">
<return type="RID">
</return>
<description>
</description>
</method>
<method name="remove_collision_exception_with"> <method name="remove_collision_exception_with">
<return type="void"> <return type="void">
</return> </return>
@ -85,11 +91,11 @@
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1"> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask" default="1">
The physics layers this SoftBody3D scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. The physics layers this SoftBody3D scans for collisions. See [url=https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information.
</member> </member>
<member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient" default="0.0"> <member name="damping_coefficient" type="float" setter="set_damping_coefficient" getter="get_damping_coefficient" default="0.01">
</member> </member>
<member name="drag_coefficient" type="float" setter="set_drag_coefficient" getter="get_drag_coefficient" default="0.0"> <member name="drag_coefficient" type="float" setter="set_drag_coefficient" getter="get_drag_coefficient" default="0.0">
</member> </member>
<member name="linear_stiffness" type="float" setter="set_linear_stiffness" getter="get_linear_stiffness" default="0.0"> <member name="linear_stiffness" type="float" setter="set_linear_stiffness" getter="get_linear_stiffness" default="0.5">
</member> </member>
<member name="parent_collision_ignore" type="NodePath" setter="set_parent_collision_ignore" getter="get_parent_collision_ignore" default="NodePath(&quot;&quot;)"> <member name="parent_collision_ignore" type="NodePath" setter="set_parent_collision_ignore" getter="get_parent_collision_ignore" default="NodePath(&quot;&quot;)">
[NodePath] to a [CollisionObject3D] this SoftBody3D should avoid clipping. [NodePath] to a [CollisionObject3D] this SoftBody3D should avoid clipping.
@ -99,10 +105,10 @@
<member name="ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable" default="true"> <member name="ray_pickable" type="bool" setter="set_ray_pickable" getter="is_ray_pickable" default="true">
If [code]true[/code], the [SoftBody3D] will respond to [RayCast3D]s. If [code]true[/code], the [SoftBody3D] will respond to [RayCast3D]s.
</member> </member>
<member name="simulation_precision" type="int" setter="set_simulation_precision" getter="get_simulation_precision" default="0"> <member name="simulation_precision" type="int" setter="set_simulation_precision" getter="get_simulation_precision" default="5">
Increasing this value will improve the resulting simulation, but can affect performance. Use with care. Increasing this value will improve the resulting simulation, but can affect performance. Use with care.
</member> </member>
<member name="total_mass" type="float" setter="set_total_mass" getter="get_total_mass" default="0.0"> <member name="total_mass" type="float" setter="set_total_mass" getter="get_total_mass" default="1.0">
The SoftBody3D's mass. The SoftBody3D's mass.
</member> </member>
</members> </members>

6
doc/classes/SurfaceTool.xml
View file

@ -189,6 +189,12 @@
<description> <description>
</description> </description>
</method> </method>
<method name="get_primitive" qualifiers="const">
<return type="int" enum="Mesh.PrimitiveType">
</return>
<description>
</description>
</method>
<method name="get_skin_weight_count" qualifiers="const"> <method name="get_skin_weight_count" qualifiers="const">
<return type="int" enum="SurfaceTool.SkinWeightCount"> <return type="int" enum="SurfaceTool.SkinWeightCount">
</return> </return>

6
doc/classes/TreeItem.xml
View file

@ -741,6 +741,12 @@
Sets the given column's tooltip text. Sets the given column's tooltip text.
</description> </description>
</method> </method>
<method name="uncollapse_tree">
<return type="void">
</return>
<description>
</description>
</method>
</methods> </methods>
<members> <members>
<member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed"> <member name="collapsed" type="bool" setter="set_collapsed" getter="is_collapsed">

2
modules/gltf/doc_classes/GLTFTexture.xml
View file

@ -9,7 +9,7 @@
<methods> <methods>
</methods> </methods>
<members> <members>
<member name="src_image" type="int" setter="set_src_image" getter="get_src_image" default="212600976"> <member name="src_image" type="int" setter="set_src_image" getter="get_src_image" default="0">
</member> </member>
</members> </members>
<constants> <constants>