summaryrefslogtreecommitdiff
path: root/doc/classes/ImporterMesh.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ImporterMesh.xml')
-rw-r--r--doc/classes/ImporterMesh.xml60
1 files changed, 30 insertions, 30 deletions
diff --git a/doc/classes/ImporterMesh.xml b/doc/classes/ImporterMesh.xml
index 201c0ddd38..8afa35d1b4 100644
--- a/doc/classes/ImporterMesh.xml
+++ b/doc/classes/ImporterMesh.xml
@@ -13,20 +13,20 @@
<methods>
<method name="add_blend_shape">
<return type="void" />
- <argument index="0" name="name" type="String" />
+ <param index="0" name="name" type="String" />
<description>
Adds name for a blend shape that will be added with [method add_surface]. Must be called before surface is added.
</description>
</method>
<method name="add_surface">
<return type="void" />
- <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" />
- <argument index="1" name="arrays" type="Array" />
- <argument index="2" name="blend_shapes" type="Array" default="[]" />
- <argument index="3" name="lods" type="Dictionary" default="{}" />
- <argument index="4" name="material" type="Material" default="null" />
- <argument index="5" name="name" type="String" default="&quot;&quot;" />
- <argument index="6" name="flags" type="int" default="0" />
+ <param index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" />
+ <param index="1" name="arrays" type="Array" />
+ <param index="2" name="blend_shapes" type="Array" default="[]" />
+ <param index="3" name="lods" type="Dictionary" default="{}" />
+ <param index="4" name="material" type="Material" default="null" />
+ <param index="5" name="name" type="String" default="&quot;&quot;" />
+ <param index="6" name="flags" type="int" default="0" />
<description>
Creates a new surface, analogous to [method ArrayMesh.add_surface_from_arrays].
Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface.
@@ -41,8 +41,8 @@
</method>
<method name="generate_lods">
<return type="void" />
- <argument index="0" name="normal_merge_angle" type="float" />
- <argument index="1" name="normal_split_angle" type="float" />
+ <param index="0" name="normal_merge_angle" type="float" />
+ <param index="1" name="normal_split_angle" type="float" />
<description>
Generates all lods for this ImporterMesh.
[code]normal_merge_angle[/code] and [code]normal_split_angle[/code] are in degrees and used in the same way as the importer settings in [code]lods[/code]. As a good default, use 25 and 60 respectively.
@@ -63,7 +63,7 @@
</method>
<method name="get_blend_shape_name" qualifiers="const">
<return type="String" />
- <argument index="0" name="blend_shape_idx" type="int" />
+ <param index="0" name="blend_shape_idx" type="int" />
<description>
Returns the name of the blend shape at this index.
</description>
@@ -76,7 +76,7 @@
</method>
<method name="get_mesh">
<return type="ArrayMesh" />
- <argument index="0" name="base_mesh" type="ArrayMesh" default="null" />
+ <param index="0" name="base_mesh" type="ArrayMesh" default="null" />
<description>
Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh].
This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called.
@@ -85,15 +85,15 @@
</method>
<method name="get_surface_arrays" qualifiers="const">
<return type="Array" />
- <argument index="0" name="surface_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
<description>
Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface. See [method add_surface].
</description>
</method>
<method name="get_surface_blend_shape_arrays" qualifiers="const">
<return type="Array" />
- <argument index="0" name="surface_idx" type="int" />
- <argument index="1" name="blend_shape_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
+ <param index="1" name="blend_shape_idx" type="int" />
<description>
Returns a single set of blend shape arrays for the requested blend shape index for a surface.
</description>
@@ -106,81 +106,81 @@
</method>
<method name="get_surface_format" qualifiers="const">
<return type="int" />
- <argument index="0" name="surface_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
<description>
Returns the format of the surface that the mesh holds.
</description>
</method>
<method name="get_surface_lod_count" qualifiers="const">
<return type="int" />
- <argument index="0" name="surface_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
<description>
Returns the amount of lods that the mesh holds on a given surface.
</description>
</method>
<method name="get_surface_lod_indices" qualifiers="const">
<return type="PackedInt32Array" />
- <argument index="0" name="surface_idx" type="int" />
- <argument index="1" name="lod_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
+ <param index="1" name="lod_idx" type="int" />
<description>
Returns the index buffer of a lod for a surface.
</description>
</method>
<method name="get_surface_lod_size" qualifiers="const">
<return type="float" />
- <argument index="0" name="surface_idx" type="int" />
- <argument index="1" name="lod_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
+ <param index="1" name="lod_idx" type="int" />
<description>
Returns the screen ratio which activates a lod for a surface.
</description>
</method>
<method name="get_surface_material" qualifiers="const">
<return type="Material" />
- <argument index="0" name="surface_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
<description>
Returns a [Material] in a given surface. Surface is rendered using this material.
</description>
</method>
<method name="get_surface_name" qualifiers="const">
<return type="String" />
- <argument index="0" name="surface_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
<description>
Gets the name assigned to this surface.
</description>
</method>
<method name="get_surface_primitive_type">
<return type="int" enum="Mesh.PrimitiveType" />
- <argument index="0" name="surface_idx" type="int" />
+ <param index="0" name="surface_idx" type="int" />
<description>
Returns the primitive type of the requested surface (see [method add_surface]).
</description>
</method>
<method name="set_blend_shape_mode">
<return type="void" />
- <argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode" />
+ <param index="0" name="mode" type="int" enum="Mesh.BlendShapeMode" />
<description>
Sets the blend shape mode to one of [enum Mesh.BlendShapeMode].
</description>
</method>
<method name="set_lightmap_size_hint">
<return type="void" />
- <argument index="0" name="size" type="Vector2i" />
+ <param index="0" name="size" type="Vector2i" />
<description>
Sets the size hint of this mesh for lightmap-unwrapping in UV-space.
</description>
</method>
<method name="set_surface_material">
<return type="void" />
- <argument index="0" name="surface_idx" type="int" />
- <argument index="1" name="material" type="Material" />
+ <param index="0" name="surface_idx" type="int" />
+ <param index="1" name="material" type="Material" />
<description>
Sets a [Material] for a given surface. Surface will be rendered using this material.
</description>
</method>
<method name="set_surface_name">
<return type="void" />
- <argument index="0" name="surface_idx" type="int" />
- <argument index="1" name="name" type="String" />
+ <param index="0" name="surface_idx" type="int" />
+ <param index="1" name="name" type="String" />
<description>
Sets a name for a given surface.
</description>