class_animationlibrary.rst 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimationLibrary.xml.
  6. .. _class_AnimationLibrary:
  7. AnimationLibrary
  8. ================
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. Properties
  11. ----------
  12. +-------------------------------------+-----------------------------------------------------+--------+
  13. | :ref:`Dictionary<class_Dictionary>` | :ref:`_data<class_AnimationLibrary_property__data>` | ``{}`` |
  14. +-------------------------------------+-----------------------------------------------------+--------+
  15. Methods
  16. -------
  17. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_animation<class_AnimationLibrary_method_add_animation>` **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)** |
  19. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`Animation<class_Animation>` | :ref:`get_animation<class_AnimationLibrary_method_get_animation>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  21. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`StringName[]<class_StringName>` | :ref:`get_animation_list<class_AnimationLibrary_method_get_animation_list>` **(** **)** |const| |
  23. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationLibrary_method_has_animation>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
  25. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`remove_animation<class_AnimationLibrary_method_remove_animation>` **(** :ref:`StringName<class_StringName>` name **)** |
  27. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`rename_animation<class_AnimationLibrary_method_rename_animation>` **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)** |
  29. +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. Signals
  31. -------
  32. .. _class_AnimationLibrary_signal_animation_added:
  33. - **animation_added** **(** :ref:`StringName<class_StringName>` name **)**
  34. ----
  35. .. _class_AnimationLibrary_signal_animation_removed:
  36. - **animation_removed** **(** :ref:`StringName<class_StringName>` name **)**
  37. ----
  38. .. _class_AnimationLibrary_signal_animation_renamed:
  39. - **animation_renamed** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` to_name **)**
  40. Property Descriptions
  41. ---------------------
  42. .. _class_AnimationLibrary_property__data:
  43. - :ref:`Dictionary<class_Dictionary>` **_data**
  44. +-----------+--------+
  45. | *Default* | ``{}`` |
  46. +-----------+--------+
  47. Method Descriptions
  48. -------------------
  49. .. _class_AnimationLibrary_method_add_animation:
  50. - :ref:`Error<enum_@GlobalScope_Error>` **add_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`Animation<class_Animation>` animation **)**
  51. ----
  52. .. _class_AnimationLibrary_method_get_animation:
  53. - :ref:`Animation<class_Animation>` **get_animation** **(** :ref:`StringName<class_StringName>` name **)** |const|
  54. ----
  55. .. _class_AnimationLibrary_method_get_animation_list:
  56. - :ref:`StringName[]<class_StringName>` **get_animation_list** **(** **)** |const|
  57. ----
  58. .. _class_AnimationLibrary_method_has_animation:
  59. - :ref:`bool<class_bool>` **has_animation** **(** :ref:`StringName<class_StringName>` name **)** |const|
  60. ----
  61. .. _class_AnimationLibrary_method_remove_animation:
  62. - void **remove_animation** **(** :ref:`StringName<class_StringName>` name **)**
  63. ----
  64. .. _class_AnimationLibrary_method_rename_animation:
  65. - void **rename_animation** **(** :ref:`StringName<class_StringName>` name, :ref:`StringName<class_StringName>` newname **)**
  66. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  67. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  68. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  69. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  70. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  71. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`