asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve InstancePlaceholder documentation

Browse source 
(cherry picked from commit 5acf30b538)
This commit is contained in:
Hugo Locurcio 2022-08-08 23:06:54 +02:00 committed by Rémi Verschelde
parent 284af7be96
commit 637330b866
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/classes/InstancePlaceholder.xml
View file

@ -15,7 +15,8 @@
<argument index="0" name="replace" type="bool" default="false" />
<argument 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" />
<argument 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>
<method name="replace_by_instance">