NodePath

Category: Built-In Types

Brief Description

Pre-parsed scene tree path.

Member Functions

NodePath	NodePath ( String from )
String	get_name ( int idx )
int	get_name_count ( )
String	get_property ( )
String	get_subname ( int idx )
int	get_subname_count ( )
bool	is_absolute ( )
bool	is_empty ( )

Description

A pre-parsed relative or absolute path in a scene tree, for use with Node.get_node and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, "Path2D/PathFollow2D/Sprite:texture:size" would refer to the size property of the texture resource on the node named “Sprite” which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name.

You will usually just pass a string to Node.get_node and it will be automatically converted, but you may occasionally want to parse a path ahead of time with NodePath or the literal syntax @"path". Exporting a NodePath variable will give you a node selection widget in the properties panel of the editor, which can often be useful.

A NodePath is made up of a list of node names, a list of “subnode” (resource) names, and the name of a property in the final node or resource.

Member Function Description

NodePath NodePath ( String from )

Create a NodePath from a string, e.g. “Path2D/PathFollow2D/Sprite:texture:size”. A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, "." and ".." indicate the current node and its parent.

String get_name ( int idx )

Get the node name indicated by idx (0 to get_name_count)

int get_name_count ( )

Get the number of node names which make up the path.

String get_property ( )

Get the path’s property name, or an empty string if the path doesn’t have a property.

String get_subname ( int idx )

Get the resource name indicated by idx (0 to get_subname_count)

int get_subname_count ( )

Get the number of resource names in the path.

bool is_absolute ( )

Return true if the node path is absolute (not relative).

bool is_empty ( )

Return true if the node path is empty.