summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-04-16 16:03:22 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-04-16 16:04:17 +0200
commitcf64bad63ec29369bada3b2cfed380da403a479a (patch)
tree280c6848d14454708db92b536ab2330e2ca9df04 /doc
parent2e87857d758efb69989bc8c1cc5693f86df55d87 (diff)
Document `AStar.get_point_path()` not being thread-safe
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/AStar.xml1
-rw-r--r--doc/classes/AStar2D.xml1
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml
index e975b8ed28..533ecbd279 100644
--- a/doc/classes/AStar.xml
+++ b/doc/classes/AStar.xml
@@ -289,6 +289,7 @@
</argument>
<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.
+ [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>
</method>
<method name="get_point_position" qualifiers="const">
diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml
index 2a51678209..3efd2f604c 100644
--- a/doc/classes/AStar2D.xml
+++ b/doc/classes/AStar2D.xml
@@ -258,6 +258,7 @@
</argument>
<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.
+ [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>
</method>
<method name="get_point_position" qualifiers="const">