godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-05 06:11:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/classes/MeshLibrary.xml
View File

@@ -19,7 +19,7 @@
</method>
<method name="create_item">
<return type="void" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Creates a new item in the library with the given ID.
You can get an unused ID from [method get_last_unused_item_id].
@@ -27,7 +27,7 @@
</method>
<method name="find_item_by_name" qualifiers="const">
<return type="int" />
<argument index="0" name="name" type="String" />
<param index="0" name="name" type="String" />
<description>
Returns the first item with the given name.
</description>
@@ -40,49 +40,49 @@
</method>
<method name="get_item_mesh" qualifiers="const">
<return type="Mesh" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the item's mesh.
</description>
</method>
<method name="get_item_mesh_transform" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the transform applied to the item's mesh.
</description>
</method>
<method name="get_item_name" qualifiers="const">
<return type="String" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the item's name.
</description>
</method>
<method name="get_item_navmesh" qualifiers="const">
<return type="NavigationMesh" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the item's navigation mesh.
</description>
</method>
<method name="get_item_navmesh_transform" qualifiers="const">
<return type="Transform3D" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the transform applied to the item's navigation mesh.
</description>
</method>
<method name="get_item_preview" qualifiers="const">
<return type="Texture2D" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture2D] if no preview was manually set in a running project.
</description>
</method>
<method name="get_item_shapes" qualifiers="const">
<return type="Array" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns an item's collision shapes.
The array consists of each [Shape3D] followed by its [Transform3D].
@@ -96,31 +96,31 @@
</method>
<method name="remove_item">
<return type="void" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Removes the item.
</description>
</method>
<method name="set_item_mesh">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="mesh" type="Mesh" />
<param index="0" name="id" type="int" />
<param index="1" name="mesh" type="Mesh" />
<description>
Sets the item's mesh.
</description>
</method>
<method name="set_item_mesh_transform">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="mesh_transform" type="Transform3D" />
<param index="0" name="id" type="int" />
<param index="1" name="mesh_transform" type="Transform3D" />
<description>
Sets the transform to apply to the item's mesh.
</description>
</method>
<method name="set_item_name">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="name" type="String" />
<param index="0" name="id" type="int" />
<param index="1" name="name" type="String" />
<description>
Sets the item's name.
This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name].
@@ -128,32 +128,32 @@
</method>
<method name="set_item_navmesh">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="navmesh" type="NavigationMesh" />
<param index="0" name="id" type="int" />
<param index="1" name="navmesh" type="NavigationMesh" />
<description>
Sets the item's navigation mesh.
</description>
</method>
<method name="set_item_navmesh_transform">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="navmesh" type="Transform3D" />
<param index="0" name="id" type="int" />
<param index="1" name="navmesh" type="Transform3D" />
<description>
Sets the transform to apply to the item's navigation mesh.
</description>
</method>
<method name="set_item_preview">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="texture" type="Texture2D" />
<param index="0" name="id" type="int" />
<param index="1" name="texture" type="Texture2D" />
<description>
Sets a texture to use as the item's preview icon in the editor.
</description>
</method>
<method name="set_item_shapes">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="shapes" type="Array" />
<param index="0" name="id" type="int" />
<param index="1" name="shapes" type="Array" />
<description>
Sets an item's collision shapes.
The array should consist of [Shape3D] objects, each followed by a [Transform3D] that will be applied to it. For shapes that should not have a transform, use [constant Transform3D.IDENTITY].