asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/SpriteFrames.xml

180 lines
5.3 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 02:03:48 +01: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 22:42:36 +02:00
<brief_description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Sprite frame library for AnimatedSprite2D.
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 22:42:36 +02:00
</brief_description>
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 18:22:57 +02:00
Sprite frame library for [AnimatedSprite2D]. Contains frames and animation data for playback.
Document support for normal and specular maps in AnimatedSprite2D This closes #38509.
2020-07-10 21:52:16 +02:00
[b]Note:[/b] You can associate a set of normal or specular maps by creating additional [SpriteFrames] resources with a [code]_normal[/code] or [code]_specular[/code] suffix. For example, having 3 [SpriteFrames] resources [code]run[/code], [code]run_normal[/code], and [code]run_specular[/code] will make it so the [code]run[/code] animation uses normal and specular maps.
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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_animation">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
Doc: Fix typos spotted by @yurchor
2018-07-01 15:55:53 +02: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 22:42:36 +02:00
</description>
</method>
<method name="add_frame">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</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 09:59:06 +01: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 22:42:36 +02: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 15:37:49 +02: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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="clear">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="clear_all">
<return type="void">
</return>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="get_animation_loop" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
doc: Sync classref with current source Bind missing enums.
2020-09-11 12:22:10 +02:00
Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<method name="get_animation_names" qualifiers="const">
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 13:59:24 +01:00
<return type="PackedStringArray">
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</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 22:42:36 +02:00
<method name="get_animation_speed" qualifiers="const">
<return type="float">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02: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 09:59:06 +01: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 22:42:36 +02:00
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<argument index="1" name="idx" type="int">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="get_frame_count" qualifiers="const">
<return type="int">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01: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 22:42:36 +02:00
</description>
</method>
<method name="remove_animation">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="remove_frame">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<argument index="1" name="idx" type="int">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="rename_animation">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="1" name="newname" type="StringName">
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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="set_animation_loop">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<argument index="1" name="loop" type="bool">
</argument>
<description>
doc: Add missing commas after "If true/false"
2018-12-20 13:46:54 +01: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 22:42:36 +02:00
</description>
</method>
<method name="set_animation_speed">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</argument>
<argument index="1" name="speed" type="float">
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
<method name="set_frame">
<return type="void">
</return>
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
<argument index="0" name="anim" type="StringName">
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 22:42:36 +02:00
</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 09:59:06 +01: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 22:42:36 +02:00
</argument>
<description>
[DOCS] Update SpriteFrames class ref
2017-09-24 20:37:28 +02: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 22:42:36 +02:00
</description>
</method>
</methods>
<members>
Revert "Drop deprecated compatibility methods from AnimatedSprite"
2018-09-13 02:32:51 +02:00
<member name="frames" type="Array" setter="_set_frames" getter="_get_frames">
Complete documentation of some more classes
2020-01-13 23:08:42 +01:00
Compatibility property, always equals to an empty array.
Revert "Drop deprecated compatibility methods from AnimatedSprite"
2018-09-13 02:32:51 +02: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 22:42:36 +02:00
</members>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink