Struct gdnative::api::AnimationNodeStateMachine

pub struct AnimationNodeStateMachine { /* fields omitted */ }

core class AnimationNodeStateMachine inherits AnimationRootNode (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

AnimationNodeStateMachine inherits methods from:

• AnimationRootNode
• AnimationNode
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl AnimationNodeStateMachine

pub fn new() -> Ref<AnimationNodeStateMachine, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_node(
    &self,
    name: impl Into<GodotString>,
    node: impl AsArg<AnimationNode>,
    position: Vector2D<f32, UnknownUnit>
)

Adds a new node to the graph. The [code]position[/code] is used for display in the editor.

Default Arguments

• position - Vector2( 0, 0 )

pub fn add_transition(
    &self,
    from: impl Into<GodotString>,
    to: impl Into<GodotString>,
    transition: impl AsArg<AnimationNodeStateMachineTransition>
)

Adds a transition between the given nodes.

pub fn get_end_node(&self) -> GodotString

Returns the graph's end node.

pub fn get_graph_offset(&self) -> Vector2D<f32, UnknownUnit>

Returns the draw offset of the graph. Used for display in the editor.

pub fn get_node(
    &self,
    name: impl Into<GodotString>
) -> Option<Ref<AnimationNode, Shared>>

Returns the animation node with the given name.

pub fn get_node_name(&self, node: impl AsArg<AnimationNode>) -> GodotString

Returns the given animation node's name.

pub fn get_node_position(
    &self,
    name: impl Into<GodotString>
) -> Vector2D<f32, UnknownUnit>

Returns the given node's coordinates. Used for display in the editor.

pub fn get_start_node(&self) -> GodotString

Returns the graph's end node.

pub fn get_transition(
    &self,
    idx: i64
) -> Option<Ref<AnimationNodeStateMachineTransition, Shared>>

Returns the given transition.

pub fn get_transition_count(&self) -> i64

Returns the number of connections in the graph.

pub fn get_transition_from(&self, idx: i64) -> GodotString

Returns the given transition's start node.

pub fn get_transition_to(&self, idx: i64) -> GodotString

Returns the given transition's end node.

pub fn has_node(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if the graph contains the given node.

pub fn has_transition(
    &self,
    from: impl Into<GodotString>,
    to: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if there is a transition between the given nodes.

pub fn remove_node(&self, name: impl Into<GodotString>)

Deletes the given node from the graph.

pub fn remove_transition(
    &self,
    from: impl Into<GodotString>,
    to: impl Into<GodotString>
)

Deletes the transition between the two specified nodes.

pub fn remove_transition_by_index(&self, idx: i64)

Deletes the given transition by index.

pub fn rename_node(
    &self,
    name: impl Into<GodotString>,
    new_name: impl Into<GodotString>
)

Renames the given node.

pub fn replace_node(
    &self,
    name: impl Into<GodotString>,
    node: impl AsArg<AnimationNode>
)

Replaces the node and keeps its transitions unchanged.

pub fn set_end_node(&self, name: impl Into<GodotString>)

Sets the given node as the graph end point.

pub fn set_graph_offset(&self, offset: Vector2D<f32, UnknownUnit>)

Sets the draw offset of the graph. Used for display in the editor.

pub fn set_node_position(
    &self,
    name: impl Into<GodotString>,
    position: Vector2D<f32, UnknownUnit>
)

Sets the node's coordinates. Used for display in the editor.

pub fn set_start_node(&self, name: impl Into<GodotString>)

Sets the given node as the graph start point.

Methods from Deref<Target = AnimationRootNode>

Trait Implementations

impl Debug for AnimationNodeStateMachine

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

Formats the value using the given formatter.

impl Deref for AnimationNodeStateMachine

type Target = AnimationRootNode

The resulting type after dereferencing.

fn deref(&self) -> &AnimationRootNode

Dereferences the value.

impl DerefMut for AnimationNodeStateMachine

fn deref_mut(&mut self) -> &mut AnimationRootNode

Mutably dereferences the value.

impl GodotObject for AnimationNodeStateMachine

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for AnimationNodeStateMachine

fn construct() -> Ref<AnimationNodeStateMachine, Unique>

impl SubClass<AnimationNode> for AnimationNodeStateMachine

impl SubClass<AnimationRootNode> for AnimationNodeStateMachine

impl SubClass<Object> for AnimationNodeStateMachine

impl SubClass<Reference> for AnimationNodeStateMachine

impl SubClass<Resource> for AnimationNodeStateMachine