virtualx-engine/doc/classes/PolygonPathFinder.xml
Rémi Verschelde f5836b40d4
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)
2021-08-03 10:20:19 +02:00

64 lines
1.8 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PolygonPathFinder" inherits="Resource" version="3.4">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="find_path">
<return type="PoolVector2Array" />
<argument index="0" name="from" type="Vector2" />
<argument index="1" name="to" type="Vector2" />
<description>
</description>
</method>
<method name="get_bounds" qualifiers="const">
<return type="Rect2" />
<description>
</description>
</method>
<method name="get_closest_point" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="point" type="Vector2" />
<description>
</description>
</method>
<method name="get_intersections" qualifiers="const">
<return type="PoolVector2Array" />
<argument index="0" name="from" type="Vector2" />
<argument index="1" name="to" type="Vector2" />
<description>
</description>
</method>
<method name="get_point_penalty" qualifiers="const">
<return type="float" />
<argument index="0" name="idx" type="int" />
<description>
</description>
</method>
<method name="is_point_inside" qualifiers="const">
<return type="bool" />
<argument index="0" name="point" type="Vector2" />
<description>
</description>
</method>
<method name="set_point_penalty">
<return type="void" />
<argument index="0" name="idx" type="int" />
<argument index="1" name="penalty" type="float" />
<description>
</description>
</method>
<method name="setup">
<return type="void" />
<argument index="0" name="points" type="PoolVector2Array" />
<argument index="1" name="connections" type="PoolIntArray" />
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>