godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/SpriteFrames.xml

179 lines
4.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="SpriteFrames" inherits="Resource" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Sprite frame library for AnimatedSprite.
</brief_description>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Sprite frame library for [AnimatedSprite]. Contains frames and animation data for playback.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
Doc: Fix typos spotted by @yurchor
2018-07-01 13:55:53 +00:00
Adds a new animation to the library.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="add_frame">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<argument index="1" name="frame" type="Texture2D">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 13:37:49 +00:00
<argument index="2" name="at_position" type="int" default="-1">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Adds a frame to the given animation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Removes all frames from the given animation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear_all">
<return type="void">
</return>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Removes all animations. A "default" animation will be created.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_animation_loop" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the given animation will loop.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 09:56:21 +00:00
<method name="get_animation_names" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
Returns an array containing the names associated to each animation. Values are placed in alphabetical order.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_animation_speed" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
The animation's speed in frames per second.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_frame" qualifiers="const">
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<return type="Texture2D">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</return>
<argument index="0" name="anim" type="String">
</argument>
<argument index="1" name="idx" type="int">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Returns the animation's selected frame.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_frame_count" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Returns the number of frames in the animation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the named animation exists.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="remove_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Removes the given animation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="remove_frame">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<argument index="1" name="idx" type="int">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Removes the animation's selected frame.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="rename_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<argument index="1" name="newname" type="String">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Changes the animation's name to [code]newname[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_animation_loop">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<argument index="1" name="loop" type="bool">
</argument>
<description>
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the animation will loop.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_animation_speed">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<argument index="1" name="speed" type="float">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
The animation's speed in frames per second.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_frame">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<argument index="1" name="idx" type="int">
</argument>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<argument index="2" name="txt" type="Texture2D">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 18:37:28 +00:00
Sets the texture of the given frame.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
Revert "Drop deprecated compatibility methods from AnimatedSprite"
2018-09-13 00:32:51 +00:00
<member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
Complete documentation of some more classes
2020-01-13 22:08:42 +00:00
Compatibility property, always equals to an empty array.
Revert "Drop deprecated compatibility methods from AnimatedSprite"
2018-09-13 00:32:51 +00:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<constants>
</constants>
</class>