godot/doc/classes/AnimatedSprite3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimatedSprite3D" inherits="SpriteBase3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		2D sprite node in 3D world, that can use multiple 2D textures for animation.
	</brief_description>
	<description>
		Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.
	</description>
	<tutorials>
		<link title="2D Sprite animation (also applies to 3D)">$DOCS_URL/tutorials/2d/2d_sprite_animation.html</link>
	</tutorials>
	<methods>
		<method name="play">
			<return type="void" />
			<param index="0" name="anim" type="StringName" default="&amp;&quot;&quot;" />
			<param index="1" name="backwards" type="bool" default="false" />
			<description>
				Plays the animation named [param anim]. If no [param anim] is provided, the current animation is played. If [param backwards] is [code]true[/code], the animation will be played in reverse.
			</description>
		</method>
		<method name="stop">
			<return type="void" />
			<description>
				Stops the current animation (does not reset the frame counter).
			</description>
		</method>
	</methods>
	<members>
		<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="&amp;&quot;default&quot;">
			The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.
		</member>
		<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
			The displayed animation frame's index.
		</member>
		<member name="frames" type="SpriteFrames" setter="set_sprite_frames" getter="get_sprite_frames">
			The [SpriteFrames] resource containing the animation(s).
		</member>
		<member name="playing" type="bool" setter="set_playing" getter="is_playing" default="false">
			If [code]true[/code], the [member animation] is currently playing.
		</member>
		<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0">
			The animation speed is multiplied by this value.
		</member>
	</members>
	<signals>
		<signal name="animation_finished">
			<description>
				Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.
			</description>
		</signal>
		<signal name="frame_changed">
			<description>
				Emitted when [member frame] changed.
			</description>
		</signal>
	</signals>
</class>
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" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="AnimatedSprite3D" inherits="SpriteBase3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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>`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`2D sprite node in 3D world, that can use multiple 2D textures for 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			`</brief_description>`
			`<description>`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.`
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>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 09:43:07 +00:00			`<link title="2D Sprite animation (also applies to 3D)">$DOCS_URL/tutorials/2d/2d_sprite_animation.html</link>`
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			`</tutorials>`
			`<methods>`
			`<method name="play">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="anim" type="StringName" default="&""" />`
Harmonise AnimatedSprite3D and its 2D counterpart Add the following properties to AnimatedSprite3D: - `backwards` parameter in `play()`; - `speed_scale`. Both classes' internals are more similar, down to the line spacings. They've also been updated to be clearer and less inconsistent (e.g. `!frames.is_valid()` -> `frames.is_null()`, use SceneStringNames instead of CoreStringNames, rename the internal _queue_update to _queue_redraw) 2022-08-09 10:57:18 +00:00			`<param index="1" name="backwards" type="bool" default="false" />`
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>`
Harmonise AnimatedSprite3D and its 2D counterpart Add the following properties to AnimatedSprite3D: - `backwards` parameter in `play()`; - `speed_scale`. Both classes' internals are more similar, down to the line spacings. They've also been updated to be clearer and less inconsistent (e.g. `!frames.is_valid()` -> `frames.is_null()`, use SceneStringNames instead of CoreStringNames, rename the internal _queue_update to _queue_redraw) 2022-08-09 10:57:18 +00:00			`Plays the animation named [param anim]. If no [param anim] is provided, the current animation is played. If [param backwards] is [code]true[/code], the animation will be played in reverse.`
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="stop">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 13:28:05 +00:00			`<return type="void" />`
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>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`Stops the current animation (does not reset the frame counter).`
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>`
Let var2str display StringName with correct sigil 2021-06-05 19:24:24 +00:00			`<member name="animation" type="StringName" setter="set_animation" getter="get_animation" default="&"default"">`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset.`
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			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`The displayed animation frame's index.`
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			`</member>`
doc: Sync classref with current source 2019-07-15 18:42:47 +00:00			`<member name="frames" type="SpriteFrames" setter="set_sprite_frames" getter="get_sprite_frames">`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`The [SpriteFrames] resource containing the animation(s).`
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			`</member>`
Remove AnimatedSprite3D.`is_playing()` for redundancy Also removes the underscore prefix from `_set_playing()` and `_is_playing()` 2022-08-09 11:20:07 +00:00			`<member name="playing" type="bool" setter="set_playing" getter="is_playing" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 12:46:54 +00:00			`If [code]true[/code], the [member animation] is currently playing.`
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			`</member>`
Harmonise AnimatedSprite3D and its 2D counterpart Add the following properties to AnimatedSprite3D: - `backwards` parameter in `play()`; - `speed_scale`. Both classes' internals are more similar, down to the line spacings. They've also been updated to be clearer and less inconsistent (e.g. `!frames.is_valid()` -> `frames.is_null()`, use SceneStringNames instead of CoreStringNames, rename the internal _queue_update to _queue_redraw) 2022-08-09 10:57:18 +00:00			`<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0">`
			`The animation speed is multiplied by this value.`
			`</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>`
			`<signals>`
Add animation_finished signal and fix frame_changed signal for AnimatedSprite3D Fixes #40301. Fixes #45947. 2020-07-12 12:39:21 +00:00			`<signal name="animation_finished">`
			`<description>`
			`Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn.`
			`</description>`
			`</signal>`
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			`<signal name="frame_changed">`
			`<description>`
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. 2017-10-06 16:33:16 +00:00			`Emitted when [member frame] changed.`
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>`
			`</signal>`
			`</signals>`
			`</class>`