diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-08-09 01:02:25 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-09 01:02:25 +0200 |
| commit | 7355dfb502dbae6f13fbe42a9feeadb57affac0e (patch) | |
| tree | d99a3e665c7545bb493dbb8a0314e78912f4af63 /doc | |
| parent | f8383a7c72324eaed4e83891b6b93f82098fb8ab (diff) | |
| parent | 5acf30b5380d71472657fbba84cad8739a5d7c1e (diff) | |
Merge pull request #64127 from Calinou/doc-instanceplaceholder
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/InstancePlaceholder.xml | 5 |
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> |