Struct gdnative_bindings_lily::AnimationNodeTransition

pub struct AnimationNodeTransition { /* fields omitted */ }

core class AnimationNodeTransition inherits AnimationNode (reference counted).

Official documentation

See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.

Memory management

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

Class hierarchy

AnimationNodeTransition inherits methods from:

• 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 AnimationNodeTransition

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

Creates a new instance of this object.

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

pub fn cross_fade_time(&self) -> f64

Cross-fading time (in seconds) between each animation connected to the inputs.

pub fn enabled_inputs(&self) -> i64

The number of available input ports for this node.

pub fn input_caption(&self, input: i64) -> GodotString

pub fn is_input_set_as_auto_advance(&self, input: i64) -> bool

pub fn set_cross_fade_time(&self, time: f64)

Cross-fading time (in seconds) between each animation connected to the inputs.

pub fn set_enabled_inputs(&self, amount: i64)

The number of available input ports for this node.

pub fn set_input_as_auto_advance(&self, input: i64, enable: bool)

pub fn set_input_caption(&self, input: i64, caption: impl Into<GodotString>)

Methods from Deref<Target = AnimationNode>

pub const FILTER_BLEND: i64

pub const FILTER_IGNORE: i64

pub const FILTER_PASS: i64

pub const FILTER_STOP: i64

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

Adds an input to the node. This is only useful for nodes created for use in an AnimationNodeBlendTree.

pub fn blend_animation(
    &self,
    animation: impl Into<GodotString>,
    time: f64,
    delta: f64,
    seeked: bool,
    blend: f64
)

Blend an animation by blend amount (name must be valid in the linked AnimationPlayer). A time and delta may be passed, as well as whether seek happened.

pub fn blend_input(
    &self,
    input_index: i64,
    time: f64,
    seek: bool,
    blend: f64,
    filter: i64,
    optimize: bool
) -> f64

Blend an input. This is only useful for nodes created for an AnimationNodeBlendTree. The time parameter is a relative delta, unless seek is true, in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options).

Default Arguments

• filter - 0
• optimize - true

pub fn blend_node(
    &self,
    name: impl Into<GodotString>,
    node: impl AsArg<AnimationNode>,
    time: f64,
    seek: bool,
    blend: f64,
    filter: i64,
    optimize: bool
) -> f64

Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from AnimationRootNode instead, else editors will not display your node for addition.

Default Arguments

• filter - 0
• optimize - true

pub fn get_input_count(&self) -> i64

Amount of inputs in this node, only useful for nodes that go into AnimationNodeBlendTree.

pub fn get_input_name(&self, input: i64) -> GodotString

Gets the name of an input by index.

pub fn get_parameter(&self, name: impl Into<GodotString>) -> Variant

Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.

pub fn is_filter_enabled(&self) -> bool

If true, filtering is enabled.

pub fn is_path_filtered(&self, path: impl Into<NodePath>) -> bool

Returns true whether a given path is filtered.

pub fn remove_input(&self, index: i64)

Removes an input, call this only when inactive.

pub fn set_filter_enabled(&self, enable: bool)

If true, filtering is enabled.

pub fn set_filter_path(&self, path: impl Into<NodePath>, enable: bool)

Adds or removes a path for the filter.

pub fn set_parameter(
    &self,
    name: impl Into<GodotString>,
    value: impl OwnedToVariant
)

Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.

Trait Implementations

impl Debug for AnimationNodeTransition

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

Formats the value using the given formatter.

impl Deref for AnimationNodeTransition

type Target = AnimationNode

The resulting type after dereferencing.

fn deref(&self) -> &AnimationNode

Dereferences the value.

impl DerefMut for AnimationNodeTransition

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

Mutably dereferences the value.

impl GodotObject for AnimationNodeTransition

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl Instanciable for AnimationNodeTransition

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

impl Sealed for AnimationNodeTransition

impl SubClass<AnimationNode> for AnimationNodeTransition

impl SubClass<Object> for AnimationNodeTransition

impl SubClass<Reference> for AnimationNodeTransition

impl SubClass<Resource> for AnimationNodeTransition