| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the AnimationPlayer.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_AnimationPlayer:
- AnimationPlayer
- ===============
- **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
- **Category:** Core
- Brief Description
- -----------------
- Container and player of :ref:`Animation<class_animation>` resources.
- Member Functions
- ----------------
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_current_animation_length<class_AnimationPlayer_get_current_animation_length>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_current_animation_position<class_AnimationPlayer_get_current_animation_position>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_speed_scale<class_AnimationPlayer_get_speed_scale>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_string>` name **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_speed_scale<class_AnimationPlayer_set_speed_scale>` **(** :ref:`float<class_float>` speed **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
- +------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Signals
- -------
- .. _class_AnimationPlayer_animation_changed:
- - **animation_changed** **(** :ref:`String<class_string>` old_name, :ref:`String<class_string>` new_name **)**
- If the currently being played animation changes, this signal will notify of such change.
- .. _class_AnimationPlayer_animation_finished:
- - **animation_finished** **(** :ref:`String<class_string>` name **)**
- Notifies when an animation finished playing.
- .. _class_AnimationPlayer_animation_started:
- - **animation_started** **(** :ref:`String<class_string>` name **)**
- Notifies when an animation starts playing.
- Member Variables
- ----------------
- .. _class_AnimationPlayer_playback_default_blend_time:
- - :ref:`float<class_float>` **playback_default_blend_time** - The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: ``0``.
- .. _class_AnimationPlayer_playback_process_mode:
- - :ref:`AnimationProcessMode<enum_animationplayer_animationprocessmode>` **playback_process_mode** - The process notification in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
- .. _class_AnimationPlayer_root_node:
- - :ref:`NodePath<class_nodepath>` **root_node** - The node from which node path references will travel. Default value: ``".."``.
- Enums
- -----
- .. _enum_AnimationPlayer_AnimationProcessMode:
- enum **AnimationProcessMode**
- - **ANIMATION_PROCESS_PHYSICS** = **0** --- Process animation during the physics process. This is especially useful when animating physics bodies.
- - **ANIMATION_PROCESS_IDLE** = **1** --- Process animation during the idle process.
- Description
- -----------
- An animation player is used for general purpose playback of :ref:`Animation<class_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.
- Member Function Description
- ---------------------------
- .. _class_AnimationPlayer_add_animation:
- - :ref:`int<class_int>` **add_animation** **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)**
- Adds ``animation`` to the player accessible with the key ``name``.
- .. _class_AnimationPlayer_advance:
- - void **advance** **(** :ref:`float<class_float>` delta **)**
- Shifts position in the animation timeline. Delta is the time in seconds to shift.
- .. _class_AnimationPlayer_animation_get_next:
- - :ref:`String<class_string>` **animation_get_next** **(** :ref:`String<class_string>` anim_from **)** const
- Returns the name of the next animation in the queue.
- .. _class_AnimationPlayer_animation_set_next:
- - void **animation_set_next** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)**
- Triggers the ``anim_to`` animation when the ``anim_from`` animation completes.
- .. _class_AnimationPlayer_clear_caches:
- - void **clear_caches** **(** **)**
- ``AnimationPlayer`` caches animated nodes. It may not notice if a node disappears, so clear_caches forces it to update the cache again.
- .. _class_AnimationPlayer_clear_queue:
- - void **clear_queue** **(** **)**
- Clears all queued, unplayed animations.
- .. _class_AnimationPlayer_find_animation:
- - :ref:`String<class_string>` **find_animation** **(** :ref:`Animation<class_animation>` animation **)** const
- Returns the name of ``animation`` or empty string if not found.
- .. _class_AnimationPlayer_get_animation:
- - :ref:`Animation<class_animation>` **get_animation** **(** :ref:`String<class_string>` name **)** const
- Returns the :ref:`Animation<class_animation>` with key ``name`` or ``null`` if not found.
- .. _class_AnimationPlayer_get_animation_list:
- - :ref:`PoolStringArray<class_poolstringarray>` **get_animation_list** **(** **)** const
- Returns the list of stored animation names.
- .. _class_AnimationPlayer_get_autoplay:
- - :ref:`String<class_string>` **get_autoplay** **(** **)** const
- Returns the name of the animation that will be automatically played when the scene is loaded.
- .. _class_AnimationPlayer_get_blend_time:
- - :ref:`float<class_float>` **get_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const
- Get the blend time (in seconds) between two animations, referenced by their names.
- .. _class_AnimationPlayer_get_current_animation:
- - :ref:`String<class_string>` **get_current_animation** **(** **)** const
- Returns the name of the animation being played.
- .. _class_AnimationPlayer_get_current_animation_length:
- - :ref:`float<class_float>` **get_current_animation_length** **(** **)** const
- Get the length (in seconds) of the currently being played animation.
- .. _class_AnimationPlayer_get_current_animation_position:
- - :ref:`float<class_float>` **get_current_animation_position** **(** **)** const
- Get the position (in seconds) of the currently playing animation.
- .. _class_AnimationPlayer_get_speed_scale:
- - :ref:`float<class_float>` **get_speed_scale** **(** **)** const
- Returns the speed scaling ratio of the current animation channel. 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.
- .. _class_AnimationPlayer_has_animation:
- - :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const
- Returns ``true`` if the ``AnimationPlayer`` stores an :ref:`Animation<class_animation>` with key ``name``.
- .. _class_AnimationPlayer_is_active:
- - :ref:`bool<class_bool>` **is_active** **(** **)** const
- Returns ``true`` if the player is active.
- .. _class_AnimationPlayer_is_playing:
- - :ref:`bool<class_bool>` **is_playing** **(** **)** const
- Returns ``true`` if playing an animation.
- .. _class_AnimationPlayer_play:
- - void **play** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1.0, :ref:`bool<class_bool>` from_end=false **)**
- Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the
- animation backwards.
- .. _class_AnimationPlayer_play_backwards:
- - void **play_backwards** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)**
- Play the animation with key ``name`` in reverse.
- .. _class_AnimationPlayer_queue:
- - void **queue** **(** :ref:`String<class_string>` name **)**
- Queue an animation for playback once the current one is done.
- .. _class_AnimationPlayer_remove_animation:
- - void **remove_animation** **(** :ref:`String<class_string>` name **)**
- Remove the animation with key ``name``.
- .. _class_AnimationPlayer_rename_animation:
- - void **rename_animation** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)**
- Rename an existing animation with key ``name`` to ``newname``.
- .. _class_AnimationPlayer_seek:
- - void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)**
- Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time.
- .. _class_AnimationPlayer_set_active:
- - void **set_active** **(** :ref:`bool<class_bool>` active **)**
- Sets the player as active (playing). If ``true``, updates animations in response to process-related notifications. Default value: ``true``.
- .. _class_AnimationPlayer_set_autoplay:
- - void **set_autoplay** **(** :ref:`String<class_string>` name **)**
- Defines the name of the animation to play when the scene loads. Default value: ``""``.
- .. _class_AnimationPlayer_set_blend_time:
- - void **set_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)**
- Specify a blend time (in seconds) between two animations, referenced by their names.
- .. _class_AnimationPlayer_set_current_animation:
- - void **set_current_animation** **(** :ref:`String<class_string>` anim **)**
- Sets the name of the current animation. If already playing, restarts the animation. Ensure :ref:`active<class_AnimationPlayer_active>` is ``true`` to simulate :ref:`play<class_AnimationPlayer_play>`. Default value: ``""``.
- .. _class_AnimationPlayer_set_speed_scale:
- - void **set_speed_scale** **(** :ref:`float<class_float>` speed **)**
- Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: ``1``.
- .. _class_AnimationPlayer_stop:
- - void **stop** **(** :ref:`bool<class_bool>` reset=true **)**
- Stop the currently playing animation. If ``reset`` is ``true``, the anim position is reset to ``0``.
|
