Przeglądaj źródła

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

Hugo Locurcio 4 lat temu
rodzic
commit
cf64bad63e
2 zmienionych plików z 2 dodań i 0 usunięć
  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">