Struct gdnative::api::animation::Animation

pub struct Animation { /* fields omitted */ }

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:

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

Constants

pub const INTERPOLATION_CUBIC: i64

pub const INTERPOLATION_LINEAR: i64

pub const INTERPOLATION_NEAREST: i64

pub const TYPE_ANIMATION: i64

pub const TYPE_AUDIO: i64

pub const TYPE_BEZIER: i64

pub const TYPE_METHOD: i64

pub const TYPE_TRANSFORM: i64

pub const TYPE_VALUE: i64

pub const UPDATE_CAPTURE: i64

pub const UPDATE_CONTINUOUS: i64

pub const UPDATE_DISCRETE: i64

pub const UPDATE_TRIGGER: i64

impl Animation

pub fn new() -> Ref<Animation, 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_track(&self, _type: i64, at_position: i64) -> i64

Adds a track to the Animation.

Default Arguments

• at_position - -1

pub fn animation_track_get_key_animation(
    &self,
    track_idx: i64,
    key_idx: i64
) -> GodotString

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

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>
)

Sets the key identified by key_idx to value animation. The track_idx must be the index of an Animation Track.

pub fn audio_track_get_key_end_offset(
    &self,
    track_idx: i64,
    key_idx: i64
) -> f64

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.

pub fn audio_track_get_key_start_offset(
    &self,
    track_idx: i64,
    key_idx: i64
) -> f64

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.

pub fn audio_track_get_key_stream(
    &self,
    track_idx: i64,
    key_idx: i64
) -> Option<Ref<Resource, Shared>>

Returns the audio stream of the key identified by key_idx. The track_idx must be the index of an Audio Track.

pub fn audio_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    stream: impl AsArg<Resource>,
    start_offset: f64,
    end_offset: f64
) -> i64

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

pub fn audio_track_set_key_end_offset(
    &self,
    track_idx: i64,
    key_idx: i64,
    offset: f64
)

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.

pub fn audio_track_set_key_start_offset(
    &self,
    track_idx: i64,
    key_idx: i64,
    offset: f64
)

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.

pub fn audio_track_set_key_stream(
    &self,
    track_idx: i64,
    key_idx: i64,
    stream: impl AsArg<Resource>
)

Sets the stream of the key identified by key_idx to value offset. The track_idx must be the index of an Audio Track.

pub fn bezier_track_get_key_in_handle(
    &self,
    track_idx: i64,
    key_idx: i64
) -> Vector2D<f32, UnknownUnit>

Returns the in handle of the key identified by key_idx. The track_idx must be the index of a Bezier Track.

pub fn bezier_track_get_key_out_handle(
    &self,
    track_idx: i64,
    key_idx: i64
) -> Vector2D<f32, UnknownUnit>

Returns the out handle of the key identified by key_idx. The track_idx must be the index of a Bezier Track.

pub fn bezier_track_get_key_value(&self, track_idx: i64, key_idx: i64) -> f64

Returns the value of the key identified by key_idx. The track_idx must be the index of a Bezier Track.

pub fn bezier_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    value: f64,
    in_handle: Vector2D<f32, UnknownUnit>,
    out_handle: Vector2D<f32, UnknownUnit>
) -> i64

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 )

pub fn bezier_track_interpolate(&self, track_idx: i64, time: f64) -> f64

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: Vector2D<f32, UnknownUnit>
)

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: Vector2D<f32, UnknownUnit>
)

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.

pub fn bezier_track_set_key_value(
    &self,
    track_idx: i64,
    key_idx: i64,
    value: f64
)

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.

pub fn clear(&self)

Clear the animation (clear all tracks and reset all).

pub fn copy_track(&self, track_idx: i64, to_animation: impl AsArg<Animation>)

Adds a new track that is a copy of the given track from to_animation.

pub fn find_track(&self, path: impl Into<NodePath>) -> i64

Returns the index of the specified track. If the track is not found, return -1.

pub fn length(&self) -> f64

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.

pub fn step(&self) -> f64

The animation step value.

pub fn get_track_count(&self) -> i64

Returns the amount of tracks in the animation.

pub fn has_loop(&self) -> bool

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
) -> TypedArray<i32>

Returns all the key indices of a method track, given a position and delta time.

pub fn method_track_get_name(&self, track_idx: i64, key_idx: i64) -> GodotString

Returns the method name of a method track.

pub fn method_track_get_params(
    &self,
    track_idx: i64,
    key_idx: i64
) -> VariantArray<Shared>

