Struct NodePath
pub struct NodePath { /* private fields */ }
Expand description
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§
Trait Implementations§
§impl ArrayElement for NodePath
impl ArrayElement for NodePath
fn debug_validate_elements(_array: &Array<Self>) -> Result<(), ConvertError>
§impl Export for NodePath
impl Export for NodePath
§fn export_hint() -> PropertyHintInfo
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>
fn as_node_class() -> Option<ClassName>
§impl From<&NodePath> for StringName
impl From<&NodePath> for StringName
§fn from(path: &NodePath) -> StringName
fn from(path: &NodePath) -> StringName
Converts to this type from the input type.
§impl From<&StringName> for NodePath
impl From<&StringName> for NodePath
§fn from(string_name: &StringName) -> NodePath
fn from(string_name: &StringName) -> NodePath
Converts to this type from the input type.
§impl From<NodePath> for StringName
impl From<NodePath> for StringName
§fn from(path: NodePath) -> 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<StringName> for NodePath
impl From<StringName> for NodePath
§fn from(string_name: StringName) -> 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
impl FromGodot for NodePath
§fn try_from_godot(
via: <NodePath as GodotConvert>::Via,
) -> Result<NodePath, ConvertError>
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
fn from_godot(via: Self::Via) -> Self
⚠️ Converts the Godot representation to this type. Read more
§fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>
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
fn from_variant(variant: &Variant) -> Self
§impl GodotConvert for NodePath
impl GodotConvert for NodePath
§impl ToGodot for NodePath
impl ToGodot for NodePath
§type ToVia<'v> = <NodePath as GodotConvert>::Via
type ToVia<'v> = <NodePath as GodotConvert>::Via
Target type of
to_godot()
, which differs from Via
for pass-by-reference types.§fn to_godot(&self) -> <NodePath as ToGodot>::ToVia<'_>
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
fn to_variant(&self) -> Variant
Converts this type to a Variant.
§impl Var for NodePath
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
fn var_hint() -> PropertyHintInfo
Specific property hints, only override if they deviate from
GodotType::property_info
, e.g. for enums/newtypes.impl Eq for NodePath
impl GodotType for NodePath
Auto Trait Implementations§
impl Freeze for NodePath
impl RefUnwindSafe for NodePath
impl !Send for NodePath
impl !Sync for NodePath
impl Unpin for NodePath
impl UnwindSafe for NodePath
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)