SceneState

A script interface to a scene file's data.

Maintains a list of resources, nodes, exported, and overridden properties, and built-in scripts associated with a scene. This class cannot be instantiated directly, it is retrieved for a given scene as the result of PackedScene.getState.

@GodotBaseClass

struct SceneState {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(SceneState other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static SceneState _new();

enum GenEditState;

enum Constants;

Array getConnectionBinds(long idx);

long getConnectionCount();

long getConnectionFlags(long idx);

String getConnectionMethod(long idx);

String getConnectionSignal(long idx);

NodePath getConnectionSource(long idx);

NodePath getConnectionTarget(long idx);

long getNodeCount();

PoolStringArray getNodeGroups(long idx);

long getNodeIndex(long idx);

Ref!PackedScene getNodeInstance(long idx);

String getNodeInstancePlaceholder(long idx);

String getNodeName(long idx);

NodePath getNodeOwnerPath(long idx);

NodePath getNodePath(long idx, bool for_parent);

long getNodePropertyCount(long idx);

String getNodePropertyName(long idx, long prop_idx);

Variant getNodePropertyValue(long idx, long prop_idx);

String getNodeType(long idx);

bool isNodeInstancePlaceholder(long idx);

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
GenEditState enum GenEditState

Functions

getConnectionBinds Array getConnectionBinds(long idx): Returns the list of bound parameters for the signal at idx.
getConnectionCount long getConnectionCount(): 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 $(D 0, get_connection_count() - 1).
getConnectionFlags long getConnectionFlags(long idx): Returns the connection flags for the signal at idx. See GodotObject.connectflags constants.
getConnectionMethod String getConnectionMethod(long idx): Returns the method connected to the signal at idx.
getConnectionSignal String getConnectionSignal(long idx): Returns the name of the signal at idx.
getConnectionSource NodePath getConnectionSource(long idx): Returns the path to the node that owns the signal at idx, relative to the root node.
getConnectionTarget NodePath getConnectionTarget(long idx): Returns the path to the node that owns the method connected to the signal at idx, relative to the root node.
getNodeCount long getNodeCount(): Returns the number of nodes in the scene. The idx argument used to query node data in other get_node_* methods in the interval $(D 0, get_node_count() - 1).
getNodeGroups PoolStringArray getNodeGroups(long idx): Returns the list of group names associated with the node at idx.
getNodeIndex long getNodeIndex(long idx): 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 instanced 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.
getNodeInstance Ref!PackedScene getNodeInstance(long idx): 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.
getNodeInstancePlaceholder String getNodeInstancePlaceholder(long idx): Returns the path to the represented scene file if the node at idx is an InstancePlaceholder.
getNodeName String getNodeName(long idx): Returns the name of the node at idx.
getNodeOwnerPath NodePath getNodeOwnerPath(long idx): Returns the path to the owner of the node at idx, relative to the root node.
getNodePath NodePath getNodePath(long idx, bool for_parent): Returns the path to the node at idx. If for_parent is true, returns the path of the idx node's parent instead.
getNodePropertyCount long getNodePropertyCount(long idx): 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 $(D 0, get_node_property_count() - 1).
getNodePropertyName String getNodePropertyName(long idx, long prop_idx): Returns the name of the property at prop_idx for the node at idx.
getNodePropertyValue Variant getNodePropertyValue(long idx, long prop_idx): Returns the value of the property at prop_idx for the node at idx.
getNodeType String getNodeType(long idx): Returns the type of the node at idx.
isNodeInstancePlaceholder bool isNodeInstancePlaceholder(long idx): Returns true if the node at idx is an InstancePlaceholder.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(SceneState other)
opEquals bool opEquals(typeof(null) n)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new SceneState _new(): Construct a new instance of SceneState. Note: use memnew!SceneState instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

SceneState

From mixin baseCasts

From `mixin baseCasts`