mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 20:29:03 +00:00
78 lines
3.4 KiB
ReStructuredText
78 lines
3.4 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_SpriteFrames:
|
|
|
|
SpriteFrames
|
|
============
|
|
|
|
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Sprite frame library for AnimatedSprite.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_frame<class_SpriteFrames_add_frame>` **(** :ref:`Object<class_object>` frame, :ref:`int<class_int>` atpos=-1 **)** |
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear<class_SpriteFrames_clear>` **(** **)** |
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Object<class_object>` | :ref:`get_frame<class_SpriteFrames_get_frame>` **(** :ref:`int<class_int>` idx **)** const |
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_frame_count<class_SpriteFrames_get_frame_count>` **(** **)** const |
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`remove_frame<class_SpriteFrames_remove_frame>` **(** :ref:`int<class_int>` idx **)** |
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_frame<class_SpriteFrames_set_frame>` **(** :ref:`int<class_int>` idx, :ref:`Object<class_object>` txt **)** |
|
|
+------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
Sprite frame library for :ref:`AnimatedSprite<class_animatedsprite>`.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_SpriteFrames_add_frame:
|
|
|
|
- void **add_frame** **(** :ref:`Object<class_object>` frame, :ref:`int<class_int>` atpos=-1 **)**
|
|
|
|
Add a frame (texture).
|
|
|
|
.. _class_SpriteFrames_clear:
|
|
|
|
- void **clear** **(** **)**
|
|
|
|
Clear the frames.
|
|
|
|
.. _class_SpriteFrames_get_frame:
|
|
|
|
- :ref:`Object<class_object>` **get_frame** **(** :ref:`int<class_int>` idx **)** const
|
|
|
|
Return a texture (frame).
|
|
|
|
.. _class_SpriteFrames_get_frame_count:
|
|
|
|
- :ref:`int<class_int>` **get_frame_count** **(** **)** const
|
|
|
|
Return the amount of frames.
|
|
|
|
.. _class_SpriteFrames_remove_frame:
|
|
|
|
- void **remove_frame** **(** :ref:`int<class_int>` idx **)**
|
|
|
|
Remove a frame
|
|
|
|
.. _class_SpriteFrames_set_frame:
|
|
|
|
- void **set_frame** **(** :ref:`int<class_int>` idx, :ref:`Object<class_object>` txt **)**
|
|
|
|
|