Returns the arguments values to be called on a method track for a given key in a given track.

pub fn remove_track(&self, track_idx: i64)

Removes a track by specifying the track index.

pub fn set_length(&self, time_sec: f64)

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.

pub fn set_loop(&self, enabled: bool)

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 set_step(&self, size_sec: f64)

The animation step value.

pub fn track_find_key(&self, track_idx: i64, time: f64, exact: bool) -> i64

Finds the key index by time in a given track. Optionally, only find it if the exact time is given.

Default Arguments

• exact - false

pub fn track_get_interpolation_loop_wrap(&self, track_idx: i64) -> bool

Returns true if the track at idx wraps the interpolation loop. New tracks wrap the interpolation loop by default.

pub fn track_get_interpolation_type(&self, track_idx: i64) -> InterpolationType

Returns the interpolation type of a given track.

pub fn track_get_key_count(&self, track_idx: i64) -> i64

Returns the amount of keys in a given track.

pub fn track_get_key_time(&self, track_idx: i64, key_idx: i64) -> f64

Returns the time at which the key is located.

pub fn track_get_key_transition(&self, track_idx: i64, key_idx: i64) -> f64

Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).

pub fn track_get_key_value(&self, track_idx: i64, key_idx: i64) -> Variant

Returns the value of a given key in a given track.

pub fn track_get_path(&self, track_idx: i64) -> NodePath

Gets the path of a track. For more information on the path format, see [method track_set_path].

pub fn track_get_type(&self, track_idx: i64) -> TrackType

Gets the type of a track.

pub fn track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    key: impl OwnedToVariant,
    transition: f64
)

Insert a generic key in a given track.

Default Arguments

• transition - 1

pub fn track_is_enabled(&self, track_idx: i64) -> bool

Returns true if the track at index idx is enabled.

pub fn track_is_imported(&self, track_idx: i64) -> bool

Returns true if the given track is imported. Else, return false.

pub fn track_move_down(&self, track_idx: i64)

Moves a track down.

pub fn track_move_to(&self, track_idx: i64, to_idx: i64)

Changes the index position of track idx to the one defined in to_idx.

pub fn track_move_up(&self, track_idx: i64)

Moves a track up.

pub fn track_remove_key(&self, track_idx: i64, key_idx: i64)

Removes a key by index in a given track.

pub fn track_remove_key_at_position(&self, track_idx: i64, position: f64)

Removes a key by position (seconds) in a given track.

pub fn track_set_enabled(&self, track_idx: i64, enabled: bool)

Enables/disables the given track. Tracks are enabled by default.

pub fn track_set_imported(&self, track_idx: i64, imported: bool)

Sets the given track as imported or not.

pub fn track_set_interpolation_loop_wrap(
    &self,
    track_idx: i64,
    interpolation: bool
)

If true, the track at idx wraps the interpolation loop.

pub fn track_set_interpolation_type(&self, track_idx: i64, interpolation: i64)

Sets the interpolation type of a given track.

pub fn track_set_key_time(&self, track_idx: i64, key_idx: i64, time: f64)

Sets the time of an existing key.

pub fn track_set_key_transition(
    &self,
    track_idx: i64,
    key_idx: i64,
    transition: f64
)

Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]).

pub fn track_set_key_value(
    &self,
    track_idx: i64,
    key: i64,
    value: impl OwnedToVariant
)

Sets the value of an existing key.

pub fn track_set_path(&self, track_idx: i64, path: impl Into<NodePath>)

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".

pub fn track_swap(&self, track_idx: i64, with_idx: i64)

Swaps the track idx's index position with the track with_idx.

pub fn transform_track_insert_key(
    &self,
    track_idx: i64,
    time: f64,
    location: Vector3D<f32, UnknownUnit>,
    rotation: Rotation3D<f32, UnknownUnit, UnknownUnit>,
    scale: Vector3D<f32, UnknownUnit>
) -> i64

Insert a transform key for a transform track.

pub fn transform_track_interpolate(
    &self,
    track_idx: i64,
    time_sec: f64
) -> VariantArray<Shared>

Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (Vector3), rotation (Quat) and scale (Vector3).

pub fn value_track_get_key_indices(
    &self,
    track_idx: i64,
    time_sec: f64,
    delta: f64
) -> TypedArray<i32>

Returns all the key indices of a value track, given a position and delta time.

pub fn value_track_get_update_mode(&self, track_idx: i64) -> UpdateMode

