Skip to content

Commit

Permalink
Improve InstancePlaceholder documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Calinou committed Aug 8, 2022
1 parent 682dbe5 commit 5acf30b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/classes/InstancePlaceholder.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand All @@ -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>
Expand Down

0 comments on commit 5acf30b

Please sign in to comment.