Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Sprite2D

Inherits: Node2D < CanvasItem < Node < Object

General-purpose sprite node.

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.

Tutorials

• Instancing Demo

Properties

bool	centered	true
bool	flip_h	false
bool	flip_v	false
int	frame	0
Vector2i	frame_coords	Vector2i(0, 0)
int	hframes	1
Vector2	offset	Vector2(0, 0)
bool	region_enabled	false
bool	region_filter_clip_enabled	false
Rect2	region_rect	Rect2(0, 0, 0, 0)
Texture2D	texture
int	vframes	1

Methods

Rect2	get_rect ( ) const
bool	is_pixel_opaque ( Vector2 pos ) const

---

Signals

frame_changed ( )

Emitted when the frame changes.

---

texture_changed ( )

Emitted when the texture changes.

---

Property Descriptions

bool centered = true

• void set_centered ( bool value )

• bool is_centered ( )

If true, texture is centered.

---

bool flip_h = false

• void set_flip_h ( bool value )

• bool is_flipped_h ( )

If true, texture is flipped horizontally.

---

bool flip_v = false

• void set_flip_v ( bool value )

• bool is_flipped_v ( )

If true, texture is flipped vertically.

---

int frame = 0

• void set_frame ( int value )

• int get_frame ( )

Current frame to display from sprite sheet.