AnimationPlayer

Container and player of Animation resources.

An animation player is used for general-purpose playback of Animation resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. AnimationPlayer is more suited than Tween for animations where you know the final values in advance. For example, fading a screen in and out is more easily done with an AnimationPlayer node thanks to the animation tools provided by the editor. That particular example can also be implemented with a Tween node, but it requires doing everything by code. Updating the target properties of animations occurs at process time.

@GodotBaseClass

struct AnimationPlayer {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(AnimationPlayer other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static AnimationPlayer _new();

enum AnimationProcessMode;

enum AnimationMethodCallMode;

enum Constants;

void _animationChanged();

void _nodeRemoved(Node arg0);

GodotError addAnimation(String name, Animation animation);

void advance(double delta);

String animationGetNext(String anim_from);

void animationSetNext(String anim_from, String anim_to);

void clearCaches();

void clearQueue();

String findAnimation(Animation animation);

Ref!Animation getAnimation(String name);

PoolStringArray getAnimationList();

AnimationPlayer.AnimationProcessMode getAnimationProcessMode();

String getAssignedAnimation();

String getAutoplay();

double getBlendTime(String anim_from, String anim_to);

String getCurrentAnimation();

double getCurrentAnimationLength();

double getCurrentAnimationPosition();

double getDefaultBlendTime();

AnimationPlayer.AnimationMethodCallMode getMethodCallMode();

double getPlayingSpeed();

PoolStringArray getQueue();

NodePath getRoot();

double getSpeedScale();

bool hasAnimation(String name);

bool isActive();

bool isPlaying();

void play(String name, double custom_blend, double custom_speed, bool from_end);

void playBackwards(String name, double custom_blend);

void queue(String name);

void removeAnimation(String name);

void renameAnimation(String name, String newname);

void seek(double seconds, bool update);

void setActive(bool active);

void setAnimationProcessMode(long mode);

void setAssignedAnimation(String anim);

void setAutoplay(String name);

void setBlendTime(String anim_from, String anim_to, double sec);

void setCurrentAnimation(String anim);

void setDefaultBlendTime(double sec);

void setMethodCallMode(long mode);

void setRoot(NodePathArg0 path);

void setSpeedScale(double speed);

void stop(bool reset);

String assignedAnimation [@property getter];

String assignedAnimation [@property setter];

String autoplay [@property getter];

String autoplay [@property setter];

String currentAnimation [@property getter];

String currentAnimation [@property setter];

double currentAnimationLength [@property getter];

double currentAnimationPosition [@property getter];

AnimationPlayer.AnimationMethodCallMode methodCallMode [@property getter];

long methodCallMode [@property setter];

bool playbackActive [@property getter];

bool playbackActive [@property setter];

double playbackDefaultBlendTime [@property getter];

double playbackDefaultBlendTime [@property setter];

AnimationPlayer.AnimationProcessMode playbackProcessMode [@property getter];

long playbackProcessMode [@property setter];

double playbackSpeed [@property getter];

double playbackSpeed [@property setter];

NodePath rootNode [@property getter];

NodePath rootNode [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

AnimationMethodCallMode enum AnimationMethodCallMode
AnimationProcessMode enum AnimationProcessMode
Constants enum Constants

Functions

_animationChanged void _animationChanged()
_nodeRemoved void _nodeRemoved(Node arg0)
addAnimation GodotError addAnimation(String name, Animation animation): Adds animation to the player accessible with the key name.
advance void advance(double delta): Shifts position in the animation timeline and immediately updates the animation. delta is the time in seconds to shift. Events between the current frame and delta are handled.
animationGetNext String animationGetNext(String anim_from): Returns the name of the next animation in the queue.
animationSetNext void animationSetNext(String anim_from, String anim_to): Triggers the anim_to animation when the anim_from animation completes.
clearCaches void clearCaches(): AnimationPlayer caches animated nodes. It may not notice if a node disappears; clearCaches forces it to update the cache again.
clearQueue void clearQueue(): Clears all queued, unplayed animations.
findAnimation String findAnimation(Animation animation): Returns the name of animation or an empty string if not found.
getAnimation Ref!Animation getAnimation(String name): Returns the Animation with key name or null if not found.
getAnimationList PoolStringArray getAnimationList(): Returns the list of stored animation names.
getAnimationProcessMode AnimationPlayer.AnimationProcessMode getAnimationProcessMode()
getAssignedAnimation String getAssignedAnimation()
getAutoplay String getAutoplay()
getBlendTime double getBlendTime(String anim_from, String anim_to): Gets the blend time (in seconds) between two animations, referenced by their names.
getCurrentAnimation String getCurrentAnimation()
getCurrentAnimationLength double getCurrentAnimationLength()
getCurrentAnimationPosition double getCurrentAnimationPosition()
getDefaultBlendTime double getDefaultBlendTime()
getMethodCallMode AnimationPlayer.AnimationMethodCallMode getMethodCallMode()
getPlayingSpeed double getPlayingSpeed(): Gets the actual playing speed of current animation or 0 if not playing. This speed is the playbackSpeed property multiplied by custom_speed argument specified when calling the play method.
getQueue PoolStringArray getQueue(): Returns a list of the animation names that are currently queued to play.
getRoot NodePath getRoot()
getSpeedScale double getSpeedScale()
hasAnimation bool hasAnimation(String name): Returns true if the AnimationPlayer stores an Animation with key name.
isActive bool isActive()
isPlaying bool isPlaying(): Returns true if playing an animation.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(AnimationPlayer other)
opEquals bool opEquals(typeof(null) n)
play void play(String name, double custom_blend, double custom_speed, bool from_end): Plays the animation with key name. Custom blend times and speed can be set. If custom_speed is negative and from_end is true, the animation will play backwards (which is equivalent to calling playBackwards). The AnimationPlayer keeps track of its current or last played animation with assignedAnimation. If this method is called with that same animation name, or with no name parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see stop for both pause and stop). If the animation was already playing, it will keep playing. Note: The animation will be updated the next time the AnimationPlayer is processed. If other variables are updated at the same time this is called, they may be updated too early. To perform the update immediately, call advance(0).
playBackwards void playBackwards(String name, double custom_blend): Plays the animation with key name in reverse. This method is a shorthand for play with custom_speed = -1.0 and from_end = true, so see its description for more information.
queue void queue(String name): Queues an animation for playback once the current one is done. Note: If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow.
removeAnimation void removeAnimation(String name): Removes the animation with key name.
renameAnimation void renameAnimation(String name, String newname): Renames an existing animation with key name to newname.
seek void seek(double seconds, bool update): Seeks the animation to the seconds point in time (in seconds). If update is true, the animation updates too, otherwise it updates at process time. Events between the current frame and seconds are skipped.
setActive void setActive(bool active)
setAnimationProcessMode void setAnimationProcessMode(long mode)
setAssignedAnimation void setAssignedAnimation(String anim)
setAutoplay void setAutoplay(String name)
setBlendTime void setBlendTime(String anim_from, String anim_to, double sec): Specifies a blend time (in seconds) between two animations, referenced by their names.
setCurrentAnimation void setCurrentAnimation(String anim)
setDefaultBlendTime void setDefaultBlendTime(double sec)
setMethodCallMode void setMethodCallMode(long mode)
setRoot void setRoot(NodePathArg0 path)
setSpeedScale void setSpeedScale(double speed)
stop void stop(bool reset): Stops or pauses the currently playing animation. If reset is true, the animation position is reset to 0 and the playback speed is reset to 1.0. If reset is false, the currentAnimationPosition will be kept and calling play or playBackwards without arguments or with the same animation name as assignedAnimation will resume the animation.
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

assignedAnimation String assignedAnimation [@property getter]
String assignedAnimation [@property setter]: If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also currentAnimation.
autoplay String autoplay [@property getter]
String autoplay [@property setter]: The name of the animation to play when the scene loads.
currentAnimation String currentAnimation [@property getter]
String currentAnimation [@property setter]: The name of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See play for more information on playing animations. Note: while this property appears in the inspector, it's not meant to be edited, and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see Animation.
currentAnimationLength double currentAnimationLength [@property getter]: The length (in seconds) of the currently being played animation.
currentAnimationPosition double currentAnimationPosition [@property getter]: The position (in seconds) of the currently playing animation.
methodCallMode AnimationPlayer.AnimationMethodCallMode methodCallMode [@property getter]
long methodCallMode [@property setter]: The call mode to use for Call Method tracks.
playbackActive bool playbackActive [@property getter]
bool playbackActive [@property setter]: If true, updates animations in response to process-related notifications.
playbackDefaultBlendTime double playbackDefaultBlendTime [@property getter]
double playbackDefaultBlendTime [@property setter]: The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision.
playbackProcessMode AnimationPlayer.AnimationProcessMode playbackProcessMode [@property getter]
long playbackProcessMode [@property setter]: The process notification in which to update animations.
playbackSpeed double playbackSpeed [@property getter]
double playbackSpeed [@property setter]: The speed scaling ratio. For instance, if this value is 1, then the animation plays at normal speed. If it's 0.5, then it plays at half speed. If it's 2, then it plays at double speed.
rootNode NodePath rootNode [@property getter]
NodePath rootNode [@property setter]: The node from which node path references will travel.

Static functions

_new AnimationPlayer _new(): Construct a new instance of AnimationPlayer. Note: use memnew!AnimationPlayer instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot animationplayer structs

AnimationPlayer