From a2f504c728d08233b2749a3f9b5297abcf39203b Mon Sep 17 00:00:00 2001 From: Grosskopf Date: Fri, 6 Oct 2017 18:33:16 +0200 Subject: [PATCH] Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc. --- doc/classes/AnimatedSprite.xml | 10 +++++----- doc/classes/AnimatedSprite3D.xml | 8 +++++++- doc/classes/Sprite.xml | 18 ++++++++++-------- doc/classes/Sprite3D.xml | 9 +++++++++ doc/classes/SpriteBase3D.xml | 17 +++++++++++++++++ 5 files changed, 48 insertions(+), 14 deletions(-) diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index 809890bea1d..dce7bf283a2 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -4,7 +4,7 @@ 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. + Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel. @@ -149,7 +149,7 @@ - The current animation from the [code]frames[/code] resource. If this value is changed, the [code]frame[/code] counter is reset. + The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. If [code]true[/code] texture will be centered. Default value: [code]true[/code]. @@ -161,7 +161,7 @@ If [code]true[/code] texture is flipped vertically. Default value: [code]false[/code]. - The current frame index. + The displayed animation frame's index. The [SpriteFrames] resource containing the animation(s). @@ -170,7 +170,7 @@ The texture's drawing offset. - If [code]true[/code] the [code]animation[/code] is currently playing. + If [code]true[/code] the [member animation] is currently playing. @@ -181,7 +181,7 @@ - Emitted when [code]frame[/code] changes. + Emitted when [member frame] changed. diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index 4e28f7de8db..b0bb7bb6ab4 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -1,8 +1,10 @@ + 2D sprite node in 3D world, that can use multiple 2D textures for animation. + Animations are created using a [SpriteFrames] resource, which can be configured in the editor via the SpriteFrames panel. @@ -83,18 +85,22 @@ + The current animation from the [code]frames[/code] resource. If this value changes, the [code]frame[/code] counter is reset. + The displayed animation frame's index. + The [SpriteFrames] resource containing the animation(s). + If [code]true[/code] the [member animation] is currently playing. - Emitted when frame is changed. + Emitted when [member frame] changed. diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index c0c491140f9..0cdc8f70996 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -202,7 +202,7 @@ - If [code]true[/code] texture will be centered. Default value: [code]true[/code]. + If [code]true[/code] texture is centered. Default value: [code]true[/code]. If [code]true[/code] texture is flipped horizontally. Default value: [code]false[/code]. @@ -211,40 +211,42 @@ 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. + Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1. - The number of horizontal frames in the sprite sheet. + The number of collumns in the sprite sheet. + The normal map gives depth to the Sprite. 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]. + If [code]true[/code] texture is cut from a larger atlas texture. See [code]region_rect[/code]. Default value: [code]false[/code]. + If [code]true[/code] the outermost pixels get blurred out. - The region of the atlas texture to display. [code]region_enabled[/code] must be [code]true[/code]. + The region of the atlas texture to display. [member region_enabled] must be [code]true[/code]. [Texture] object to draw. - The number of vertical frames in the sprite sheet. + The number of rows in the sprite sheet. - Emitted when the [code]frame[/code] changes. + Emitted when the [member frame] changes. - Emitted when the [code]texture[/code] changes. + Emitted when the [member texture] changes. diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml index f6f2f8f00c8..e51616a071b 100644 --- a/doc/classes/Sprite3D.xml +++ b/doc/classes/Sprite3D.xml @@ -1,8 +1,10 @@ + 2D Sprite node in 3D world. + A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. @@ -96,21 +98,28 @@ + Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1. + The number of columns in the sprite sheet. + If [code]true[/code] texture will be cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code]. + The region of the atlas texture to display. [member region_enabled] must be [code]true[/code]. + [Texture] object to draw. + The number of rows in the sprite sheet. + Emitted when the [member frame] changes. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 1640e5dc9f1..7ed681ea128 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -1,8 +1,10 @@ + 2D Sprite node in 3D environment. + A node that displays 2D texture information in a 3D environment. @@ -164,36 +166,51 @@ + The direction in which the front of the texture faces. + If [code]true[/code] texture will be centered. Default value: [code]true[/code]. + If [code]true[/code] texture can be seen from the back as well, if [code]false[/code], it is invisible when looking at it from behind. 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]. + A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light. + The texture's drawing offset. + The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible. + The size of one pixel's width on the Sprite to scale it in 3D. + If [code]true[/code] the [Light] in the [Environment] has effects on the Sprite. Default value: [code]false[/code]. + If [code]true[/code] the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: [code]true[/code]. + If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible. + If set, the Light in the Environment has effects on the Sprite. + If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind. + Used internally to mark the end of the Flags section.