mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-24 04:46:48 +01:00
47 lines
2.9 KiB
XML
47 lines
2.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="InstancePlaceholder" inherits="Node" version="3.8">
|
|
<brief_description>
|
|
Placeholder for the root [Node] of a [PackedScene].
|
|
</brief_description>
|
|
<description>
|
|
Turning on the option [b]Load As Placeholder[/b] for an instanced scene in the editor causes it to be replaced by an InstancePlaceholder when running the game. This makes it possible to delay actually loading the scene until calling [method replace_by_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" />
|
|
<argument index="0" name="replace" type="bool" default="false" />
|
|
<argument 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 replace_by_instance]. Not thread-safe. Use [method Object.call_deferred] if calling from a thread.
|
|
</description>
|
|
</method>
|
|
<method name="get_stored_values">
|
|
<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">
|
|
<return type="void" />
|
|
<argument index="0" name="custom_scene" type="PackedScene" default="null" />
|
|
<description>
|
|
Replaces this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|