InstancePlaceholder¶
Placeholder for the root Node of a PackedScene.
Description¶
Turning on the option Load As Placeholder 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 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.
Methods¶
create_instance ( bool replace=false, PackedScene custom_scene=null ) |
|
get_instance_path ( ) const |
|
get_stored_values ( bool with_order=false ) |
|
void |
replace_by_instance ( PackedScene custom_scene=null ) |
Method Descriptions¶
Node create_instance ( bool replace=false, PackedScene custom_scene=null )
Call this method to actually load in the node. The created node will be placed as a sibling above the InstancePlaceholder in the scene tree. The Node's reference is also returned for convenience.
Note: create_instance is not thread-safe. Use Object.call_deferred if calling from a thread.
String get_instance_path ( ) const
Gets the path to the PackedScene resource file that is loaded by default when calling replace_by_instance. Not thread-safe. Use Object.call_deferred if calling from a thread.
Dictionary get_stored_values ( bool with_order=false )
Returns the list of properties that will be applied to the node when create_instance is called.
If with_order is true, a key named .order (note the leading period) is added to the dictionary. This .order key is an Array of String property names specifying the order in which properties will be applied (with index 0 being the first).
void replace_by_instance ( PackedScene custom_scene=null )
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.