Provides access to a scene file's information.
Maintains a list of resources, nodes, exported and overridden properties, and built-in scripts associated with a scene. They cannot be modified from a SceneState, only accessed. Useful for peeking into what a PackedScene contains without instantiating it.
This class cannot be instantiated directly, it is retrieved for a given scene as the result of PackedScene.get_state().
Returns the SceneState of the scene that this scene inherits from, or null if it doesn't inherit from any scene.
Returns the number of signal connections in the scene.
The idx argument used to query connection metadata in other get_connection_* methods in the interval [0, get_connection_count() - 1].
Returns the connection flags for the signal at idx. See Object.ConnectFlags constants.
Returns the path to the node that owns the method connected to the signal at idx, relative to the root node.
Returns the number of nodes in the scene.
The idx argument used to query node data in other get_node_* methods in the interval [0, get_node_count() - 1].
Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instantiated or inherited scene among siblings from the base scene. Despite the name, this index is not related to the idx argument used here and in other methods.
Returns a PackedScene for the node at idx (i.e. the whole branch starting at this node, with its child nodes and resources), or null if the node is not an instance.
Returns the path to the represented scene file if the node at idx is an InstancePlaceholder.
Returns the path to the node at idx.
If for_parent is true, returns the path of the idx node's parent instead.
Returns the number of exported or overridden properties for the node at idx.
The prop_idx argument used to query node property data in other get_node_property_* methods in the interval [0, get_node_property_count() - 1].
Returns true if the node at idx is an InstancePlaceholder.
GEN_EDIT_STATE_DISABLED = 0If passed to PackedScene.instantiate(), blocks edits to the scene state.
GEN_EDIT_STATE_INSTANCE = 1If passed to PackedScene.instantiate(), provides inherited scene resources to the local scene.
Note: Only available in editor builds.
GEN_EDIT_STATE_MAIN = 2If passed to PackedScene.instantiate(), provides local scene resources to the local scene. Only the main scene should receive the main edit state.
Note: Only available in editor builds.
GEN_EDIT_STATE_MAIN_INHERITED = 3If passed to PackedScene.instantiate(), 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.