Struct gdnative_bindings_lily::Animation [−][src]
pub struct Animation { /* fields omitted */ }
Expand description
core class Animation
inherits Resource
(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
Animation inherits methods from:
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
Constants
Creates a new instance of this object.
This is a reference-counted type. The returned object is automatically managed
by Ref
.
Returns the animation name at the key identified by key_idx
. The track_idx
must be the index of an Animation Track.
pub fn animation_track_insert_key(
&self,
track_idx: i64,
time: f64,
animation: impl Into<GodotString>
) -> i64
pub fn animation_track_insert_key(
&self,
track_idx: i64,
time: f64,
animation: impl Into<GodotString>
) -> i64
Inserts a key with value animation
at the given time
(in seconds). The track_idx
must be the index of an Animation Track.
pub fn animation_track_set_key_animation(
&self,
track_idx: i64,
key_idx: i64,
animation: impl Into<GodotString>
)
pub fn animation_track_set_key_animation(
&self,
track_idx: i64,
key_idx: i64,
animation: impl Into<GodotString>
)
Sets the key identified by key_idx
to value animation
. The track_idx
must be the index of an Animation Track.
Returns the end offset of the key identified by key_idx
. The track_idx
must be the index of an Audio Track.
End offset is the number of seconds cut off at the ending of the audio stream.
Returns the start offset of the key identified by key_idx
. The track_idx
must be the index of an Audio Track.
Start offset is the number of seconds cut off at the beginning of the audio stream.
Returns the audio stream of the key identified by key_idx
. The track_idx
must be the index of an Audio Track.
Inserts an Audio Track key at the given time
in seconds. The track_idx
must be the index of an Audio Track.
stream
is the AudioStream resource to play. start_offset
is the number of seconds cut off at the beginning of the audio stream, while end_offset
is at the ending.
Default Arguments
start_offset
-0
end_offset
-0
Sets the end offset of the key identified by key_idx
to value offset
. The track_idx
must be the index of an Audio Track.
Sets the start offset of the key identified by key_idx
to value offset
. The track_idx
must be the index of an Audio Track.
Sets the stream of the key identified by key_idx
to value offset
. The track_idx
must be the index of an Audio Track.
Returns the in handle of the key identified by key_idx
. The track_idx
must be the index of a Bezier Track.
Returns the out handle of the key identified by key_idx
. The track_idx
must be the index of a Bezier Track.
Returns the value of the key identified by key_idx
. The track_idx
must be the index of a Bezier Track.
Inserts a Bezier Track key at the given time
in seconds. The track_idx
must be the index of a Bezier Track.
in_handle
is the left-side weight of the added Bezier curve point, out_handle
is the right-side one, while value
is the actual value at this point.
Default Arguments
in_handle
-Vector2( 0, 0 )
out_handle
-Vector2( 0, 0 )
Returns the interpolated value at the given time
(in seconds). The track_idx
must be the index of a Bezier Track.
pub fn bezier_track_set_key_in_handle(
&self,
track_idx: i64,
key_idx: i64,
in_handle: Vector2
)
pub fn bezier_track_set_key_in_handle(
&self,
track_idx: i64,
key_idx: i64,
in_handle: Vector2
)
Sets the in handle of the key identified by key_idx
to value in_handle
. The track_idx
must be the index of a Bezier Track.
pub fn bezier_track_set_key_out_handle(
&self,
track_idx: i64,
key_idx: i64,
out_handle: Vector2
)
pub fn bezier_track_set_key_out_handle(
&self,
track_idx: i64,
key_idx: i64,
out_handle: Vector2
)
Sets the out handle of the key identified by key_idx
to value out_handle
. The track_idx
must be the index of a Bezier Track.
Sets the value of the key identified by key_idx
to the given value. The track_idx
must be the index of a Bezier Track.
Adds a new track that is a copy of the given track from to_animation
.
Returns the index of the specified track. If the track is not found, return -1.
The total length of the animation (in seconds). Note: Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
Returns the amount of tracks in the animation.
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
pub fn method_track_get_key_indices(
&self,
track_idx: i64,
time_sec: f64,
delta: f64
) -> Int32Array
pub fn method_track_get_key_indices(
&self,
track_idx: i64,
time_sec: f64,
delta: f64
) -> Int32Array
Returns all the key indices of a method track, given a position and delta time.
Returns the method name of a method track.
Returns the arguments values to be called on a method track for a given key in a given track.
Removes a track by specifying the track index.
The total length of the animation (in seconds). Note: Length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
Finds the key index by time in a given track. Optionally, only find it if the exact time is given.
Default Arguments
exact
-false
Returns true
if the track at idx
wraps the interpolation loop. New tracks wrap the interpolation loop by default.
Returns the interpolation type of a given track.
Returns the amount of keys in a given track.
Returns the time at which the key is located.
Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).
Returns the value of a given key in a given track.
Gets the path of a track. For more information on the path format, see [method track_set_path].
Gets the type of a track.
pub fn track_insert_key(
&self,
track_idx: i64,
time: f64,
key: impl OwnedToVariant,
transition: f64
)
pub fn track_insert_key(
&self,
track_idx: i64,
time: f64,
key: impl OwnedToVariant,
transition: f64
)
Returns true
if the track at index idx
is enabled.
Returns true
if the given track is imported. Else, return false
.
Moves a track down.
Changes the index position of track idx
to the one defined in to_idx
.
Moves a track up.
Removes a key by index in a given track.
Removes a key by position (seconds) in a given track.
Enables/disables the given track. Tracks are enabled by default.
Sets the given track as imported or not.
If true
, the track at idx
wraps the interpolation loop.
Sets the interpolation type of a given track.
Sets the time of an existing key.
Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).
Sets the value of an existing key.
Sets the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":"
.
For example, "character/skeleton:ankle"
or "character/mesh:transform/local"
.
Swaps the track idx
’s index position with the track with_idx
.
Insert a transform key for a transform track.
pub fn value_track_get_key_indices(
&self,
track_idx: i64,
time_sec: f64,
delta: f64
) -> Int32Array
pub fn value_track_get_key_indices(
&self,
track_idx: i64,
time_sec: f64,
delta: f64
) -> Int32Array
Returns all the key indices of a value track, given a position and delta time.
Returns the update mode of a value track.
Sets the update mode (see [enum UpdateMode]) of a value track.
Methods from Deref<Target = Resource>
Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing true
to the subresources
argument which will copy the subresources.
Note: If subresources
is true
, this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared.
Default Arguments
subresources
-false
If [member resource_local_to_scene] is enabled and the resource was loaded from a PackedScene instantiation, returns the local scene where this resource’s unique copy is in use. Otherwise, returns null
.
The name of the resource. This is an optional identifier.
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
If true
, the resource will be made unique in each instance of its local scene. It can thus be modified in a scene instance without impacting other instances of that same scene.
The name of the resource. This is an optional identifier.
The path to the resource. In case it has its own file, it will return its filepath. If it’s tied to the scene, it will return the scene’s path, followed by the resource’s index.
This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a PackedScene instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script. For most resources, this method performs no base logic. ViewportTexture performs custom logic to properly set the proxy texture and flags in the local viewport.
Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path.
Trait Implementations
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Animation
impl UnwindSafe for Animation