Browse Source

Merge pull request #47953 from Calinou/doc-astar-thread-safety

Document `AStar.get_point_path()` not being thread-safe
Rémi Verschelde 4 năm trước cách đây
mục cha
commit
d85fa25318
2 tập tin đã thay đổi với 2 bổ sung0 xóa
  1. 1 0
      doc/classes/AStar.xml
  2. 1 0
      doc/classes/AStar2D.xml

+ 1 - 0
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">

+ 1 - 0
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">