summaryrefslogtreecommitdiff
path: root/doc/classes/Sprite3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/Sprite3D.xml')
-rw-r--r--doc/classes/Sprite3D.xml16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/classes/Sprite3D.xml b/doc/classes/Sprite3D.xml
index 81fe182782..78004c60ee 100644
--- a/doc/classes/Sprite3D.xml
+++ b/doc/classes/Sprite3D.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Sprite3D" inherits="SpriteBase3D" category="Core" version="3.2">
<brief_description>
- 2D Sprite node in 3D world.
+ 2D sprite node in a 3D world.
</brief_description>
<description>
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.
@@ -11,22 +11,22 @@
<methods>
</methods>
<members>
- <member name="frame" type="int" setter="set_frame" getter="get_frame">
+ <member name="frame" type="int" setter="set_frame" getter="get_frame" default="0">
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
</member>
- <member name="hframes" type="int" setter="set_hframes" getter="get_hframes">
+ <member name="hframes" type="int" setter="set_hframes" getter="get_hframes" default="1">
The number of columns in the sprite sheet.
</member>
- <member name="region_enabled" type="bool" setter="set_region" getter="is_region">
- If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code].
+ <member name="region_enabled" type="bool" setter="set_region" getter="is_region" default="false">
+ If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect].
</member>
- <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
+ <member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect" default="Rect2( 0, 0, 0, 0 )">
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
</member>
- <member name="texture" type="Texture" setter="set_texture" getter="get_texture">
+ <member name="texture" type="Texture" setter="set_texture" getter="get_texture" default="null">
[Texture] object to draw.
</member>
- <member name="vframes" type="int" setter="set_vframes" getter="get_vframes">
+ <member name="vframes" type="int" setter="set_vframes" getter="get_vframes" default="1">
The number of rows in the sprite sheet.
</member>
</members>