summaryrefslogtreecommitdiff
path: root/doc/classes/NavigationPolygon.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:28:05 +0200
committerRémi Verschelde <rverschelde@gmail.com>2021-07-30 15:29:52 +0200
commit7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch)
tree0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/NavigationPolygon.xml
parenta1c19b9a1e53f78c75c13cb418270db80057b21a (diff)
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.
Diffstat (limited to 'doc/classes/NavigationPolygon.xml')
-rw-r--r--doc/classes/NavigationPolygon.xml72
1 files changed, 24 insertions, 48 deletions
diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml
index 38921078d7..e1e2c34a63 100644
--- a/doc/classes/NavigationPolygon.xml
+++ b/doc/classes/NavigationPolygon.xml
@@ -47,119 +47,95 @@
</tutorials>
<methods>
<method name="add_outline">
- <return type="void">
- </return>
- <argument index="0" name="outline" type="PackedVector2Array">
- </argument>
+ <return type="void" />
+ <argument index="0" name="outline" type="PackedVector2Array" />
<description>
Appends a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use.
</description>
</method>
<method name="add_outline_at_index">
- <return type="void">
- </return>
- <argument index="0" name="outline" type="PackedVector2Array">
- </argument>
- <argument index="1" name="index" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="outline" type="PackedVector2Array" />
+ <argument index="1" name="index" type="int" />
<description>
Adds a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use.
</description>
</method>
<method name="add_polygon">
- <return type="void">
- </return>
- <argument index="0" name="polygon" type="PackedInt32Array">
- </argument>
+ <return type="void" />
+ <argument index="0" name="polygon" type="PackedInt32Array" />
<description>
Adds a polygon using the indices of the vertices you get when calling [method get_vertices].
</description>
</method>
<method name="clear_outlines">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them.
</description>
</method>
<method name="clear_polygons">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Clears the array of polygons, but it doesn't clear the array of outlines and vertices.
</description>
</method>
<method name="get_outline" qualifiers="const">
- <return type="PackedVector2Array">
- </return>
- <argument index="0" name="idx" type="int">
- </argument>
+ <return type="PackedVector2Array" />
+ <argument index="0" name="idx" type="int" />
<description>
Returns a [PackedVector2Array] containing the vertices of an outline that was created in the editor or by script.
</description>
</method>
<method name="get_outline_count" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Returns the number of outlines that were created in the editor or by script.
</description>
</method>
<method name="get_polygon">
- <return type="PackedInt32Array">
- </return>
- <argument index="0" name="idx" type="int">
- </argument>
+ <return type="PackedInt32Array" />
+ <argument index="0" name="idx" type="int" />
<description>
Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon.
</description>
</method>
<method name="get_polygon_count" qualifiers="const">
- <return type="int">
- </return>
+ <return type="int" />
<description>
Returns the count of all polygons.
</description>
</method>
<method name="get_vertices" qualifiers="const">
- <return type="PackedVector2Array">
- </return>
+ <return type="PackedVector2Array" />
<description>
Returns a [PackedVector2Array] containing all the vertices being used to create the polygons.
</description>
</method>
<method name="make_polygons_from_outlines">
- <return type="void">
- </return>
+ <return type="void" />
<description>
Creates polygons from the outlines added in the editor or by script.
</description>
</method>
<method name="remove_outline">
- <return type="void">
- </return>
- <argument index="0" name="idx" type="int">
- </argument>
+ <return type="void" />
+ <argument index="0" name="idx" type="int" />
<description>
Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
</description>
</method>
<method name="set_outline">
- <return type="void">
- </return>
- <argument index="0" name="idx" type="int">
- </argument>
- <argument index="1" name="outline" type="PackedVector2Array">
- </argument>
+ <return type="void" />
+ <argument index="0" name="idx" type="int" />
+ <argument index="1" name="outline" type="PackedVector2Array" />
<description>
Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update.
</description>
</method>
<method name="set_vertices">
- <return type="void">
- </return>
- <argument index="0" name="vertices" type="PackedVector2Array">
- </argument>
+ <return type="void" />
+ <argument index="0" name="vertices" type="PackedVector2Array" />
<description>
Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method.
</description>