mirror of
https://github.com/godotengine/godot.git
synced 2024-10-23 13:41:43 +00:00
b68dd2e189
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
35 lines
1.9 KiB
XML
35 lines
1.9 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="InstancePlaceholder" inherits="Node" version="4.0" 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" />
|
|
<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 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" />
|
|
<argument index="0" name="with_order" type="bool" default="false" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|