diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-04-20 20:03:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-20 20:03:24 +0200 |
| commit | d85fa253188024dc40fd36c3c574758a3052fc64 (patch) | |
| tree | eb636c98ed01acdad324d155c601deab64a5bceb | |
| parent | 7879e0494b6b38d2862c2be9f0a398bbd321224d (diff) | |
| parent | cf64bad63ec29369bada3b2cfed380da403a479a (diff) | |
Merge pull request #47953 from Calinou/doc-astar-thread-safety
Document `AStar.get_point_path()` not being thread-safe
| -rw-r--r-- | doc/classes/AStar.xml | 1 | ||||
| -rw-r--r-- | doc/classes/AStar2D.xml | 1 |
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"> |