2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 21:18:53 +08:00
<class name= "Sprite3D" inherits= "SpriteBase3D" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2019-06-22 07:04:47 +08:00
2D sprite node in a 3D world.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2020-09-11 03:38:36 +08: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. See also [SpriteBase3D] where properties such as the billboard mode are defined.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<members >
2019-06-29 18:38:01 +08:00
<member name= "frame" type= "int" setter= "set_frame" getter= "get_frame" default= "0" >
2020-08-22 07:56:14 +08:00
Current frame to display from sprite sheet. [member hframes] or [member vframes] must be greater than 1.
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "frame_coords" type= "Vector2i" setter= "set_frame_coords" getter= "get_frame_coords" default= "Vector2i(0, 0)" >
2020-08-22 07:56:14 +08:00
Coordinates of the frame to display from sprite sheet. This is as an alias for the [member frame] property. [member hframes] or [member vframes] must be greater than 1.
2019-01-26 02:21:23 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "hframes" type= "int" setter= "set_hframes" getter= "get_hframes" default= "1" >
2017-10-07 00:33:16 +08:00
The number of columns in the sprite sheet.
2017-09-13 04:42:36 +08:00
</member>
2021-03-14 21:43:43 +08:00
<member name= "region_enabled" type= "bool" setter= "set_region_enabled" getter= "is_region_enabled" default= "false" >
2017-09-13 04:42:36 +08:00
</member>
2019-09-25 01:45:03 +08:00
<member name= "region_rect" type= "Rect2" setter= "set_region_rect" getter= "get_region_rect" default= "Rect2(0, 0, 0, 0)" >
2017-10-07 00:33:16 +08:00
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
2017-09-13 04:42:36 +08:00
</member>
2020-02-12 16:59:06 +08:00
<member name= "texture" type= "Texture2D" setter= "set_texture" getter= "get_texture" >
[Texture2D] object to draw.
2017-09-13 04:42:36 +08:00
</member>
2019-06-29 18:38:01 +08:00
<member name= "vframes" type= "int" setter= "set_vframes" getter= "get_vframes" default= "1" >
2017-10-07 00:33:16 +08:00
The number of rows in the sprite sheet.
2017-09-13 04:42:36 +08:00
</member>
</members>
<signals >
<signal name= "frame_changed" >
<description >
2017-10-07 00:33:16 +08:00
Emitted when the [member frame] changes.
2017-09-13 04:42:36 +08:00
</description>
</signal>
2021-10-01 15:14:05 +08:00
<signal name= "texture_changed" >
<description >
Emitted when the [member texture] changes.
</description>
</signal>
2017-09-13 04:42:36 +08:00
</signals>
</class>