A script interface to a scene file's data.
    public abstract class SceneState : Reference

Maintains a list of resources, nodes, exported and overridden properties, and built-in scripts associated with a scene.

Inheritance Chain

Methods

    public Array GetConnectionBinds(int idx)

Returns the list of bound parameters for the signal at idx.

    public int GetConnectionCount()

Returns the number of signal connections in the scene.

    public int GetConnectionFlags(int idx)

Returns the flags for the signal at idx. See Object’s CONNECT_* flags.

    public string GetConnectionMethod(int idx)

Returns the method connected to the signal at idx.

    public string GetConnectionSignal(int idx)

Returns the name of the signal at idx.

    public NodePath GetConnectionSource(int idx)

Returns the path to the node that owns the signal at idx, relative to the root node.

    public NodePath GetConnectionTarget(int idx)

Returns the path to the node that owns the method connected to the signal at idx, relative to the root node.

    public int GetNodeCount()

Returns the number of nodes in the scene.

    public string[] GetNodeGroups(int idx)

Returns the list of group names associated with the node at idx.

    public int GetNodeIndex(int idx)

    public PackedScene GetNodeInstance(int idx)

Returns the scene for the node at idx or null if the node is not an instance.

    public string GetNodeInstancePlaceholder(int idx)

Returns the path to the represented scene file if the node at idx is an InstancePlaceholder.

    public string GetNodeName(int idx)

Returns the name of the node at idx.

    public NodePath GetNodeOwnerPath(int idx)

Returns the path to the owner of the node at idx, relative to the root node.

    public NodePath GetNodePath(int idx, bool forParent = false)

Returns the path to the node at idx.

    public int GetNodePropertyCount(int idx)

Returns the number of exported or overridden properties for the node at idx.

    public string GetNodePropertyName(int idx, int propIdx)

Returns the name of the property at propIdx for the node at idx.

    public object GetNodePropertyValue(int idx, int propIdx)

Returns the value of the property at propIdx for the node at idx.

    public string GetNodeType(int idx)

Returns the type of the node at idx.

    public bool IsNodeInstancePlaceholder(int idx)

Returns true if the node at idx is an InstancePlaceholder.

Inner Types

GenEditState

Name Value Description
Disabled 0 If passed to [method PackedScene.instance], blocks edits to the scene state.
Instance 1 If passed to [method PackedScene.instance], provides inherited scene resources to the local scene. Requires tools compiled.
Main 2 If passed to [method PackedScene.instance], provides local scene resources to the local scene. Only the main scene should receive the main edit state. Requires tools compiled.
Tags: