Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
Table of contents
-
const func get_connection_binds(idx: int) -> Array -
const func get_connection_count() -> int -
const func get_connection_flags(idx: int) -> int -
const func get_connection_method(idx: int) -> StringName -
const func get_connection_signal(idx: int) -> StringName -
const func get_connection_source(idx: int) -> NodePath -
const func get_connection_target(idx: int) -> NodePath -
const func get_connection_unbinds(idx: int) -> int -
const func get_node_count() -> int -
const func get_node_groups(idx: int) -> PackedStringArray -
const func get_node_index(idx: int) -> int -
const func get_node_instance(idx: int) -> PackedScene -
const func get_node_instance_placeholder(idx: int) -> String -
const func get_node_name(idx: int) -> StringName -
const func get_node_owner_path(idx: int) -> NodePath -
const func get_node_path(for_parent: bool = false) -> NodePath -
const func get_node_property_count(idx: int) -> int -
const func get_node_property_name(prop_idx: int) -> StringName -
const func get_node_property_value(prop_idx: int) -> Variant -
const func get_node_type(idx: int) -> StringName -
const func is_node_instance_placeholder(idx: int) -> bool -
const GEN_EDIT_STATE_DISABLED = 0 enum GenEditState -
const GEN_EDIT_STATE_INSTANCE = 1 enum GenEditState -
const GEN_EDIT_STATE_MAIN = 2 enum GenEditState -
const GEN_EDIT_STATE_MAIN_INHERITED = 3 enum GenEditState -
enum GenEditState
SceneState #
is_refcounted, core, not_builtin_classes
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.
Members #
Methods #
const func get_connection_binds(idx: int) -> Array#
Returns the list of bound parameters for the signal at idx.
const func get_connection_count() -> int#
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].
const func get_connection_flags(idx: int) -> int#
Returns the connection flags for the signal at idx. See Object.ConnectFlags constants.
const func get_connection_method(idx: int) -> StringName#
Returns the method connected to the signal at idx.
const func get_connection_signal(idx: int) -> StringName#
Returns the name of the signal at idx.
const func get_connection_source(idx: int) -> NodePath#
Returns the path to the node that owns the signal at idx, relative to the root node.
const func get_connection_target(idx: int) -> NodePath#
Returns the path to the node that owns the method connected to the signal at idx, relative to the root node.
const func get_connection_unbinds(idx: int) -> int#
Returns the number of unbound parameters for the signal at idx.
const func get_node_count() -> int#
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].
const func get_node_groups(idx: int) -> PackedStringArray#
Returns the list of group names associated with the node at idx.
const func get_node_index(idx: int) -> int#
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.
const func get_node_instance(idx: int) -> PackedScene#
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.
const func get_node_instance_placeholder(idx: int) -> String#
Returns the path to the represented scene file if the node at idx is an InstancePlaceholder.
const func get_node_name(idx: int) -> StringName#
Returns the name of the node at idx.
const func get_node_owner_path(idx: int) -> NodePath#
Returns the path to the owner of the node at idx, relative to the root node.
const func get_node_path(for_parent: bool = false) -> NodePath#
Returns the path to the node at idx.
If for_parent is true, returns the path of the idx node's parent instead.
const func get_node_property_count(idx: int) -> int#
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].
const func get_node_property_name(prop_idx: int) -> StringName#
Returns the name of the property at prop_idx for the node at idx.
const func get_node_property_value(prop_idx: int) -> Variant#
Returns the value of the property at prop_idx for the node at idx.
const func get_node_type(idx: int) -> StringName#
Returns the type of the node at idx.
const func is_node_instance_placeholder(idx: int) -> bool#
Returns true if the node at idx is an InstancePlaceholder.
Annotations #
Constants #
const GEN_EDIT_STATE_DISABLED = 0 enum GenEditState#
If passed to PackedScene.instantiate, blocks edits to the scene state.
const GEN_EDIT_STATE_INSTANCE = 1 enum GenEditState#
If passed to PackedScene.instantiate, provides inherited scene resources to the local scene.
Note: Only available in editor builds.
const GEN_EDIT_STATE_MAIN = 2 enum GenEditState#
If 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.
const GEN_EDIT_STATE_MAIN_INHERITED = 3 enum GenEditState#
If 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.
Constructors #
Enums #
GenEditState#
enum GenEditState {
GEN_EDIT_STATE_DISABLED = 0,
GEN_EDIT_STATE_INSTANCE = 1,
GEN_EDIT_STATE_MAIN = 2,
GEN_EDIT_STATE_MAIN_INHERITED = 3,
}