:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Sprite2D.xml. .. _class_Sprite2D: Sprite2D ======== **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` General-purpose sprite node. .. rst-class:: classref-introduction-group 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. .. rst-class:: classref-introduction-group Tutorials --------- - `Instancing Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`centered` | ``true`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`flip_h` | ``false`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`flip_v` | ``false`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`frame` | ``0`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector2i` | :ref:`frame_coords` | ``Vector2i(0, 0)`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`hframes` | ``1`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`region_enabled` | ``false`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`region_filter_clip_enabled` | ``false`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`Rect2` | :ref:`region_rect` | ``Rect2(0, 0, 0, 0)`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture` | | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`vframes` | ``1`` | +-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_rect`\ (\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pixel_opaque`\ (\ pos\: :ref:`Vector2`\ ) |const| | +---------------------------+------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_Sprite2D_signal_frame_changed: .. rst-class:: classref-signal **frame_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`frame` changes. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_signal_texture_changed: .. rst-class:: classref-signal **texture_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`texture` changes. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Sprite2D_property_centered: .. rst-class:: classref-property :ref:`bool` **centered** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_centered**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_centered**\ (\ ) If ``true``, texture is centered. \ **Note:** For games with a pixel art aesthetic, textures may appear deformed when centered. This is caused by their position being between pixels. To prevent this, set this property to ``false``, or consider enabling :ref:`ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel` and :ref:`ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel`. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_flip_h: .. rst-class:: classref-property :ref:`bool` **flip_h** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_flip_h**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_flipped_h**\ (\ ) If ``true``, texture is flipped horizontally. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_flip_v: .. rst-class:: classref-property :ref:`bool` **flip_v** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_flip_v**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_flipped_v**\ (\ ) If ``true``, texture is flipped vertically. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_frame: .. rst-class:: classref-property :ref:`int` **frame** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_frame**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_frame**\ (\ ) Current frame to display from sprite sheet. :ref:`hframes` or :ref:`vframes` must be greater than 1. This property is automatically adjusted when :ref:`hframes` or :ref:`vframes` are changed to keep pointing to the same visual frame (same column and row). If that's impossible, this value is reset to ``0``. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_frame_coords: .. rst-class:: classref-property :ref:`Vector2i` **frame_coords** = ``Vector2i(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_frame_coords**\ (\ value\: :ref:`Vector2i`\ ) - :ref:`Vector2i` **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. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_hframes: .. rst-class:: classref-property :ref:`int` **hframes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_hframes**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_hframes**\ (\ ) The number of columns in the sprite sheet. When this property is changed, :ref:`frame` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame` is reset to ``0``. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_offset: .. rst-class:: classref-property :ref:`Vector2` **offset** = ``Vector2(0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_offset**\ (\ value\: :ref:`Vector2`\ ) - :ref:`Vector2` **get_offset**\ (\ ) The texture's drawing offset. \ **Note:** When you increase :ref:`offset`.y in Sprite2D, the sprite moves downward on screen (i.e., +Y is down). .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_region_enabled: .. rst-class:: classref-property :ref:`bool` **region_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_region_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_region_enabled**\ (\ ) If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect`. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_region_filter_clip_enabled: .. rst-class:: classref-property :ref:`bool` **region_filter_clip_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_region_filter_clip_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_region_filter_clip_enabled**\ (\ ) If ``true``, the area outside of the :ref:`region_rect` is clipped to avoid bleeding of the surrounding texture pixels. :ref:`region_enabled` must be ``true``. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_region_rect: .. rst-class:: classref-property :ref:`Rect2` **region_rect** = ``Rect2(0, 0, 0, 0)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_region_rect**\ (\ value\: :ref:`Rect2`\ ) - :ref:`Rect2` **get_region_rect**\ (\ ) The region of the atlas texture to display. :ref:`region_enabled` must be ``true``. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_texture: .. rst-class:: classref-property :ref:`Texture2D` **texture** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_texture**\ (\ value\: :ref:`Texture2D`\ ) - :ref:`Texture2D` **get_texture**\ (\ ) :ref:`Texture2D` object to draw. .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_property_vframes: .. rst-class:: classref-property :ref:`int` **vframes** = ``1`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_vframes**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_vframes**\ (\ ) The number of rows in the sprite sheet. When this property is changed, :ref:`frame` is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, :ref:`frame` is reset to ``0``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Sprite2D_method_get_rect: .. rst-class:: classref-method :ref:`Rect2` **get_rect**\ (\ ) |const| :ref:`🔗` Returns a :ref:`Rect2` representing the Sprite2D's boundary in local coordinates. \ **Example:** Detect if the Sprite2D was clicked: .. tabs:: .. code-tab:: gdscript func _input(event): if event is InputEventMouseButton and event.pressed and event.button_index == MOUSE_BUTTON_LEFT: if get_rect().has_point(to_local(event.position)): print("A click!") .. code-tab:: csharp public override void _Input(InputEvent @event) { if (@event is InputEventMouseButton inputEventMouse) { if (inputEventMouse.Pressed && inputEventMouse.ButtonIndex == MouseButton.Left) { if (GetRect().HasPoint(ToLocal(inputEventMouse.Position))) { GD.Print("A click!"); } } } } .. rst-class:: classref-item-separator ---- .. _class_Sprite2D_method_is_pixel_opaque: .. rst-class:: classref-method :ref:`bool` **is_pixel_opaque**\ (\ pos\: :ref:`Vector2`\ ) |const| :ref:`🔗` Returns ``true``, if the pixel at the given position is opaque and ``false`` in other case. The position is in local coordinates. \ **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.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`