Browse Source

Document InstancePlaceholder.create_instance not being thread-safe.

(cherry picked from commit a6f3ef3ac7306a887ad607fb22f8fde5defdf41e)
Wilson E. Alvarez 4 years ago
parent
commit
aa6406874e
1 changed files with 2 additions and 1 deletions
  1. 2 1
      doc/classes/InstancePlaceholder.xml

+ 2 - 1
doc/classes/InstancePlaceholder.xml

@@ -18,13 +18,14 @@
 			<argument index="1" name="custom_scene" type="PackedScene" default="null">
 			</argument>
 			<description>
+				Not thread-safe. Use [method Object.call_deferred] if calling from a thread.
 			</description>
 		</method>
 		<method name="get_instance_path" qualifiers="const">
 			<return type="String">
 			</return>
 			<description>
-				Gets the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance].
+				Gets the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance]. Not thread-safe. Use [method Object.call_deferred] if calling from a thread.
 			</description>
 		</method>
 		<method name="get_stored_values">