:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/Sprite.xml. .. _class_Sprite: Sprite ====== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`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 ---------- +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`centered` | ``true`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`flip_h` | ``false`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`flip_v` | ``false`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`frame` | ``0`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`Vector2` | :ref:`frame_coords` | ``Vector2( 0, 0 )`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`hframes` | ``1`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`Texture` | :ref:`normal_map` | | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2( 0, 0 )`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`region_enabled` | ``false`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`region_filter_clip` | ``false`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`Rect2` | :ref:`region_rect` | ``Rect2( 0, 0, 0, 0 )`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`Texture` | :ref:`texture` | | +-------------------------------+---------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`vframes` | ``1`` | +-------------------------------+---------------------------------------------------------------------+-------------------------+ Methods ------- +---------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_rect` **(** **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pixel_opaque` **(** :ref:`Vector2` pos **)** |const| | +---------------------------+-------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_Sprite_signal_frame_changed: - **frame_changed** **(** **)** Emitted when the :ref:`frame` changes. ---- .. _class_Sprite_signal_texture_changed: - **texture_changed** **(** **)** Emitted when the :ref:`texture` changes. Property Descriptions --------------------- .. _class_Sprite_property_centered: - :ref:`bool` **centered** +-----------+---------------------+ | *Default* | ``true`` | +-----------+---------------------+ | *Setter* | set_centered(value) | +-----------+---------------------+ | *Getter* | is_centered() | +-----------+---------------------+ If ``true``, texture is centered. ---- .. _class_Sprite_property_flip_h: - :ref:`bool` **flip_h** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_flip_h(value) | +-----------+-------------------+ | *Getter* | is_flipped_h() | +-----------+-------------------+ If ``true``, texture is flipped horizontally. ---- .. _class_Sprite_property_flip_v: - :ref:`bool` **flip_v** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_flip_v(value) | +-----------+-------------------+ | *Getter* | is_flipped_v() | +-----------+-------------------+ If ``true``, texture is flipped vertically. ---- .. _class_Sprite_property_frame: - :ref:`int` **frame** +-----------+------------------+ | *Default* | ``0`` | +-----------+------------------+ | *Setter* | set_frame(value) | +-----------+------------------+ | *Getter* | get_frame() | +-----------+------------------+ Current frame to display from sprite sheet. :ref:`hframes` or :ref:`vframes` must be greater than 1. ---- .. _class_Sprite_property_frame_coords: - :ref:`Vector2` **frame_coords** +-----------+-------------------------+ | *Default* | ``Vector2( 0, 0 )`` | +-----------+-------------------------+ | *Setter* | set_frame_coords(value) | +-----------+-------------------------+ | *Getter* | get_frame_coords() | +-----------+-------------------------+ Coordinates of the frame to display from sprite sheet. This is as an alias for the :ref:`frame` property. :ref:`hframes` or :ref:`vframes` must be greater than 1. ---- .. _class_Sprite_property_hframes: - :ref:`int` **hframes** +-----------+--------------------+ | *Default* | ``1`` | +-----------+--------------------+ | *Setter* | set_hframes(value) | +-----------+--------------------+ | *Getter* | get_hframes() | +-----------+--------------------+ The number of columns in the sprite sheet. ---- .. _class_Sprite_property_normal_map: - :ref:`Texture` **normal_map** +----------+-----------------------+ | *Setter* | set_normal_map(value) | +----------+-----------------------+ | *Getter* | get_normal_map() | +----------+-----------------------+ The normal map gives depth to the Sprite. \ **Note:** Godot expects the normal map to use X+, Y-, and Z+ coordinates. See `this page `__ for a comparison of normal map coordinates expected by popular engines. ---- .. _class_Sprite_property_offset: - :ref:`Vector2` **offset** +-----------+---------------------+ | *Default* | ``Vector2( 0, 0 )`` | +-----------+---------------------+ | *Setter* | set_offset(value) | +-----------+---------------------+ | *Getter* | get_offset() | +-----------+---------------------+ The texture's drawing offset. ---- .. _class_Sprite_property_region_enabled: - :ref:`bool` **region_enabled** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_region(value) | +-----------+-------------------+ | *Getter* | is_region() | +-----------+-------------------+ If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. ---- .. _class_Sprite_property_region_filter_clip: - :ref:`bool` **region_filter_clip** +-----------+---------------------------------+ | *Default* | ``false`` | +-----------+---------------------------------+ | *Setter* | set_region_filter_clip(value) | +-----------+---------------------------------+ | *Getter* | is_region_filter_clip_enabled() | +-----------+---------------------------------+ If ``true``, the outermost pixels get blurred out. ---- .. _class_Sprite_property_region_rect: - :ref:`Rect2` **region_rect** +-----------+-------------------------+ | *Default* | ``Rect2( 0, 0, 0, 0 )`` | +-----------+-------------------------+ | *Setter* | set_region_rect(value) | +-----------+-------------------------+ | *Getter* | get_region_rect() | +-----------+-------------------------+ The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. ---- .. _class_Sprite_property_texture: - :ref:`Texture` **texture** +----------+--------------------+ | *Setter* | set_texture(value) | +----------+--------------------+ | *Getter* | get_texture() | +----------+--------------------+ :ref:`Texture` object to draw. ---- .. _class_Sprite_property_vframes: - :ref:`int` **vframes** +-----------+--------------------+ | *Default* | ``1`` | +-----------+--------------------+ | *Setter* | set_vframes(value) | +-----------+--------------------+ | *Getter* | get_vframes() | +-----------+--------------------+ The number of rows in the sprite sheet. Method Descriptions ------------------- .. _class_Sprite_method_get_rect: - :ref:`Rect2` **get_rect** **(** **)** |const| Returns a :ref:`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!") ---- .. _class_Sprite_method_is_pixel_opaque: - :ref:`bool` **is_pixel_opaque** **(** :ref:`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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`