SceneState

Inherits: Reference < Object

场景文件数据的脚本接口。

描述

维护一个与场景相关的资源、节点、导出的和重写的属性以及内置脚本的列表。

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

方法

枚举

enum GenEditState:

• GEN_EDIT_STATE_DISABLED = 0 —- 如果传递给PackedScene.instance，则阻止对场景状态的编辑。

• GEN_EDIT_STATE_INSTANCE = 1 —- 如果传递给PackedScene.instance，提供继承的场景资源给本地场景。

注意： 只在编辑器构建中可用。

• GEN_EDIT_STATE_MAIN = 2 —- 如果传递给PackedScene.instance，向本地场景提供本地场景资源。只有主场景应该接收主编辑状态。

注意： 只在编辑器构建中可用。

• GEN_EDIT_STATE_MAIN_INHERITED = 3 —- If passed to PackedScene.instance, it’s similar to GEN_EDIT_STATE_MAIN, but for the case where the scene is being instantiated to be the base of another one.

Note: Only available in editor builds.

方法说明

• Array get_connection_binds ( int idx ) const

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

• int get_connection_count ( ) const

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

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

• int get_connection_flags ( int idx ) const

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

• String get_connection_method ( int idx ) const

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

• String get_connection_signal ( int idx ) const

返回 idx 处的信号名称。

• NodePath get_connection_source ( int idx ) const

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

• NodePath get_connection_target ( int idx ) const

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

• int get_node_count ( ) const

返回场景中节点的数量。

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

• PoolStringArray get_node_groups ( int idx ) const

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

• int get_node_index ( int idx ) const

返回节点的索引，即它相对于其兄弟节点的位置。这仅在将新节点添加到基础场景的兄弟节点之间的实例化或继承场景中的情况下，才关联并保存在场景中。尽管名称如此，但该索引与此处和其他方法中使用的 idx 参数无关。

• PackedScene get_node_instance ( int idx ) const

返回idx处的节点的PackedScene（即从该节点开始的整个分支，包括其子节点和资源），如果该节点不是一个实例，则返回null。

• String get_node_instance_placeholder ( int idx ) const

如果idx处的节点是一个InstancePlaceholder，返回所代表的场景文件的路径。

• String get_node_name ( int idx ) const

返回idx处的节点名称。

• NodePath get_node_owner_path ( int idx ) const

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

• NodePath get_node_path ( int idx, bool for_parent=false ) const

返回idx处的节点的路径。

如果for_parent是true，则返回idx节点的父节点的路径。

• int get_node_property_count ( int idx ) const

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

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

• String get_node_property_name ( int idx, int prop_idx ) const

返回prop_idx处的属性名称，用于idx处的节点。

• Variant get_node_property_value ( int idx, int prop_idx ) const

返回 idx 节点的 prop_idx 属性值。

• String get_node_type ( int idx ) const

返回idx处节点的类型。

• bool is_node_instance_placeholder ( int idx ) const

如果idx处的节点是一个InstancePlaceholder，返回true。