mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
142 lines
7.1 KiB
ReStructuredText
142 lines
7.1 KiB
ReStructuredText
: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<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Container for :ref:`Animation<class_Animation>` resources.
|
|
|
|
Description
|
|
-----------
|
|
|
|
An animation library stores a set of animations accessible through :ref:`StringName<class_StringName>` keys, for use with :ref:`AnimationPlayer<class_AnimationPlayer>` nodes.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- :doc:`Animation tutorial index <../tutorials/animation/index>`
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------+-----------------------------------------------------+--------+
|
|
| :ref:`Dictionary<class_Dictionary>` | :ref:`_data<class_AnimationLibrary_property__data>` | ``{}`` |
|
|
+-------------------------------------+-----------------------------------------------------+--------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation<class_AnimationLibrary_method_add_animation>` **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)** |
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationLibrary_method_get_animation>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`StringName[]<class_StringName>` | :ref:`get_animation_list<class_AnimationLibrary_method_get_animation_list>` **(** **)** |const| |
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationLibrary_method_has_animation>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_animation<class_AnimationLibrary_method_remove_animation>` **(** :ref:`StringName<class_StringName>` name **)** |
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`rename_animation<class_AnimationLibrary_method_rename_animation>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)** |
|
|
+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_AnimationLibrary_signal_animation_added:
|
|
|
|
- **animation_added** **(** :ref:`StringName<class_StringName>` name **)**
|
|
|
|
Emitted when an :ref:`Animation<class_Animation>` is added, under the key ``name``.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_signal_animation_removed:
|
|
|
|
- **animation_removed** **(** :ref:`StringName<class_StringName>` name **)**
|
|
|
|
Emitted when an :ref:`Animation<class_Animation>` stored with the key ``name`` is removed.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_signal_animation_renamed:
|
|
|
|
- **animation_renamed** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` to_name **)**
|
|
|
|
Emitted when the key for an :ref:`Animation<class_Animation>` is changed, from ``name`` to ``to_name``.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_AnimationLibrary_property__data:
|
|
|
|
- :ref:`Dictionary<class_Dictionary>` **_data**
|
|
|
|
+-----------+--------+
|
|
| *Default* | ``{}`` |
|
|
+-----------+--------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_AnimationLibrary_method_add_animation:
|
|
|
|
- :ref:`Error<enum_@GlobalScope_Error>` **add_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)**
|
|
|
|
Adds the ``animation`` to the library, accessible by the key ``name``.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_method_get_animation:
|
|
|
|
- :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`StringName<class_StringName>` name **)** |const|
|
|
|
|
Returns the :ref:`Animation<class_Animation>` with the key ``name``. If the animation does not exist, ``null`` is returned and an error is logged.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_method_get_animation_list:
|
|
|
|
- :ref:`StringName[]<class_StringName>` **get_animation_list** **(** **)** |const|
|
|
|
|
Returns the keys for the :ref:`Animation<class_Animation>`\ s stored in the library.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_method_has_animation:
|
|
|
|
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`StringName<class_StringName>` name **)** |const|
|
|
|
|
Returns ``true`` if the library stores an :ref:`Animation<class_Animation>` with ``name`` as the key.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_method_remove_animation:
|
|
|
|
- void **remove_animation** **(** :ref:`StringName<class_StringName>` name **)**
|
|
|
|
Removes the :ref:`Animation<class_Animation>` with the key ``name``.
|
|
|
|
----
|
|
|
|
.. _class_AnimationLibrary_method_rename_animation:
|
|
|
|
- void **rename_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)**
|
|
|
|
Changes the key of the :ref:`Animation<class_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.)`
|
|
.. |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.)`
|