class_sprite.rst

github_url

hide

Sprite

Inherits: Node2D<class_Node2D> < CanvasItem<class_CanvasItem> < Node<class_Node> < Object<class_Object>

Category: Core

Brief Description

General purpose Sprite node.

Properties

bool<class_bool>	centered<class_Sprite_property_centered>
bool<class_bool>	flip_h<class_Sprite_property_flip_h>
bool<class_bool>	flip_v<class_Sprite_property_flip_v>
int<class_int>	frame<class_Sprite_property_frame>
int<class_int>	hframes<class_Sprite_property_hframes>
Texture<class_Texture>	normal_map<class_Sprite_property_normal_map>
Vector2<class_Vector2>	offset<class_Sprite_property_offset>
bool<class_bool>	region_enabled<class_Sprite_property_region_enabled>
bool<class_bool>	region_filter_clip<class_Sprite_property_region_filter_clip>
Rect2<class_Rect2>	region_rect<class_Sprite_property_region_rect>
Texture<class_Texture>	texture<class_Sprite_property_texture>
int<class_int>	vframes<class_Sprite_property_vframes>

Methods

Rect2<class_Rect2>	get_rect<class_Sprite_method_get_rect> ( ) const
bool<class_bool>	is_pixel_opaque<class_Sprite_method_is_pixel_opaque> ( Vector2<class_Vector2> pos ) const

Signals

• frame_changed ( )

Emitted when the frame<class_Sprite_property_frame> changes.

---

• texture_changed ( )

Emitted when the texture<class_Sprite_property_texture> changes.

Description

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.

Property Descriptions

• bool<class_bool> centered

Setter	set_centered(value)
Getter	is_centered()

If true, texture is centered. Default value: true.

---

• bool<class_bool> flip_h

Setter	set_flip_h(value)
Getter	is_flipped_h()

If true, texture is flipped horizontally. Default value: false.

---

• bool<class_bool> flip_v

Setter	set_flip_v(value)
Getter	is_flipped_v()

If true, texture is flipped vertically. Default value: false.

---

• int<class_int> frame

Setter	set_frame(value)
Getter	get_frame()

Current frame to display from sprite sheet. vframes<class_Sprite_property_vframes> or hframes<class_Sprite_property_hframes> must be greater than 1.

---

• int<class_int> hframes

Setter	set_hframes(value)
Getter	get_hframes()

The number of columns in the sprite sheet.

---

• Texture<class_Texture> normal_map

Setter	set_normal_map(value)
Getter	get_normal_map()

The normal map gives depth to the Sprite.

---

• Vector2<class_Vector2> offset

Setter	set_offset(value)
Getter	get_offset()

The texture's drawing offset.

---

• bool<class_bool> region_enabled

Setter	set_region(value)
Getter	is_region()

If true, texture is cut from a larger atlas texture. See region_rect<class_Sprite_property_region_rect>. Default value: false.

---

• bool<class_bool> region_filter_clip

Setter	set_region_filter_clip(value)
Getter	is_region_filter_clip_enabled()

If true, the outermost pixels get blurred out.

---

• Rect2<class_Rect2> region_rect

Setter	set_region_rect(value)
Getter	get_region_rect()

The region of the atlas texture to display. region_enabled<class_Sprite_property_region_enabled> must be true.

---

• Texture<class_Texture> texture

Setter	set_texture(value)
Getter	get_texture()

Texture<class_Texture> object to draw.

---

• int<class_int> vframes

Setter	set_vframes(value)
Getter	get_vframes()

The number of rows in the sprite sheet.

Method Descriptions

• Rect2<class_Rect2> get_rect ( ) const

Returns a Rect2<class_Rect2> representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example:

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!")

---

• bool<class_bool> is_pixel_opaque ( Vector2<class_Vector2> pos ) const

Returns true, if the pixel at the given position is opaque and false in other case.

Note: It also returns false, if the sprite's texture is null or if the given position is invalid.