2017-09-12 20:42:36 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2019-07-05 09:32:53 +00:00
|
|
|
<class name="Sprite" inherits="Node2D" category="Core" version="3.1.2">
|
2017-09-12 20:42:36 +00:00
|
|
|
<brief_description>
|
|
|
|
General purpose Sprite node.
|
|
|
|
</brief_description>
|
|
|
|
<description>
|
2017-09-23 16:11:51 +00:00
|
|
|
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.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
|
|
|
</tutorials>
|
|
|
|
<methods>
|
2018-02-25 06:19:42 +00:00
|
|
|
<method name="get_rect" qualifiers="const">
|
|
|
|
<return type="Rect2">
|
|
|
|
</return>
|
|
|
|
<description>
|
2019-05-26 13:51:27 +00:00
|
|
|
Returns a [Rect2] representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example:
|
|
|
|
[codeblock]
|
|
|
|
func _input(event):
|
|
|
|
if event is InputEventMouseButton and event.pressed and event.button_index == BUTTON_LEFT:
|
|
|
|
if get_rect().has_point(to_local(event.position)):
|
|
|
|
print("A click!")
|
|
|
|
[/codeblock]
|
2018-02-25 06:19:42 +00:00
|
|
|
</description>
|
|
|
|
</method>
|
2018-08-29 20:25:11 +00:00
|
|
|
<method name="is_pixel_opaque" qualifiers="const">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="pos" type="Vector2">
|
|
|
|
</argument>
|
|
|
|
<description>
|
|
|
|
</description>
|
|
|
|
</method>
|
2017-09-12 20:42:36 +00:00
|
|
|
</methods>
|
|
|
|
<members>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="centered" type="bool" setter="set_centered" getter="is_centered">
|
2018-12-20 12:46:54 +00:00
|
|
|
If [code]true[/code], texture is centered. Default value: [code]true[/code].
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="flip_h" type="bool" setter="set_flip_h" getter="is_flipped_h">
|
2018-12-20 12:46:54 +00:00
|
|
|
If [code]true[/code], texture is flipped horizontally. Default value: [code]false[/code].
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="flip_v" type="bool" setter="set_flip_v" getter="is_flipped_v">
|
2018-12-20 12:46:54 +00:00
|
|
|
If [code]true[/code], texture is flipped vertically. Default value: [code]false[/code].
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="frame" type="int" setter="set_frame" getter="get_frame">
|
2017-10-06 16:33:16 +00:00
|
|
|
Current frame to display from sprite sheet. [member vframes] or [member hframes] must be greater than 1.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="hframes" type="int" setter="set_hframes" getter="get_hframes">
|
2018-02-21 16:30:55 +00:00
|
|
|
The number of columns in the sprite sheet.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
|
2017-10-06 16:33:16 +00:00
|
|
|
The normal map gives depth to the Sprite.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="offset" type="Vector2" setter="set_offset" getter="get_offset">
|
2017-09-23 16:11:51 +00:00
|
|
|
The texture's drawing offset.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="region_enabled" type="bool" setter="set_region" getter="is_region">
|
2019-05-26 13:51:27 +00:00
|
|
|
If [code]true[/code], texture is cut from a larger atlas texture. See [member region_rect]. Default value: [code]false[/code].
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="region_filter_clip" type="bool" setter="set_region_filter_clip" getter="is_region_filter_clip_enabled">
|
2018-12-20 12:46:54 +00:00
|
|
|
If [code]true[/code], the outermost pixels get blurred out.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="region_rect" type="Rect2" setter="set_region_rect" getter="get_region_rect">
|
2017-10-06 16:33:16 +00:00
|
|
|
The region of the atlas texture to display. [member region_enabled] must be [code]true[/code].
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="texture" type="Texture" setter="set_texture" getter="get_texture">
|
2017-09-23 16:11:51 +00:00
|
|
|
[Texture] object to draw.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
2017-09-13 06:49:40 +00:00
|
|
|
<member name="vframes" type="int" setter="set_vframes" getter="get_vframes">
|
2017-10-06 16:33:16 +00:00
|
|
|
The number of rows in the sprite sheet.
|
2017-09-12 20:42:36 +00:00
|
|
|
</member>
|
|
|
|
</members>
|
|
|
|
<signals>
|
|
|
|
<signal name="frame_changed">
|
|
|
|
<description>
|
2017-10-06 16:33:16 +00:00
|
|
|
Emitted when the [member frame] changes.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
<signal name="texture_changed">
|
|
|
|
<description>
|
2017-10-06 16:33:16 +00:00
|
|
|
Emitted when the [member texture] changes.
|
2017-09-12 20:42:36 +00:00
|
|
|
</description>
|
|
|
|
</signal>
|
|
|
|
</signals>
|
|
|
|
<constants>
|
|
|
|
</constants>
|
|
|
|
</class>
|