Returns the update mode of a value track.

pub fn value_track_set_update_mode(&self, track_idx: i64, mode: i64)

Sets the update mode (see [enum UpdateMode]) of a value track.

Methods from Deref<Target = Resource>

pub fn duplicate(&self, subresources: bool) -> Option<Ref<Resource, Shared>>

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

pub fn get_local_scene(&self) -> Option<Ref<Node, Shared>>

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.

pub fn name(&self) -> GodotString

The name of the resource. This is an optional identifier.

pub fn path(&self) -> GodotString

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.

pub fn get_rid(&self) -> Rid

Returns the RID of the resource (or an empty RID). Many resources (such as Texture, Mesh, etc) are high-level abstractions of resources stored in a server, so this function will return the original RID.

pub fn is_local_to_scene(&self) -> bool

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.

pub fn set_local_to_scene(&self, enable: bool)

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.

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

The name of the resource. This is an optional identifier.

pub fn set_path(&self, path: impl Into<GodotString>)

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.

pub fn setup_local_to_scene(&self)

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.

pub fn take_over_path(&self, path: impl Into<GodotString>)

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.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful.

Methods from Deref<Target = Object>

pub const CONNECT_DEFERRED: i64

pub const CONNECT_ONESHOT: i64

pub const CONNECT_PERSIST: i64

pub const CONNECT_REFERENCE_COUNTED: i64

pub const NOTIFICATION_POSTINITIALIZE: i64

pub const NOTIFICATION_PREDELETE: i64

pub fn add_user_signal(
    &self,
    signal: impl Into<GodotString>,
    arguments: VariantArray<Shared>
)

Adds a user-defined signal. Arguments are optional, but can be added as an [Array] of dictionaries, each containing name: String and type: int (see [enum Variant.Type]) entries.

Default Arguments

• arguments - [ ]

pub unsafe fn call(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust's static type checks (aliasing, thread boundaries, calls to free(), ...).

pub unsafe fn call_deferred(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

call_deferred("set", "position", Vector2(42.0, 0.0))

Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).

Safety

This function bypasses Rust's static type checks (aliasing, thread boundaries, calls to free(), ...).

pub unsafe fn callv(
    &self,
    method: impl Into<GodotString>,
    arg_array: VariantArray<Shared>
) -> Variant

Sample code is GDScript unless otherwise noted.

Calls the method on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array].

callv("set", [ "position", Vector2(42.0, 0.0) ])

Safety

This function bypasses Rust's static type checks (aliasing, thread boundaries, calls to free(), ...).

pub fn can_translate_messages(&self) -> bool

Returns true if the object can translate strings. See [method set_message_translation] and [method tr].

pub fn connect(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>,
    binds: VariantArray<Shared>,
    flags: i64
) -> Result<(), GodotError>

Sample code is GDScript unless otherwise noted.

Connects a signal to a method on a target object. Pass optional binds to the call as an [Array] of parameters. These parameters will be passed to the method after any parameter used in the call to [method emit_signal]. Use flags to set deferred or one-shot connections. See [enum ConnectFlags] constants. A signal can only be connected once to a method. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. If the target is destroyed in the game's lifecycle, the connection will be lost. Examples:

connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal

An example of the relationship between binds passed to [method connect] and parameters used when calling [method emit_signal]:

connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
    print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])

Default Arguments

• binds - [ ]
• flags - 0

pub fn disconnect(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>
)

Disconnects a signal from a method on the given target. If you try to disconnect a connection that does not exist, the method will throw an error. Use [method is_connected] to ensure that the connection exists.

