NodePath

    A pre-parsed relative or absolute path in a scene tree, for use with and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, 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.

    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 composed of a list of slash-separated node names (like a filesystem path) and an optional colon-separated list of “subnames” which can be resources or properties.

    Some examples of NodePaths include the following:

    Note: In the editor, NodePath properties are automatically updated when moving, renaming or deleting a node in the scene tree, but they are never updated at runtime.

    The “subnames” optionally included after the path to the target node can point to resources or properties, and can also be nested.

    Examples of valid NodePaths (assuming that those nodes exist and have the referenced resources or properties):

    1. # Points to the Sprite node
    3. # Points to the Sprite node and its "texture" resource.
    4. # would retrieve both the Sprite node and the "texture" resource.
    5. "Path2D/PathFollow2D/Sprite:texture"
    6. # Points to the Sprite node and its "position" property.
    7. "Path2D/PathFollow2D/Sprite:position"
    8. # Points to the Sprite node and the "x" component of its "position" property.
    9. "Path2D/PathFollow2D/Sprite:position:x"
    10. # Absolute path (from "root")
    11. "/root/Level/Path2D"
    • get_as_property_path ( )

    Returns a node path with a colon character (:) prepended, transforming it to a pure property path with no node name (defaults to resolving from the current node).

    Returns all subnames concatenated with a colon character (:) as separator, i.e. the right side of the first colon in a node path.

    2. print(nodepath.get_concatenated_subnames()) # texture:load_path

    Gets the node name indicated by idx (0 to get_name_count - 1).

    • get_name_count ( )

    Gets the number of node names which make up the path. Subnames (see get_subname_count) are not included.

    For example, "Path2D/PathFollow2D/Sprite" has 3 names.

    • get_subname ( int idx )

    Gets the resource or property name indicated by idx (0 to ).

    1. var node_path = NodePath("Path2D/PathFollow2D/Sprite:texture:load_path")
    2. print(node_path.get_subname(0)) # texture
    3. print(node_path.get_subname(1)) # load_path
    • int get_subname_count ( )

    Gets the number of resource or property names (“subnames”) in the path. Each subname is listed after a colon character (:) in the node path.

    For example, "Path2D/PathFollow2D/Sprite:texture:load_path" has 2 subnames.

    Returns true if the node path is absolute (as opposed to relative), which means that it starts with a slash character (/). Absolute node paths can be used to access the root node ("/root") or autoloads (e.g. if a “global” autoload was registered).

    • is_empty ( )