From 7c863d43b8ed94fb9d5cdb0cc61e33836b7c5e91 Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sat, 23 Sep 2017 09:11:51 -0700 Subject: [PATCH] [DOCS] Update Sprite class ref --- doc/classes/Sprite.xml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index 90ebe79666d..c0c491140f9 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -4,7 +4,7 @@ General purpose Sprite node. - General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas. + A node that displays a 2D texture. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. @@ -202,37 +202,49 @@ + If [code]true[/code] texture will be centered. Default value: [code]true[/code]. + If [code]true[/code] texture is flipped horizontally. Default value: [code]false[/code]. + If [code]true[/code] texture is flipped vertically. Default value: [code]false[/code]. + Current frame to display from sprite sheet. [code]vframes[/code] or [code]hframes[/code] must be greater than 1. + The number of horizontal frames in the sprite sheet. + The texture's drawing offset. + If [code]true[/code] texture will be cut from a larger atlas texture. See [code]region_rect[/code]. Default value: [code]false[/code]. + The region of the atlas texture to display. [code]region_enabled[/code] must be [code]true[/code]. + [Texture] object to draw. + The number of vertical frames in the sprite sheet. + Emitted when the [code]frame[/code] changes. + Emitted when the [code]texture[/code] changes.