pub fn emit_signal(
    &self,
    signal: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

Sample code is GDScript unless otherwise noted.

Emits the given signal. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:

emit_signal("hit", weapon_type, damage)
emit_signal("game_over")

pub fn get(&self, property: impl Into<GodotString>) -> Variant

Returns the Variant value of the given property. If the property doesn't exist, this will return null. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

pub fn get_class(&self) -> GodotString

Returns the object's class as a String.

pub fn get_incoming_connections(&self) -> VariantArray<Shared>

Returns an [Array] of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:

• source is a reference to the signal emitter.
• signal_name is the name of the connected signal.
• method_name is the name of the method to which the signal is connected.

pub fn get_indexed(&self, property: impl Into<NodePath>) -> Variant

Gets the object's property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Examples: "position:x" or "material:next_pass:blend_mode".

pub fn get_instance_id(&self) -> i64

Returns the object's unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].

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

Returns the object's metadata entry for the given name.

pub fn get_meta_list(&self) -> TypedArray<GodotString>

Returns the object's metadata as a [PoolStringArray].

pub fn get_method_list(&self) -> VariantArray<Shared>

Returns the object's methods and their signatures as an [Array].

pub fn get_property_list(&self) -> VariantArray<Shared>

Returns the object's property list as an [Array] of dictionaries. Each property's Dictionary contain at least name: String and type: int (see [enum Variant.Type]) entries. Optionally, it can also include hint: int (see [enum PropertyHint]), hint_string: String, and usage: int (see [enum PropertyUsageFlags]).

pub fn get_script(&self) -> Option<Ref<Reference, Shared>>

Returns the object's Script instance, or null if none is assigned.

pub fn get_signal_connection_list(
    &self,
    signal: impl Into<GodotString>
) -> VariantArray<Shared>

Returns an [Array] of connections for the given signal.

pub fn get_signal_list(&self) -> VariantArray<Shared>

Returns the list of signals as an [Array] of dictionaries.

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

Returns true if a metadata entry is found with the given name.

pub fn has_method(&self, method: impl Into<GodotString>) -> bool

Returns true if the object contains the given method.

pub fn has_signal(&self, signal: impl Into<GodotString>) -> bool

Returns true if the given signal exists.

pub fn has_user_signal(&self, signal: impl Into<GodotString>) -> bool

Returns true if the given user-defined signal exists. Only signals added using [method add_user_signal] are taken into account.

pub fn is_blocking_signals(&self) -> bool

Returns true if signal emission blocking is enabled.

pub fn is_class(&self, class: impl Into<GodotString>) -> bool

Returns true if the object inherits from the given class.

pub fn is_connected(
    &self,
    signal: impl Into<GodotString>,
    target: impl AsArg<Object>,
    method: impl Into<GodotString>
) -> bool

Returns true if a connection exists for a given signal, target, and method.

pub fn is_queued_for_deletion(&self) -> bool

Returns true if the [method Node.queue_free] method was called for the object.

pub fn notification(&self, what: i64, reversed: bool)

Send a given notification to the object, which will also trigger a call to the [method _notification] method of all classes that the object inherits from. If reversed is true, [method _notification] is called first on the object's own class, and then up to its successive parent classes. If reversed is false, [method _notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.

Default Arguments

• reversed - false

pub fn property_list_changed_notify(&self)

Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.

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

Removes a given entry from the object's metadata. See also [method set_meta].

pub fn set(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)

Assigns a new value to the given property. If the property does not exist, nothing will happen. Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

pub fn set_block_signals(&self, enable: bool)

If set to true, signal emission is blocked.

pub fn set_deferred(
    &self,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. call_deferred("set", property, value). Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).

pub fn set_indexed(
    &self,
    property: impl Into<NodePath>,
    value: impl OwnedToVariant
)

Sample code is GDScript unless otherwise noted.

Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:) to access nested properties. Example:

set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)

pub fn set_message_translation(&self, enable: bool)

Defines whether the object can translate strings (with calls to [method tr]). Enabled by default.

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

Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any Variant value. To remove a given entry from the object's metadata, use [method remove_meta]. Metadata is also removed if its value is set to null. This means you can also use set_meta("name", null) to remove metadata for "name".

pub fn set_script(&self, script: impl AsArg<Reference>)

Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script's [method _init] method will be called.

pub fn to_string(&self) -> GodotString

Returns a String representing the object. If not overridden, defaults to "[ClassName:RID]". Override the method [method _to_string] to customize the String representation.

pub fn tr(&self, message: impl Into<GodotString>) -> GodotString

Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the message unchanged. See [method set_message_translation].

Trait Implementations

impl Debug for Animation

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

Formats the value using the given formatter.

impl Deref for Animation

type Target = Resource

The resulting type after dereferencing.

pub fn deref(&self) -> &Resource

Dereferences the value.

impl DerefMut for Animation

pub fn deref_mut(&mut self) -> &mut Resource

Mutably dereferences the value.

impl GodotObject for Animation

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.

pub fn class_name() -> &'static str

pub 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.

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

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

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

Performs a dynamic reference downcast to target type.

pub 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.

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

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

pub 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.

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

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

pub 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.

pub 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 Animation

pub fn construct() -> Ref<Animation, Unique>

impl SubClass<Object> for Animation

impl SubClass<Reference> for Animation

impl SubClass<Resource> for Animation