Browse Source

Merge pull request #64127 from Calinou/doc-instanceplaceholder

Rémi Verschelde 3 years ago
parent
commit
7355dfb502
1 changed files with 4 additions and 1 deletions
  1. 4 1
      doc/classes/InstancePlaceholder.xml

+ 4 - 1
doc/classes/InstancePlaceholder.xml

@@ -15,7 +15,8 @@
 			<param index="0" name="replace" type="bool" default="false" />
 			<param index="0" name="replace" type="bool" default="false" />
 			<param index="1" name="custom_scene" type="PackedScene" default="null" />
 			<param index="1" name="custom_scene" type="PackedScene" default="null" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 		<method name="get_instance_path" qualifiers="const">
 		<method name="get_instance_path" qualifiers="const">
@@ -28,6 +29,8 @@
 			<return type="Dictionary" />
 			<return type="Dictionary" />
 			<param index="0" name="with_order" type="bool" default="false" />
 			<param index="0" name="with_order" type="bool" default="false" />
 			<description>
 			<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>
 			</description>
 		</method>
 		</method>
 	</methods>
 	</methods>