.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/AnimationPlayer.xml. .. _class_AnimationPlayer: AnimationPlayer =============== **Inherits:** :ref:`AnimationMixer` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`assigned_animation` | | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`autoplay` | ``""`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`current_animation` | ``""`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`current_animation_length` | | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`current_animation_position` | | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`movie_quit_on_finish` | ``false`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`playback_auto_capture` | ``true`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`playback_auto_capture_duration` | ``-1.0`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`EaseType` | :ref:`playback_auto_capture_ease_type` | ``0`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`TransitionType` | :ref:`playback_auto_capture_transition_type` | ``0`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`playback_default_blend_time` | ``0.0`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`speed_scale` | ``1.0`` | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`animation_get_next` **(** :ref:`StringName` animation_from **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`animation_set_next` **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_queue` **(** **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_blend_time` **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AnimationMethodCallMode` | :ref:`get_method_call_mode` **(** **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_playing_speed` **(** **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AnimationProcessCallback` | :ref:`get_process_callback` **(** **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_queue` **(** **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_root` **(** **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_playing` **(** **)** |const| | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`pause` **(** **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play` **(** :ref:`StringName` name=&"", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play_backwards` **(** :ref:`StringName` name=&"", :ref:`float` custom_blend=-1 **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`play_with_capture` **(** :ref:`StringName` name=&"", :ref:`float` duration=-1.0, :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=0 **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue` **(** :ref:`StringName` name **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`seek` **(** :ref:`float` seconds, :ref:`bool` update=false, :ref:`bool` update_only=false **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_blend_time` **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to, :ref:`float` sec **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_method_call_mode` **(** :ref:`AnimationMethodCallMode` mode **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_callback` **(** :ref:`AnimationProcessCallback` mode **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_root` **(** :ref:`NodePath` path **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** :ref:`bool` keep_state=false **)** | +--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_AnimationPlayer_signal_animation_changed: .. rst-class:: classref-signal **animation_changed** **(** :ref:`StringName` old_name, :ref:`StringName` new_name **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_signal_current_animation_changed: .. rst-class:: classref-signal **current_animation_changed** **(** :ref:`String` name **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_AnimationPlayer_AnimationProcessCallback: .. rst-class:: classref-enumeration enum **AnimationProcessCallback**: .. _class_AnimationPlayer_constant_ANIMATION_PROCESS_PHYSICS: .. rst-class:: classref-enumeration-constant :ref:`AnimationProcessCallback` **ANIMATION_PROCESS_PHYSICS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AnimationPlayer_constant_ANIMATION_PROCESS_IDLE: .. rst-class:: classref-enumeration-constant :ref:`AnimationProcessCallback` **ANIMATION_PROCESS_IDLE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AnimationPlayer_constant_ANIMATION_PROCESS_MANUAL: .. rst-class:: classref-enumeration-constant :ref:`AnimationProcessCallback` **ANIMATION_PROCESS_MANUAL** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_AnimationPlayer_AnimationMethodCallMode: .. rst-class:: classref-enumeration enum **AnimationMethodCallMode**: .. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_DEFERRED: .. rst-class:: classref-enumeration-constant :ref:`AnimationMethodCallMode` **ANIMATION_METHOD_CALL_DEFERRED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_AnimationPlayer_constant_ANIMATION_METHOD_CALL_IMMEDIATE: .. rst-class:: classref-enumeration-constant :ref:`AnimationMethodCallMode` **ANIMATION_METHOD_CALL_IMMEDIATE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_AnimationPlayer_property_assigned_animation: .. rst-class:: classref-property :ref:`String` **assigned_animation** .. rst-class:: classref-property-setget - void **set_assigned_animation** **(** :ref:`String` value **)** - :ref:`String` **get_assigned_animation** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_autoplay: .. rst-class:: classref-property :ref:`String` **autoplay** = ``""`` .. rst-class:: classref-property-setget - void **set_autoplay** **(** :ref:`String` value **)** - :ref:`String` **get_autoplay** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_current_animation: .. rst-class:: classref-property :ref:`String` **current_animation** = ``""`` .. rst-class:: classref-property-setget - void **set_current_animation** **(** :ref:`String` value **)** - :ref:`String` **get_current_animation** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_current_animation_length: .. rst-class:: classref-property :ref:`float` **current_animation_length** .. rst-class:: classref-property-setget - :ref:`float` **get_current_animation_length** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_current_animation_position: .. rst-class:: classref-property :ref:`float` **current_animation_position** .. rst-class:: classref-property-setget - :ref:`float` **get_current_animation_position** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_movie_quit_on_finish: .. rst-class:: classref-property :ref:`bool` **movie_quit_on_finish** = ``false`` .. rst-class:: classref-property-setget - void **set_movie_quit_on_finish_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_movie_quit_on_finish_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_playback_auto_capture: .. rst-class:: classref-property :ref:`bool` **playback_auto_capture** = ``true`` .. rst-class:: classref-property-setget - void **set_auto_capture** **(** :ref:`bool` value **)** - :ref:`bool` **is_auto_capture** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_playback_auto_capture_duration: .. rst-class:: classref-property :ref:`float` **playback_auto_capture_duration** = ``-1.0`` .. rst-class:: classref-property-setget - void **set_auto_capture_duration** **(** :ref:`float` value **)** - :ref:`float` **get_auto_capture_duration** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_playback_auto_capture_ease_type: .. rst-class:: classref-property :ref:`EaseType` **playback_auto_capture_ease_type** = ``0`` .. rst-class:: classref-property-setget - void **set_auto_capture_ease_type** **(** :ref:`EaseType` value **)** - :ref:`EaseType` **get_auto_capture_ease_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_playback_auto_capture_transition_type: .. rst-class:: classref-property :ref:`TransitionType` **playback_auto_capture_transition_type** = ``0`` .. rst-class:: classref-property-setget - void **set_auto_capture_transition_type** **(** :ref:`TransitionType` value **)** - :ref:`TransitionType` **get_auto_capture_transition_type** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_playback_default_blend_time: .. rst-class:: classref-property :ref:`float` **playback_default_blend_time** = ``0.0`` .. rst-class:: classref-property-setget - void **set_default_blend_time** **(** :ref:`float` value **)** - :ref:`float` **get_default_blend_time** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_property_speed_scale: .. rst-class:: classref-property :ref:`float` **speed_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_speed_scale** **(** :ref:`float` value **)** - :ref:`float` **get_speed_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AnimationPlayer_method_animation_get_next: .. rst-class:: classref-method :ref:`StringName` **animation_get_next** **(** :ref:`StringName` animation_from **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_animation_set_next: .. rst-class:: classref-method void **animation_set_next** **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_clear_queue: .. rst-class:: classref-method void **clear_queue** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_get_blend_time: .. rst-class:: classref-method :ref:`float` **get_blend_time** **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_get_method_call_mode: .. rst-class:: classref-method :ref:`AnimationMethodCallMode` **get_method_call_mode** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_get_playing_speed: .. rst-class:: classref-method :ref:`float` **get_playing_speed** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_get_process_callback: .. rst-class:: classref-method :ref:`AnimationProcessCallback` **get_process_callback** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_get_queue: .. rst-class:: classref-method :ref:`PackedStringArray` **get_queue** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_get_root: .. rst-class:: classref-method :ref:`NodePath` **get_root** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_is_playing: .. rst-class:: classref-method :ref:`bool` **is_playing** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_pause: .. rst-class:: classref-method void **pause** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_play: .. rst-class:: classref-method void **play** **(** :ref:`StringName` name=&"", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_play_backwards: .. rst-class:: classref-method void **play_backwards** **(** :ref:`StringName` name=&"", :ref:`float` custom_blend=-1 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_play_with_capture: .. rst-class:: classref-method void **play_with_capture** **(** :ref:`StringName` name=&"", :ref:`float` duration=-1.0, :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false, :ref:`TransitionType` trans_type=0, :ref:`EaseType` ease_type=0 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_queue: .. rst-class:: classref-method void **queue** **(** :ref:`StringName` name **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_seek: .. rst-class:: classref-method void **seek** **(** :ref:`float` seconds, :ref:`bool` update=false, :ref:`bool` update_only=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_set_blend_time: .. rst-class:: classref-method void **set_blend_time** **(** :ref:`StringName` animation_from, :ref:`StringName` animation_to, :ref:`float` sec **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_set_method_call_mode: .. rst-class:: classref-method void **set_method_call_mode** **(** :ref:`AnimationMethodCallMode` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_set_process_callback: .. rst-class:: classref-method void **set_process_callback** **(** :ref:`AnimationProcessCallback` mode **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_set_root: .. rst-class:: classref-method void **set_root** **(** :ref:`NodePath` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_AnimationPlayer_method_stop: .. rst-class:: classref-method void **stop** **(** :ref:`bool` keep_state=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`