SceneState

继承: RefCounted < Object

提供对场景文件信息的访问。

描述

维护与场景关联的资源、节点、导出和覆盖属性以及内置脚本的列表。它们不能从SceneState修改,只能访问。用于在不实例化的情况下查看PackedScene包含的内容。

这个类不能直接实例化,它是作为PackedScene.get_state()的结果为给定场景检索的。

方法


枚举

enum GenEditState: 🔗

GenEditState GEN_EDIT_STATE_DISABLED = 0

如果传递给PackedScene.instantiate(),则阻止对场景状态的编辑。

GenEditState GEN_EDIT_STATE_INSTANCE = 1

如果传递给PackedScene.instantiate(),则将继承的场景资源提供给本地场景。

注意:仅在编辑器版本中可用。

GenEditState GEN_EDIT_STATE_MAIN = 2

如果传递给PackedScene.instantiate(),则向本地场景提供本地场景资源。只有主场景应该接收主编辑状态。

注意:仅在编辑器版本中可用。

GenEditState GEN_EDIT_STATE_MAIN_INHERITED = 3

如果传递给PackedScene.instantiate(),它类似于GEN_EDIT_STATE_MAIN,但对于场景被实例化为另一个场景的基础的情况。

注意:仅在编辑器版本中可用。


方法说明

Array get_connection_binds(idx: int) const 🔗

返回idx处信号的绑定参数列表。


int get_connection_count() const 🔗

返回场景中的信号连接数。

idx参数,用于查询间隔[0,get_connection_count()-1]中其他get_connection_*方法中的连接元数据。


int get_connection_flags(idx: int) const 🔗

返回idx处信号的连接标志。请参阅ConnectFlags常量。


StringName get_connection_method(idx: int) const 🔗

返回连接到idx处的信号的方法。


StringName get_connection_signal(idx: int) const 🔗

返回idx处的信号名称。


ItemPath get_connection_source(idx: int) const 🔗

返回相对于根节点在idx处拥有信号的节点的路径。


ItemPath get_connection_target(idx: int) const 🔗

返回到拥有连接到idx处信号的方法的节点的路径,相对于根节点。


int get_connection_unbinds(idx: int) const 🔗

返回idx处信号的未绑定参数数。


int get_node_count() const 🔗

返回场景中的节点数。

idx参数,用于在区间[0,get_node_count()-1]中查询其他get_node_*方法中的节点数据。


PackedStringArray get_node_groups(idx: int) const 🔗

返回与idx处的节点关联的组名称列表。


int get_node_index(idx: int) const 🔗

返回节点的索引,这是它相对于其兄弟姐妹的位置。这仅与将新节点添加到来自基本场景的兄弟姐妹之间的实例化或继承场景的情况相关并保存在场景中。尽管有名称,但此索引与此处和其他方法中使用的idx参数无关。


PackedScene get_node_instance(idx: int) const 🔗

返回idx处节点的PackedScene(即从该节点开始的整个分支,及其子节点和资源),如果节点不是实例,则返回null


String get_node_instance_placeholder(idx: int) const 🔗

如果idx处的节点是InstancePlaceholder,则返回表示的场景文件的路径。


StringName get_node_name(idx: int) const 🔗

返回idx处的节点名称。


ItemPath get_node_owner_path(idx: int) const 🔗

返回idx处节点所有者相对于根节点的路径。


ItemPath get_node_path(idx: int, for_parent: bool = false) const 🔗

返回idx处节点的路径。

如果for_parenttrue,则返回idx节点的父节点的路径。


int get_node_property_count(idx: int) const 🔗

返回idx处节点的导出或覆盖属性的数量。

prop_idx参数,用于在区间[0,get_node_property_count()-1]中查询其他get_node_property_*方法中的节点属性数据。


StringName get_node_property_name(idx: int, prop_idx: int) const 🔗

返回prop_idx处节点的属性名称。


Variant get_node_property_value(idx: int, prop_idx: int) const 🔗

返回prop_idx处节点的属性值。


StringName get_node_type(idx: int) const 🔗

返回idx处节点的类型。


bool is_node_instance_placeholder(idx: int) const 🔗

返回true如果idx处的节点是InstancePlaceholder