:github_url: hide .. 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/doc/classes/AnimationLibrary.xml. .. _class_AnimationLibrary: AnimationLibrary ================ **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Container for :ref:`Animation` resources. .. rst-class:: classref-introduction-group Description ----------- An animation library stores a set of animations accessible through :ref:`StringName` keys, for use with :ref:`AnimationPlayer` nodes. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Animation tutorial index <../tutorials/animation/index>` .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`add_animation`\ (\ name\: :ref:`StringName`, animation\: :ref:`Animation`\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Animation` | :ref:`get_animation`\ (\ name\: :ref:`StringName`\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`StringName`\] | :ref:`get_animation_list`\ (\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_animation_list_size`\ (\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_animation`\ (\ name\: :ref:`StringName`\ ) |const| | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_animation`\ (\ name\: :ref:`StringName`\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`rename_animation`\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) | +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_AnimationLibrary_signal_animation_added: .. rst-class:: classref-signal **animation_added**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when an :ref:`Animation` is added, under the key ``name``. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_signal_animation_changed: .. rst-class:: classref-signal **animation_changed**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when there's a change in one of the animations, e.g. tracks are added, moved or have changed paths. ``name`` is the key of the animation that was changed. See also :ref:`Resource.changed`, which this acts as a relay for. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_signal_animation_removed: .. rst-class:: classref-signal **animation_removed**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when an :ref:`Animation` stored with the key ``name`` is removed. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_signal_animation_renamed: .. rst-class:: classref-signal **animation_renamed**\ (\ name\: :ref:`StringName`, to_name\: :ref:`StringName`\ ) :ref:`🔗` Emitted when the key for an :ref:`Animation` is changed, from ``name`` to ``to_name``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_AnimationLibrary_method_add_animation: .. rst-class:: classref-method :ref:`Error` **add_animation**\ (\ name\: :ref:`StringName`, animation\: :ref:`Animation`\ ) :ref:`🔗` Adds the ``animation`` to the library, accessible by the key ``name``. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_method_get_animation: .. rst-class:: classref-method :ref:`Animation` **get_animation**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the :ref:`Animation` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_method_get_animation_list: .. rst-class:: classref-method :ref:`Array`\[:ref:`StringName`\] **get_animation_list**\ (\ ) |const| :ref:`🔗` Returns the keys for the :ref:`Animation`\ s stored in the library. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_method_get_animation_list_size: .. rst-class:: classref-method :ref:`int` **get_animation_list_size**\ (\ ) |const| :ref:`🔗` Returns the key count for the :ref:`Animation`\ s stored in the library. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_method_has_animation: .. rst-class:: classref-method :ref:`bool` **has_animation**\ (\ name\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the library stores an :ref:`Animation` with ``name`` as the key. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_method_remove_animation: .. rst-class:: classref-method |void| **remove_animation**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Removes the :ref:`Animation` with the key ``name``. .. rst-class:: classref-item-separator ---- .. _class_AnimationLibrary_method_rename_animation: .. rst-class:: classref-method |void| **rename_animation**\ (\ name\: :ref:`StringName`, newname\: :ref:`StringName`\ ) :ref:`🔗` Changes the key of the :ref:`Animation` associated with the key ``name`` to ``newname``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`