SceneState
继承
简要描述
场景文件数据的脚本接口。
描述
维护资源，节点，导出和覆盖的属性以及与场景关联的内置脚本的列表。
此类不能直接实例化，它是根据PackedScene.get_state的结果针对给定场景检索的。
方法
| 返回值类型 | 方法名称 |
|---|---|
| Array | get_connection_binds(idx: int) const |
| int | get_connection_count() const |
| int | get_connection_flags(idx: int) const |
| String | get_connection_method(#method-get_connection_method)(idx: int) const |
| String | get_connection_signal(#method-get_connection_signal)(idx: int) const |
| NodePath | get_connection_source(idx: int) const |
| NodePath | get_connection_target(idx: int) const |
| int | get_node_count() const |
| PoolStringArray | get_node_groups(idx: int) const |
| int | get_node_index(idx: int) const |
| PackedScene | get_node_instance(idx: int) const |
| String | get_node_instance_placeholder(idx: int) const |
| String | get_node_name(idx: int) const |
| NodePath | get_node_owner_path(idx: int) const |
| NodePath | get_node_path(idx: int, for_parent: bool = false) const |
| int | get_node_property_count(idx: int) const |
| String | get_node_property_name(idx: int, prop_idx: int) const |
| Variant | get_node_property_value(idx: int, prop_idx: int) const |
| String | get_node_type(idx: int) const |
| bool | is_node_instance_placeholder(idx: int) const |
枚举
enum GenEditState:
- **GEN_EDIT_STATE_DISABLED = 0**
如果传递给PackedScene.instance，则将块编辑为场景状态。
- **GEN_EDIT_STATE_INSTANCE = 1**
如果传递给PackedScene.instance，则将继承的场景资源提供给本地场景。
注意：仅在编辑器版本中可用。
- **GEN_EDIT_STATE_MAIN = 2**
如果传递给PackedScene.instance，则将本地场景资源提供给本地场景。
注意：仅在编辑器版本中可用。
方法说明
- get_connection_binds get_connection_binds(idx: int) const
返回位于idx处的信号的绑定参数列表。
- get_connection_count get_connection_count() const
返回场景中信号连接的数量。
idx参数用于在间隔[0，get_connection_count（）-1]中查询其他get_connection_*方法中的连接元数据。
- get_connection_flags get_connection_flags(idx: int) const
返回idx处信号的连接标志。请参见Object.ConnectFlags常量。
- get_connection_method get_connection_method(idx: int) const
返回连接到idx处的信号的方法。
- get_connection_signal get_connection_signal(idx: int) const
返回idx处的信号名称。
- get_connection_source get_connection_source(idx: int) const
返回相对于根节点的，拥有idx信号的节点的路径。
- get_connection_target get_connection_target(idx: int) const
返回相对于根节点的路径，该节点拥有连接到idx处的信号的方法的节点。
- get_node_count get_node_count() const
返回场景中的节点数。
idx参数用于以[0，get_node_count（）-1]间隔查询其他get_node _ *方法中的节点数据。
- get_node_groups get_node_groups(idx: int) const
返回与idx上的节点关联的组名列表。
- get_node_index get_node_index(idx: int) const
返回节点的索引，该索引是其相对于其同级的位置。仅在将新节点添加到基础场景的同级中的实例或继承场景中的新节点的情况下，这才有意义并保存在场景中。 尽管有名称，但此索引与此处和其他方法中使用的idx参数无关。
- get_node_instance get_node_instance(idx: int) const
返回位于idx处的节点的PackedScene（即，从该节点开始的整个分支，及其子节点和资源），或者如果节点不是实例，则为null。
- get_node_instance_placeholder get_node_instance_placeholder(idx: int) const
如果idx处的节点是InstancePlaceholder，则返回到表示的场景文件的路径。
- get_node_name get_node_name(idx: int) const
返回位于idx的节点的名称。
- get_node_owner_path get_node_owner_path(idx: int) const
返回相对于根节点的位于idx的节点所有者的路径。
- get_node_path get_node_path(idx: int, for_parent: bool = false) const
返回节点在idx的路径。
如果for_parent为true，则返回idx节点父节点的路径。
- get_node_property_count get_node_property_count(idx: int) const
返回节点在idx处导出或覆盖的属性数。
prop_idx参数用于以[0，get_node_property_count（）-1]间隔查询其他get_node_property _ *方法中的节点属性数据。
- get_node_property_name get_node_property_name(idx: int, prop_idx: int) const
返回位于idx的节点的属性名称，位于prop_idx。
- get_node_property_value get_node_property_value(idx: int, prop_idx: int) const
返回位于idx的节点在prop_idx处的属性值。
- get_node_type get_node_type(idx: int) const
返回位于idx处的节点的类型。
- is_node_instance_placeholder is_node_instance_placeholder(idx: int) const
如果idx处的节点是InstancePlaceholder，则返回true。