mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Fix links case and sync headers with editor
Output from godotengine/godot#22002.
This commit is contained in:
Rémi Verschelde
@@ -7,8 +7,7 @@
|
||||
SpriteFrames
|
||||
============
|
||||
|
||||
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
||||
|
||||
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
||||
**Category:** Core
|
||||
|
||||
Brief Description
|
||||
@@ -16,74 +15,66 @@ Brief Description
|
||||
|
||||
Sprite frame library for AnimatedSprite.
|
||||
|
||||
Member Functions
|
||||
----------------
|
||||
Methods
|
||||
-------
|
||||
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_animation<class_SpriteFrames_add_animation>` **(** :ref:`String<class_string>` anim **)** |
|
||||
| void | :ref:`add_animation<class_SpriteFrames_add_animation>` **(** :ref:`String<class_String>` anim **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`add_frame<class_SpriteFrames_add_frame>` **(** :ref:`String<class_string>` anim, :ref:`Texture<class_texture>` frame, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
| void | :ref:`add_frame<class_SpriteFrames_add_frame>` **(** :ref:`String<class_String>` anim, :ref:`Texture<class_Texture>` frame, :ref:`int<class_int>` at_position=-1 **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear<class_SpriteFrames_clear>` **(** :ref:`String<class_string>` anim **)** |
|
||||
| void | :ref:`clear<class_SpriteFrames_clear>` **(** :ref:`String<class_String>` anim **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`clear_all<class_SpriteFrames_clear_all>` **(** **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`get_animation_loop<class_SpriteFrames_get_animation_loop>` **(** :ref:`String<class_string>` anim **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`get_animation_loop<class_SpriteFrames_get_animation_loop>` **(** :ref:`String<class_String>` anim **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`PoolStringArray<class_poolstringarray>` | :ref:`get_animation_names<class_SpriteFrames_get_animation_names>` **(** **)** const |
|
||||
| :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_animation_names<class_SpriteFrames_get_animation_names>` **(** **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`float<class_float>` | :ref:`get_animation_speed<class_SpriteFrames_get_animation_speed>` **(** :ref:`String<class_string>` anim **)** const |
|
||||
| :ref:`float<class_float>` | :ref:`get_animation_speed<class_SpriteFrames_get_animation_speed>` **(** :ref:`String<class_String>` anim **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`Texture<class_texture>` | :ref:`get_frame<class_SpriteFrames_get_frame>` **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx **)** const |
|
||||
| :ref:`Texture<class_Texture>` | :ref:`get_frame<class_SpriteFrames_get_frame>` **(** :ref:`String<class_String>` anim, :ref:`int<class_int>` idx **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`get_frame_count<class_SpriteFrames_get_frame_count>` **(** :ref:`String<class_string>` anim **)** const |
|
||||
| :ref:`int<class_int>` | :ref:`get_frame_count<class_SpriteFrames_get_frame_count>` **(** :ref:`String<class_String>` anim **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_SpriteFrames_has_animation>` **(** :ref:`String<class_string>` anim **)** const |
|
||||
| :ref:`bool<class_bool>` | :ref:`has_animation<class_SpriteFrames_has_animation>` **(** :ref:`String<class_String>` anim **)** const |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_animation<class_SpriteFrames_remove_animation>` **(** :ref:`String<class_string>` anim **)** |
|
||||
| void | :ref:`remove_animation<class_SpriteFrames_remove_animation>` **(** :ref:`String<class_String>` anim **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`remove_frame<class_SpriteFrames_remove_frame>` **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx **)** |
|
||||
| void | :ref:`remove_frame<class_SpriteFrames_remove_frame>` **(** :ref:`String<class_String>` anim, :ref:`int<class_int>` idx **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`rename_animation<class_SpriteFrames_rename_animation>` **(** :ref:`String<class_string>` anim, :ref:`String<class_string>` newname **)** |
|
||||
| void | :ref:`rename_animation<class_SpriteFrames_rename_animation>` **(** :ref:`String<class_String>` anim, :ref:`String<class_String>` newname **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation_loop<class_SpriteFrames_set_animation_loop>` **(** :ref:`String<class_string>` anim, :ref:`bool<class_bool>` loop **)** |
|
||||
| void | :ref:`set_animation_loop<class_SpriteFrames_set_animation_loop>` **(** :ref:`String<class_String>` anim, :ref:`bool<class_bool>` loop **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_animation_speed<class_SpriteFrames_set_animation_speed>` **(** :ref:`String<class_string>` anim, :ref:`float<class_float>` speed **)** |
|
||||
| void | :ref:`set_animation_speed<class_SpriteFrames_set_animation_speed>` **(** :ref:`String<class_String>` anim, :ref:`float<class_float>` speed **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| void | :ref:`set_frame<class_SpriteFrames_set_frame>` **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` txt **)** |
|
||||
| void | :ref:`set_frame<class_SpriteFrames_set_frame>` **(** :ref:`String<class_String>` anim, :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` txt **)** |
|
||||
+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Member Variables
|
||||
----------------
|
||||
|
||||
.. _class_SpriteFrames_frames:
|
||||
|
||||
- :ref:`Array<class_array>` **frames**
|
||||
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Sprite frame library for :ref:`AnimatedSprite<class_animatedsprite>`. Contains frames and animation data for playback.
|
||||
Sprite frame library for :ref:`AnimatedSprite<class_AnimatedSprite>`. Contains frames and animation data for playback.
|
||||
|
||||
Member Function Description
|
||||
---------------------------
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_SpriteFrames_add_animation:
|
||||
|
||||
- void **add_animation** **(** :ref:`String<class_string>` anim **)**
|
||||
- void **add_animation** **(** :ref:`String<class_String>` anim **)**
|
||||
|
||||
Adds a new animation to the library.
|
||||
|
||||
.. _class_SpriteFrames_add_frame:
|
||||
|
||||
- void **add_frame** **(** :ref:`String<class_string>` anim, :ref:`Texture<class_texture>` frame, :ref:`int<class_int>` at_position=-1 **)**
|
||||
- void **add_frame** **(** :ref:`String<class_String>` anim, :ref:`Texture<class_Texture>` frame, :ref:`int<class_int>` at_position=-1 **)**
|
||||
|
||||
Adds a frame to the given animation.
|
||||
|
||||
.. _class_SpriteFrames_clear:
|
||||
|
||||
- void **clear** **(** :ref:`String<class_string>` anim **)**
|
||||
- void **clear** **(** :ref:`String<class_String>` anim **)**
|
||||
|
||||
Removes all frames from the given animation.
|
||||
|
||||
@@ -95,73 +86,73 @@ Removes all animations. A "default" animation will be created.
|
||||
|
||||
.. _class_SpriteFrames_get_animation_loop:
|
||||
|
||||
- :ref:`bool<class_bool>` **get_animation_loop** **(** :ref:`String<class_string>` anim **)** const
|
||||
- :ref:`bool<class_bool>` **get_animation_loop** **(** :ref:`String<class_String>` anim **)** const
|
||||
|
||||
If ``true`` the given animation will loop.
|
||||
|
||||
.. _class_SpriteFrames_get_animation_names:
|
||||
|
||||
- :ref:`PoolStringArray<class_poolstringarray>` **get_animation_names** **(** **)** const
|
||||
- :ref:`PoolStringArray<class_PoolStringArray>` **get_animation_names** **(** **)** const
|
||||
|
||||
Returns an array containing the names associated to each animation. Values are placed in alphabetical order.
|
||||
|
||||
.. _class_SpriteFrames_get_animation_speed:
|
||||
|
||||
- :ref:`float<class_float>` **get_animation_speed** **(** :ref:`String<class_string>` anim **)** const
|
||||
- :ref:`float<class_float>` **get_animation_speed** **(** :ref:`String<class_String>` anim **)** const
|
||||
|
||||
The animation's speed in frames per second.
|
||||
|
||||
.. _class_SpriteFrames_get_frame:
|
||||
|
||||
- :ref:`Texture<class_texture>` **get_frame** **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx **)** const
|
||||
- :ref:`Texture<class_Texture>` **get_frame** **(** :ref:`String<class_String>` anim, :ref:`int<class_int>` idx **)** const
|
||||
|
||||
Returns the animation's selected frame.
|
||||
|
||||
.. _class_SpriteFrames_get_frame_count:
|
||||
|
||||
- :ref:`int<class_int>` **get_frame_count** **(** :ref:`String<class_string>` anim **)** const
|
||||
- :ref:`int<class_int>` **get_frame_count** **(** :ref:`String<class_String>` anim **)** const
|
||||
|
||||
Returns the number of frames in the animation.
|
||||
|
||||
.. _class_SpriteFrames_has_animation:
|
||||
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` anim **)** const
|
||||
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_String>` anim **)** const
|
||||
|
||||
If ``true`` the named animation exists.
|
||||
|
||||
.. _class_SpriteFrames_remove_animation:
|
||||
|
||||
- void **remove_animation** **(** :ref:`String<class_string>` anim **)**
|
||||
- void **remove_animation** **(** :ref:`String<class_String>` anim **)**
|
||||
|
||||
Removes the given animation.
|
||||
|
||||
.. _class_SpriteFrames_remove_frame:
|
||||
|
||||
- void **remove_frame** **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx **)**
|
||||
- void **remove_frame** **(** :ref:`String<class_String>` anim, :ref:`int<class_int>` idx **)**
|
||||
|
||||
Removes the animation's selected frame.
|
||||
|
||||
.. _class_SpriteFrames_rename_animation:
|
||||
|
||||
- void **rename_animation** **(** :ref:`String<class_string>` anim, :ref:`String<class_string>` newname **)**
|
||||
- void **rename_animation** **(** :ref:`String<class_String>` anim, :ref:`String<class_String>` newname **)**
|
||||
|
||||
Changes the animation's name to ``newname``.
|
||||
|
||||
.. _class_SpriteFrames_set_animation_loop:
|
||||
|
||||
- void **set_animation_loop** **(** :ref:`String<class_string>` anim, :ref:`bool<class_bool>` loop **)**
|
||||
- void **set_animation_loop** **(** :ref:`String<class_String>` anim, :ref:`bool<class_bool>` loop **)**
|
||||
|
||||
If ``true`` the animation will loop.
|
||||
|
||||
.. _class_SpriteFrames_set_animation_speed:
|
||||
|
||||
- void **set_animation_speed** **(** :ref:`String<class_string>` anim, :ref:`float<class_float>` speed **)**
|
||||
- void **set_animation_speed** **(** :ref:`String<class_String>` anim, :ref:`float<class_float>` speed **)**
|
||||
|
||||
The animation's speed in frames per second.
|
||||
|
||||
.. _class_SpriteFrames_set_frame:
|
||||
|
||||
- void **set_frame** **(** :ref:`String<class_string>` anim, :ref:`int<class_int>` idx, :ref:`Texture<class_texture>` txt **)**
|
||||
- void **set_frame** **(** :ref:`String<class_String>` anim, :ref:`int<class_int>` idx, :ref:`Texture<class_Texture>` txt **)**
|
||||
|
||||
Sets the texture of the given frame.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user