InstancePlaceholder
Placeholder for the root Node
of a PackedScene
.
描述
Turning on the option Load As Placeholder 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 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.
方法
Node | create_instance ( replace: bool = false, custom_scene: PackedScene = null ) |
String | get_instance_path ( ) const1 |
Dictionary | get_stored_values ( with_order: bool = false ) |
方法说明
Node
create_instance ( replace: bool
= false, custom_scene: PackedScene
= 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 ( ) const1
Gets the path to the PackedScene
resource file that is loaded by default when calling create_instance
. Not thread-safe. Use Object.call_deferred
if calling from a thread.
Dictionary
get_stored_values ( with_order: bool
= 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).
本方法通常需要用户覆盖才能生效。
本方法无副作用,不会修改该实例的任何成员变量。
本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。
本方法用于构造某个类型。
调用本方法无需实例,可直接使用类名进行调用。
本方法描述的是使用本类型作为左操作数的有效运算符。
这个值是由下列位标志构成位掩码的整数。
无返回值。