Struct gdnative::core_types::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::new.

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

More info at Godot’s official documentation

Implementations

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 new(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

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

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

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

pub fn get_subname_count(&self) -> i32

Returns the number of resource names in the path.

pub fn get_concatenated_subnames(&self) -> GodotString

pub fn to_godot_string(&self) -> GodotString

Returns the NodePath as a GodotString

Trait Implementations

impl CoerceFromVariant for NodePath

fn coerce_from_variant(v: &Variant) -> NodePath

impl Debug for NodePath

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

Formats the value using the given formatter.

impl Default for NodePath

fn default() -> NodePath

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NodePath

fn deserialize<D>(
    deserializer: D
) -> Result<NodePath, <D as Deserializer<'de>>::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for NodePath

fn drop(&mut self)

Executes the destructor for this type.

impl Export for NodePath

type Hint = NoHint

A type-specific hint type that is valid for the type being exported.

fn export_info(_hint: Option<<NodePath as Export>::Hint>) -> ExportInfo

Returns ExportInfo given an optional typed hint.

impl From<GodotString> for NodePath

fn from(s: GodotString) -> NodePath

Converts to this type from the input type.

impl From<NodePath> for GodotString

fn from(p: NodePath) -> GodotString

Converts to this type from the input type.

impl<S> From<S> for NodePathwhere
    S: AsRef<str>,

fn from(s: S) -> NodePath

Converts to this type from the input type.

impl FromVariant for NodePath

fn from_variant(variant: &Variant) -> Result<NodePath, FromVariantError>

impl NewRef for NodePath

fn new_ref(&self) -> NodePath

Creates a new reference to the underlying object.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NodePath

fn serialize<S>(
    &self,
    ser: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
    S: Serializer,

Serialize this value into the given Serde serializer.

impl ToString for NodePath

fn to_string(&self) -> String

Converts the given value to a String.

impl ToVariant for NodePath

fn to_variant(&self) -> Variant

impl Eq for NodePath

impl ToVariantEq for NodePath