godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #11625 from cbscribe/kcc_sprite_doc 

[DOCS] Update AnimatedSprite class ref

[ci skip]
This commit is contained in:
Rémi Verschelde 2017-09-27 08:58:39 +02:00 committed by GitHub
parent 0dbec3abbb 129a37421d
commit 6eb5af2b5a
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/classes/AnimatedSprite.xml
View File

@ -4,7 +4,7 @@
Sprite node that can use multiple textures for animation. Sprite node that can use multiple textures for animation.
</brief_description> </brief_description>
<description> <description>
Sprite node that can use multiple textures for animation. Sprite node that can use multiple textures for animation. Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -149,31 +149,39 @@
</methods> </methods>
<members> <members>
<member name="animation" type="String" setter="set_animation" getter="get_animation"> <member name="animation" type="String" setter="set_animation" getter="get_animation">
The current animation from the [code]frames[/code] resource. If this value is changed, the [code]frame[/code] counter is reset.
</member> </member>
<member name="centered" type="bool" setter="set_centered" getter="is_centered"> <member name="centered" type="bool" setter="set_centered" getter="is_centered">
If [code]true[/code] texture will be centered. Default value: [code]true[/code].
</member> </member>
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h"> <member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h">
If [code]true[/code] texture is flipped horizontally. Default value: [code]false[/code].
</member> </member>
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v"> <member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v">
If [code]true[/code] texture is flipped vertically. Default value: [code]false[/code].
</member> </member>
<member name="frame" type="int" setter="set_frame" getter="get_frame"> <member name="frame" type="int" setter="set_frame" getter="get_frame">
The current frame index.
</member> </member>
<member name="frames" type="SpriteFrames" setter="set_sprite_frames" getter="get_sprite_frames"> <member name="frames" type="SpriteFrames" setter="set_sprite_frames" getter="get_sprite_frames">
The [SpriteFrames] resource containing the animation(s).
</member> </member>
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset"> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
The texture's drawing offset.
</member> </member>
<member name="playing" type="bool" setter="_set_playing" getter="_is_playing"> <member name="playing" type="bool" setter="_set_playing" getter="_is_playing">
If [code]true[/code] the [code]animation[/code] is currently playing.
</member> </member>
</members> </members>
<signals> <signals>
<signal name="animation_finished"> <signal name="animation_finished">
<description> <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, before looping. 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> </description>
</signal> </signal>
<signal name="frame_changed"> <signal name="frame_changed">
<description> <description>
Emitted when frame is changed. Emitted when [code]frame[/code] changes.
</description> </description>
</signal> </signal>
</signals> </signals>