2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 11:32:53 +02:00
<class name= "Sprite3D" inherits= "SpriteBase3D" category= "Core" version= "3.1.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-10-06 18:33:16 +02:00
2D Sprite node in 3D world.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-10-06 18:33:16 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "frame" type= "int" setter= "set_frame" getter= "get_frame" >
2017-10-06 18:33:16 +02:00
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "hframes" type= "int" setter= "set_hframes" getter= "get_hframes" >
2017-10-06 18:33:16 +02:00
The number of columns in the sprite sheet.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "region_enabled" type= "bool" setter= "set_region" getter= "is_region" >
2018-12-20 13:46:54 +01:00
If [code]true[/code], texture will be cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "region_rect" type= "Rect2" setter= "set_region_rect" getter= "get_region_rect" >
2017-10-06 18:33:16 +02:00
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-10-06 18:33:16 +02:00
[Texture] object to draw.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "vframes" type= "int" setter= "set_vframes" getter= "get_vframes" >
2017-10-06 18:33:16 +02:00
The number of rows in the sprite sheet.
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals >
<signal name= "frame_changed" >
<description >
2017-10-06 18:33:16 +02:00
Emitted when the [member frame] changes.
2017-09-12 22:42:36 +02:00
</description>
</signal>
</signals>
<constants >
</constants>
</class>