f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
43 lines
2.3 KiB
XML
43 lines
2.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="InstancePlaceholder" inherits="Node" version="3.4">
|
|
<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>
|
|
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>
|
|
</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>
|