summaryrefslogtreecommitdiff
path: root/doc/classes/MeshInstance3D.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2022-08-08 22:50:35 +0200
committerGitHub <noreply@github.com>2022-08-08 22:50:35 +0200
commit682dbe5d00aa7730659771b16704eba83f166a7b (patch)
tree8555e07c3bfb3b2892d530bc93fbf47d14519e35 /doc/classes/MeshInstance3D.xml
parentd9d5990c517b63f41881de05cb4644c36e0c77e0 (diff)
parentc5d7115038de5f83cb83e08748615a84fc26bee2 (diff)
Merge pull request #64008 from YuriSizov/doctool-add-param-reference-syntax
Diffstat (limited to 'doc/classes/MeshInstance3D.xml')
-rw-r--r--doc/classes/MeshInstance3D.xml20
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/classes/MeshInstance3D.xml b/doc/classes/MeshInstance3D.xml
index 24f1f9918b..1e69af6fd7 100644
--- a/doc/classes/MeshInstance3D.xml
+++ b/doc/classes/MeshInstance3D.xml
@@ -15,8 +15,8 @@
<methods>
<method name="create_convex_collision">
<return type="void" />
- <argument index="0" name="clean" type="bool" default="true" />
- <argument index="1" name="simplify" type="bool" default="false" />
+ <param index="0" name="clean" type="bool" default="true" />
+ <param index="1" name="simplify" type="bool" default="false" />
<description>
This helper creates a [StaticBody3D] child node with a [ConvexPolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing.
If [code]clean[/code] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed.
@@ -43,13 +43,13 @@
</method>
<method name="find_blend_shape_by_name">
<return type="int" />
- <argument index="0" name="name" type="StringName" />
+ <param index="0" name="name" type="StringName" />
<description>
</description>
</method>
<method name="get_active_material" qualifiers="const">
<return type="Material" />
- <argument index="0" name="surface" type="int" />
+ <param index="0" name="surface" type="int" />
<description>
Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material.
</description>
@@ -61,13 +61,13 @@
</method>
<method name="get_blend_shape_value" qualifiers="const">
<return type="float" />
- <argument index="0" name="blend_shape_idx" type="int" />
+ <param index="0" name="blend_shape_idx" type="int" />
<description>
</description>
</method>
<method name="get_surface_override_material" qualifiers="const">
<return type="Material" />
- <argument index="0" name="surface" type="int" />
+ <param index="0" name="surface" type="int" />
<description>
Returns the override [Material] for the specified surface of the [Mesh] resource.
</description>
@@ -80,15 +80,15 @@
</method>
<method name="set_blend_shape_value">
<return type="void" />
- <argument index="0" name="blend_shape_idx" type="int" />
- <argument index="1" name="value" type="float" />
+ <param index="0" name="blend_shape_idx" type="int" />
+ <param index="1" name="value" type="float" />
<description>
</description>
</method>
<method name="set_surface_override_material">
<return type="void" />
- <argument index="0" name="surface" type="int" />
- <argument index="1" name="material" type="Material" />
+ <param index="0" name="surface" type="int" />
+ <param index="1" name="material" type="Material" />
<description>
Sets the override [Material] for the specified surface of the [Mesh] resource. This material is associated with this [MeshInstance3D] rather than with the [Mesh] resource.
</description>