Struct gdnative_visual_script::common::NodePath

pub struct NodePath(_);

A reference-counted 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.

"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.

If a string is passed to Node.get_node(), it will be automatically converted to a NodePath, but NodePath can be parsed ahead of time with NodePath::from_str() or NodePath::from_godot_string().

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

Methods

impl NodePath

pub fn from_str(path: &str) -> NodePath

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.

pub fn from_godot_string(path: &GodotString) -> NodePath

Create a NodePath from a GodotString.

pub fn is_empty(&self) -> bool

Returns true if the node path is empty.

pub fn is_absolute(&self) -> bool

Returns true if the node path is absolute.

pub fn name_count(&mut self) -> i32

pub fn subname(&self, idx: i32) -> GodotString

Returns the resource name of the specified idx, 0 to subname_count()

pub fn subname_count(&self) -> i32

Returns the number of resource names in the path.

pub fn concatenated_subnames(&self) -> GodotString

pub fn to_godot_string(&self) -> GodotString

Returns the NodePath as a GodotString

pub fn to_string(&self) -> String

Returns the NodePath as a String

pub fn new_ref(&self) -> NodePath

Trait Implementations

impl ToVariant for NodePath

fn to_variant(&self) -> Variant

fn from_variant(variant: &Variant) -> Option<NodePath>

impl Debug for NodePath

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'l> From<&'l NodePath> for Variant

fn from(val: &'l NodePath) -> Variant

Performs the conversion.

impl Eq for NodePath

impl Drop for NodePath

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<NodePath> for NodePath

fn eq(&self, other: &NodePath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.