Document `AStar.get_point_path()` not being thread-safe

This commit is contained in:
Hugo Locurcio 2021-04-16 16:03:22 +02:00
parent 2e87857d75
commit cf64bad63e
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
2 changed files with 2 additions and 0 deletions

View File

@ -289,6 +289,7 @@
</argument> </argument>
<description> <description>
Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
[b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector2Array] and will print an error message.
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">

View File

@ -258,6 +258,7 @@
</argument> </argument>
<description> <description>
Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
[b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector2Array] and will print an error message.
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">