summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/classes/InstancePlaceholder.xml5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml
index f6d9c835d1..698ddcb021 100644
--- a/doc/classes/InstancePlaceholder.xml
+++ b/doc/classes/InstancePlaceholder.xml
@@ -15,7 +15,8 @@
<param index="0" name="replace" type="bool" default="false" />
<param index="1" name="custom_scene" type="PackedScene" default="null" />
<description>
- Not thread-safe. Use [method Object.call_deferred] if calling from a thread.
+ Call this method to actually load in the node. The created node will be placed as a sibling [i]above[/i] the [InstancePlaceholder] in the scene tree. The [Node]'s reference is also returned for convenience.
+ [b]Note:[/b] [method create_instance] is not thread-safe. Use [method Object.call_deferred] if calling from a thread.
</description>
</method>
<method name="get_instance_path" qualifiers="const">
@@ -28,6 +29,8 @@
<return type="Dictionary" />
<param index="0" name="with_order" type="bool" default="false" />
<description>
+ Returns the list of properties that will be applied to the node when [method create_instance] is called.
+ If [code]with_order[/code] is [code]true[/code], a key named [code].order[/code] (note the leading period) is added to the dictionary. This [code].order[/code] key is an [Array] of [String] property names specifying the order in which properties will be applied (with index 0 being the first).
</description>
</method>
</methods>