Struct NodePath

pub struct NodePath { /* private fields */ }

A pre-parsed scene tree path.

Null bytes

Note that Godot ignores any bytes after a null-byte. This means that for instance "hello, world!" and "hello, world!\0 ignored by Godot" will be treated as the same string if converted to a NodePath.

All string types

Intended use case	String type
General purpose	GString
Interned names	StringName
Scene-node paths	NodePath

Implementations

impl NodePath

pub fn is_empty(&self) -> bool

pub fn hash(&self) -> u32

Returns a 32-bit integer hash value representing the string.

pub fn arg<T>(&self) -> impl AsArg<T>

where T: for<'a> From<&'a NodePath> + for<'a> ApiParam<Arg<'a> = CowArg<'a, T>> + 'a,

Use as argument for an impl AsArg<GString|StringName> parameter.

This is a convenient way to convert arguments of similar string types.

Example

PackedStringArray can insert elements using AsArg<GString>, so let’s pass a NodePath:

let node_path = NodePath::from("Node2D/Label");

let mut array = PackedStringArray::new();
array.push(node_path.arg());

Generic bounds

The bounds are implementation-defined and may change at any time. Do not use this function in a generic context requiring T – use the From trait or ApiParam in that case.

Trait Implementations

impl ApiParam for NodePath

fn owned_to_arg<'v>(self) -> <NodePath as ApiParam>::Arg<'v>

Converts an owned value to the canonical argument type, which can be passed to impl AsArg<T>.

impl ArrayElement for NodePath

fn debug_validate_elements(_array: &Array<Self>) -> Result<(), ConvertError>

impl Clone for NodePath

fn clone(&self) -> NodePath

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NodePath

Uses literal syntax from GDScript: ^"node_path"

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 Display for NodePath

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

Formats the value using the given formatter.

impl Drop for NodePath

fn drop(&mut self)

Executes the destructor for this type.

impl Export for NodePath

fn export_hint() -> PropertyHintInfo

The export info to use for an exported field of this type, if no other export info is specified.

fn as_node_class() -> Option<ClassName>

If this is a class inheriting Node, returns the ClassName; otherwise None.

impl From<&GString> for NodePath

fn from(string: &GString) -> NodePath

Converts to this type from the input type.

impl From<&NodePath> for GString

fn from(path: &NodePath) -> GString

Converts to this type from the input type.

impl From<&NodePath> for StringName

fn from(path: &NodePath) -> StringName

Converts to this type from the input type.

impl From<&String> for NodePath

fn from(s: &String) -> NodePath

Converts to this type from the input type.

impl From<&StringName> for NodePath

fn from(string_name: &StringName) -> NodePath

Converts to this type from the input type.

impl From<&str> for NodePath

fn from(s: &str) -> NodePath

Converts to this type from the input type.

impl From<GString> for NodePath

fn from(string: GString) -> NodePath

Converts this GString to a NodePath.

This is identical to NodePath::from(&string), and as such there is no performance benefit.

impl From<NodePath> for GString

fn from(path: NodePath) -> GString

Converts this NodePath to a GString.

This is identical to GString::from(&path), and as such there is no performance benefit.

impl From<NodePath> for StringName

fn from(path: NodePath) -> StringName

Converts this NodePath to a StringName.

This is identical to StringName::from(&path), and as such there is no performance benefit.

impl From<String> for NodePath

fn from(s: String) -> NodePath

Converts to this type from the input type.

impl From<StringName> for NodePath

fn from(string_name: StringName) -> NodePath

Converts this StringName to a NodePath.

This is identical to NodePath::from(&string_name), and as such there is no performance benefit.

impl FromGodot for NodePath

fn try_from_godot( via: <NodePath as GodotConvert>::Via, ) -> Result<NodePath, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl FromStr for NodePath

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<NodePath, <NodePath as FromStr>::Err>

Parses a string s to return a value of this type.

impl GodotConvert for NodePath

type Via = NodePath

The type through which Self is represented in Godot.

impl Hash for NodePath

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NodePath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToGodot for NodePath

type ToVia<'v> = <NodePath as GodotConvert>::Via

Target type of to_godot(), which can differ from Via for pass-by-reference types.

fn to_godot(&self) -> <NodePath as ToGodot>::ToVia<'_>

Converts this type to the Godot type by reference, usually by cloning.

fn to_variant(&self) -> Variant

Converts this type to a Variant.

impl Var for NodePath

fn get_property(&self) -> <NodePath as GodotConvert>::Via

fn set_property(&mut self, value: <NodePath as GodotConvert>::Via)

fn var_hint() -> PropertyHintInfo

Specific property hints, only override if they deviate from GodotType::property_info, e.g. for enums/newtypes.

impl<'r> AsArg<NodePath> for &'r NodePath

impl AsArg<NodePath> for &String

impl AsArg<NodePath> for &str

impl Eq for NodePath

impl GodotType for NodePath