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

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
doc/classes/MultiMesh.xml
View File

@@ -15,53 +15,42 @@
</tutorials>
<methods>
<method name="get_aabb" qualifiers="const">
<return type="AABB">
</return>
<return type="AABB" />
<description>
Returns the visibility axis-aligned bounding box in local space. See also [method VisualInstance.get_transformed_aabb].
</description>
</method>
<method name="get_instance_color" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="instance" type="int">
</argument>
<return type="Color" />
<argument index="0" name="instance" type="int" />
<description>
Gets a specific instance's color.
</description>
</method>
<method name="get_instance_custom_data" qualifiers="const">
<return type="Color">
</return>
<argument index="0" name="instance" type="int">
</argument>
<return type="Color" />
<argument index="0" name="instance" type="int" />
<description>
Returns the custom data that has been set for a specific instance.
</description>
</method>
<method name="get_instance_transform" qualifiers="const">
<return type="Transform">
</return>
<argument index="0" name="instance" type="int">
</argument>
<return type="Transform" />
<argument index="0" name="instance" type="int" />
<description>
Returns the [Transform] of a specific instance.
</description>
</method>
<method name="get_instance_transform_2d" qualifiers="const">
<return type="Transform2D">
</return>
<argument index="0" name="instance" type="int">
</argument>
<return type="Transform2D" />
<argument index="0" name="instance" type="int" />
<description>
Returns the [Transform2D] of a specific instance.
</description>
</method>
<method name="set_as_bulk_array">
<return type="void">
</return>
<argument index="0" name="array" type="PoolRealArray">
</argument>
<return type="void" />
<argument index="0" name="array" type="PoolRealArray" />
<description>
Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative.
All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc...
@@ -69,46 +58,34 @@
</description>
</method>
<method name="set_instance_color">
<return type="void">
</return>
<argument index="0" name="instance" type="int">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<return type="void" />
<argument index="0" name="instance" type="int" />
<argument index="1" name="color" type="Color" />
<description>
Sets the color of a specific instance by [i]multiplying[/i] the mesh's existing vertex colors.
For the color to take effect, ensure that [member color_format] is non-[code]null[/code] on the [MultiMesh] and [member SpatialMaterial.vertex_color_use_as_albedo] is [code]true[/code] on the material.
</description>
</method>
<method name="set_instance_custom_data">
<return type="void">
</return>
<argument index="0" name="instance" type="int">
</argument>
<argument index="1" name="custom_data" type="Color">
</argument>
<return type="void" />
<argument index="0" name="instance" type="int" />
<argument index="1" name="custom_data" type="Color" />
<description>
Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 floating point numbers. The format of the number can change depending on the [enum CustomDataFormat] used.
</description>
</method>
<method name="set_instance_transform">
<return type="void">
</return>
<argument index="0" name="instance" type="int">
</argument>
<argument index="1" name="transform" type="Transform">
</argument>
<return type="void" />
<argument index="0" name="instance" type="int" />
<argument index="1" name="transform" type="Transform" />
<description>
Sets the [Transform] for a specific instance.
</description>
</method>
<method name="set_instance_transform_2d">
<return type="void">
</return>
<argument index="0" name="instance" type="int">
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<return type="void" />
<argument index="0" name="instance" type="int" />
<argument index="1" name="transform" type="Transform2D" />
<description>
Sets the [Transform2D] for a specific instance.
</description>