godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (46a568e0a)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-08-31 15:18:54 +02:00
parent b08b95d4f5
commit 465dd176b6
378 changed files with 17124 additions and 13692 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
classes/class_animationlibrary.rst
View File

@@ -12,7 +12,17 @@ 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
----------
@@ -45,18 +55,24 @@ Signals
- **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
---------------------
@@ -75,36 +91,48 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **add_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)**
Adds the ``animation`` to the library, accesible 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.)`