Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 2.1
Branches Tags
godot-docs
/
classes
/
class_spriteframes.rst

class_spriteframes.rst 8.6 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_SpriteFrames:
    5. 

  5. 

  6. SpriteFrames
    7. 

  7. ============
    8. 

  8. 

  9. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. Sprite frame library for AnimatedSprite.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                         | :ref:`add_animation<class_SpriteFrames_add_animation>`  **(** :ref:`String<class_string>` anim  **)**                                                            |
    23. 

  23. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                         | :ref:`add_frame<class_SpriteFrames_add_frame>`  **(** :ref:`String<class_string>` anim, :ref:`Object<class_object>` frame, :ref:`int<class_int>` atpos=-1  **)** |
    25. 

  25. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | void                         | :ref:`clear<class_SpriteFrames_clear>`  **(** :ref:`String<class_string>` anim  **)**                                                                            |
    27. 

  27. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | void                         | :ref:`clear_all<class_SpriteFrames_clear_all>`  **(** **)**                                                                                                      |
    29. 

  29. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`bool<class_bool>`      | :ref:`get_animation_loop<class_SpriteFrames_get_animation_loop>`  **(** :ref:`String<class_string>` anim  **)** const                                            |
    31. 

  31. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`float<class_float>`    | :ref:`get_animation_speed<class_SpriteFrames_get_animation_speed>`  **(** :ref:`String<class_string>` anim  **)** const                                          |
    33. 

  33. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Object<class_object>`  | :ref:`get_frame<class_SpriteFrames_get_frame>`  **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx  **)** const                                   |
    35. 

  35. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`int<class_int>`        | :ref:`get_frame_count<class_SpriteFrames_get_frame_count>`  **(** :ref:`String<class_string>` anim  **)** const                                                  |
    37. 

  37. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`bool<class_bool>`      | :ref:`has_animation<class_SpriteFrames_has_animation>`  **(** :ref:`String<class_string>` anim  **)** const                                                      |
    39. 

  39. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                         | :ref:`remove_animation<class_SpriteFrames_remove_animation>`  **(** :ref:`String<class_string>` anim  **)**                                                      |
    41. 

  41. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                         | :ref:`remove_frame<class_SpriteFrames_remove_frame>`  **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx  **)**                                   |
    43. 

  43. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                         | :ref:`rename_animation<class_SpriteFrames_rename_animation>`  **(** :ref:`String<class_string>` anim, :ref:`String<class_string>` newname  **)**                 |
    45. 

  45. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                         | :ref:`set_animation_loop<class_SpriteFrames_set_animation_loop>`  **(** :ref:`String<class_string>` anim, :ref:`bool<class_bool>` loop  **)**                    |
    47. 

  47. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | void                         | :ref:`set_animation_speed<class_SpriteFrames_set_animation_speed>`  **(** :ref:`String<class_string>` anim, :ref:`float<class_float>` speed  **)**               |
    49. 

  49. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | void                         | :ref:`set_frame<class_SpriteFrames_set_frame>`  **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx, :ref:`Object<class_object>` txt  **)**        |
    51. 

  51. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. 

  53. Description
    54. 

  54. -----------
    55. 

  55. 

  56. Sprite frame library for :ref:`AnimatedSprite<class_animatedsprite>`.
    57. 

  57. 

  58. Member Function Description
    59. 

  59. ---------------------------
    60. 

  60. 

  61. .. _class_SpriteFrames_add_animation:
    62. 

  62. 

  63. - void  **add_animation**  **(** :ref:`String<class_string>` anim  **)**
    64. 

  64. 

  65. .. _class_SpriteFrames_add_frame:
    66. 

  66. 

  67. - void  **add_frame**  **(** :ref:`String<class_string>` anim, :ref:`Object<class_object>` frame, :ref:`int<class_int>` atpos=-1  **)**
    68. 

  68. 

  69. .. _class_SpriteFrames_clear:
    70. 

  70. 

  71. - void  **clear**  **(** :ref:`String<class_string>` anim  **)**
    72. 

  72. 

  73. .. _class_SpriteFrames_clear_all:
    74. 

  74. 

  75. - void  **clear_all**  **(** **)**
    76. 

  76. 

  77. .. _class_SpriteFrames_get_animation_loop:
    78. 

  78. 

  79. - :ref:`bool<class_bool>`  **get_animation_loop**  **(** :ref:`String<class_string>` anim  **)** const
    80. 

  80. 

  81. .. _class_SpriteFrames_get_animation_speed:
    82. 

  82. 

  83. - :ref:`float<class_float>`  **get_animation_speed**  **(** :ref:`String<class_string>` anim  **)** const
    84. 

  84. 

  85. .. _class_SpriteFrames_get_frame:
    86. 

  86. 

  87. - :ref:`Object<class_object>`  **get_frame**  **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx  **)** const
    88. 

  88. 

  89. .. _class_SpriteFrames_get_frame_count:
    90. 

  90. 

  91. - :ref:`int<class_int>`  **get_frame_count**  **(** :ref:`String<class_string>` anim  **)** const
    92. 

  92. 

  93. .. _class_SpriteFrames_has_animation:
    94. 

  94. 

  95. - :ref:`bool<class_bool>`  **has_animation**  **(** :ref:`String<class_string>` anim  **)** const
    96. 

  96. 

  97. .. _class_SpriteFrames_remove_animation:
    98. 

  98. 

  99. - void  **remove_animation**  **(** :ref:`String<class_string>` anim  **)**
    100. 

  100. 

  101. .. _class_SpriteFrames_remove_frame:
    102. 

  102. 

  103. - void  **remove_frame**  **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx  **)**
    104. 

  104. 

  105. .. _class_SpriteFrames_rename_animation:
    106. 

  106. 

  107. - void  **rename_animation**  **(** :ref:`String<class_string>` anim, :ref:`String<class_string>` newname  **)**
    108. 

  108. 

  109. .. _class_SpriteFrames_set_animation_loop:
    110. 

  110. 

  111. - void  **set_animation_loop**  **(** :ref:`String<class_string>` anim, :ref:`bool<class_bool>` loop  **)**
    112. 

  112. 

  113. .. _class_SpriteFrames_set_animation_speed:
    114. 

  114. 

  115. - void  **set_animation_speed**  **(** :ref:`String<class_string>` anim, :ref:`float<class_float>` speed  **)**
    116. 

  116. 

  117. .. _class_SpriteFrames_set_frame:
    118. 

  118. 

  119. - void  **set_frame**  **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx, :ref:`Object<class_object>` txt  **)**
    120. 

  120. 

  121.