You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2026-01-04 19:21:46 +00:00
doc: Use self-closing tags for return and argument
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
@@ -17,135 +17,101 @@
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="clear">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
Clear all cells.
|
||||
</description>
|
||||
</method>
|
||||
<method name="clear_baked_meshes">
|
||||
<return type="void">
|
||||
</return>
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bake_mesh_instance">
|
||||
<return type="RID">
|
||||
</return>
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<return type="RID" />
|
||||
<argument index="0" name="idx" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bake_meshes">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of [ArrayMesh]es and [Transform] references of all bake meshes that exist within the current GridMap.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cell_item" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
The [MeshLibrary] item index located at the grid-based X, Y and Z coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cell_item_orientation" qualifiers="const">
|
||||
<return type="int">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<return type="int" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_layer_bit" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<description>
|
||||
Returns an individual bit on the [member collision_layer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_collision_mask_bit" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<return type="bool" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<description>
|
||||
Returns an individual bit on the [member collision_mask].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_meshes">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of [Transform] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_used_cells" qualifiers="const">
|
||||
<return type="Array">
|
||||
</return>
|
||||
<return type="Array" />
|
||||
<description>
|
||||
Returns an array of [Vector3] with the non-empty cell coordinates in the grid map.
|
||||
</description>
|
||||
</method>
|
||||
<method name="make_baked_meshes">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="gen_lightmap_uv" type="bool" default="false">
|
||||
</argument>
|
||||
<argument index="1" name="lightmap_uv_texel_size" type="float" default="0.1">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="gen_lightmap_uv" type="bool" default="false" />
|
||||
<argument index="1" name="lightmap_uv_texel_size" type="float" default="0.1" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="map_to_world" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<description>
|
||||
Returns the position of a grid cell in the GridMap's local coordinate space.
|
||||
</description>
|
||||
</method>
|
||||
<method name="resource_changed">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="resource" type="Resource">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="resource" type="Resource" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_cell_item">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="x" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="y" type="int">
|
||||
</argument>
|
||||
<argument index="2" name="z" type="int">
|
||||
</argument>
|
||||
<argument index="3" name="item" type="int">
|
||||
</argument>
|
||||
<argument index="4" name="orientation" type="int" default="0">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="x" type="int" />
|
||||
<argument index="1" name="y" type="int" />
|
||||
<argument index="2" name="z" type="int" />
|
||||
<argument index="3" name="item" type="int" />
|
||||
<argument index="4" name="orientation" type="int" default="0" />
|
||||
<description>
|
||||
Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates.
|
||||
A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell.
|
||||
@@ -153,46 +119,33 @@
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_clip">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="enabled" type="bool">
|
||||
</argument>
|
||||
<argument index="1" name="clipabove" type="bool" default="true">
|
||||
</argument>
|
||||
<argument index="2" name="floor" type="int" default="0">
|
||||
</argument>
|
||||
<argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="enabled" type="bool" />
|
||||
<argument index="1" name="clipabove" type="bool" default="true" />
|
||||
<argument index="2" name="floor" type="int" default="0" />
|
||||
<argument index="3" name="axis" type="int" enum="Vector3.Axis" default="0" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_layer_bit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
Sets an individual bit on the [member collision_layer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_collision_mask_bit">
|
||||
<return type="void">
|
||||
</return>
|
||||
<argument index="0" name="bit" type="int">
|
||||
</argument>
|
||||
<argument index="1" name="value" type="bool">
|
||||
</argument>
|
||||
<return type="void" />
|
||||
<argument index="0" name="bit" type="int" />
|
||||
<argument index="1" name="value" type="bool" />
|
||||
<description>
|
||||
Sets an individual bit on the [member collision_mask].
|
||||
</description>
|
||||
</method>
|
||||
<method name="world_to_map" qualifiers="const">
|
||||
<return type="Vector3">
|
||||
</return>
|
||||
<argument index="0" name="pos" type="Vector3">
|
||||
</argument>
|
||||
<return type="Vector3" />
|
||||
<argument index="0" name="pos" type="Vector3" />
|
||||
<description>
|
||||
Returns the coordinates of the grid cell containing the given point.
|
||||
[code]pos[/code] should be in the GridMap's local coordinate space.
|
||||
@@ -236,8 +189,7 @@
|
||||
</members>
|
||||
<signals>
|
||||
<signal name="cell_size_changed">
|
||||
<argument index="0" name="cell_size" type="Vector3">
|
||||
</argument>
|
||||
<argument index="0" name="cell_size" type="Vector3" />
|
||||
<description>
|
||||
Emitted when [member cell_size] changes.
|
||||
</description>
|
||||
|
||||
Reference in New Issue
Block a user