mirror of
https://github.com/godotengine/godot.git
synced 2024-11-22 20:23:53 +00:00
81064cc239
We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
38 lines
2.5 KiB
XML
38 lines
2.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="InstancePlaceholder" inherits="Node" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Placeholder for the root [Node] of a [PackedScene].
|
|
</brief_description>
|
|
<description>
|
|
Turning on the option [b]Load As Placeholder[/b] for an instantiated scene in the editor causes it to be replaced by an [InstancePlaceholder] when running the game, this will not replace the node in the editor. This makes it possible to delay actually loading the scene until calling [method create_instance]. This is useful to avoid loading large scenes all at once by loading parts of it selectively.
|
|
The [InstancePlaceholder] does not have a transform. This causes any child nodes to be positioned relatively to the [Viewport] from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="create_instance">
|
|
<return type="Node" />
|
|
<param index="0" name="replace" type="bool" default="false" />
|
|
<param index="1" name="custom_scene" type="PackedScene" default="null" />
|
|
<description>
|
|
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">
|
|
<return type="String" />
|
|
<description>
|
|
Gets the path to the [PackedScene] resource file that is loaded by default when calling [method create_instance]. Not thread-safe. Use [method Object.call_deferred] if calling from a thread.
|
|
</description>
|
|
</method>
|
|
<method name="get_stored_values">
|
|
<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 [param with_order] 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>
|
|
</class>
|