godot-docs/classes/class_sprite.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Sprite.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Sprite:

Sprite
======

**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_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.

Properties
----------

+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`           | :ref:`centered<class_Sprite_property_centered>`                     | ``true``                |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`           | :ref:`flip_h<class_Sprite_property_flip_h>`                         | ``false``               |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`           | :ref:`flip_v<class_Sprite_property_flip_v>`                         | ``false``               |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>`             | :ref:`frame<class_Sprite_property_frame>`                           | ``0``                   |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Vector2<class_Vector2>`     | :ref:`frame_coords<class_Sprite_property_frame_coords>`             | ``Vector2( 0, 0 )``     |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>`             | :ref:`hframes<class_Sprite_property_hframes>`                       | ``1``                   |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`normal_map<class_Sprite_property_normal_map>`                 |                         |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Vector2<class_Vector2>`     | :ref:`offset<class_Sprite_property_offset>`                         | ``Vector2( 0, 0 )``     |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`           | :ref:`region_enabled<class_Sprite_property_region_enabled>`         | ``false``               |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`bool<class_bool>`           | :ref:`region_filter_clip<class_Sprite_property_region_filter_clip>` | ``false``               |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Rect2<class_Rect2>`         | :ref:`region_rect<class_Sprite_property_region_rect>`               | ``Rect2( 0, 0, 0, 0 )`` |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`float<class_float>`         | :ref:`shininess<class_Sprite_property_shininess>`                   | ``1.0``                 |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Color<class_Color>`         | :ref:`specular_color<class_Sprite_property_specular_color>`         | ``Color( 1, 1, 1, 1 )`` |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`specular_map<class_Sprite_property_specular_map>`             |                         |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_Sprite_property_texture>`                       |                         |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+
| :ref:`int<class_int>`             | :ref:`vframes<class_Sprite_property_vframes>`                       | ``1``                   |
+-----------------------------------+---------------------------------------------------------------------+-------------------------+

Methods
-------

+---------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`get_rect<class_Sprite_method_get_rect>` **(** **)** const                                                 |
+---------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`is_pixel_opaque<class_Sprite_method_is_pixel_opaque>` **(** :ref:`Vector2<class_Vector2>` pos **)** const |
+---------------------------+-----------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_Sprite_signal_frame_changed:

- **frame_changed** **(** **)**

Emitted when the :ref:`frame<class_Sprite_property_frame>` changes.

----

.. _class_Sprite_signal_texture_changed:

- **texture_changed** **(** **)**

Emitted when the :ref:`texture<class_Sprite_property_texture>` changes.

Property Descriptions
---------------------

.. _class_Sprite_property_centered:

- :ref:`bool<class_bool>` **centered**

+-----------+---------------------+
| *Default* | ``true``            |
+-----------+---------------------+
| *Setter*  | set_centered(value) |
+-----------+---------------------+
| *Getter*  | is_centered()       |
+-----------+---------------------+

If ``true``, texture is centered.

----

.. _class_Sprite_property_flip_h:

- :ref:`bool<class_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<class_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<class_int>` **frame**

+-----------+------------------+
| *Default* | ``0``            |
+-----------+------------------+
| *Setter*  | set_frame(value) |
+-----------+------------------+
| *Getter*  | get_frame()      |
+-----------+------------------+

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

----

.. _class_Sprite_property_frame_coords:

- :ref:`Vector2<class_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<class_Sprite_property_frame>` property. :ref:`vframes<class_Sprite_property_vframes>` or :ref:`hframes<class_Sprite_property_hframes>` must be greater than 1.

----

.. _class_Sprite_property_hframes:

- :ref:`int<class_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:`Texture2D<class_Texture2D>` **normal_map**

+----------+-----------------------+
| *Setter* | set_normal_map(value) |
+----------+-----------------------+
| *Getter* | get_normal_map()      |
+----------+-----------------------+

The normal map gives depth to the Sprite.

----

.. _class_Sprite_property_offset:

- :ref:`Vector2<class_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<class_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_rect>`.

----

.. _class_Sprite_property_region_filter_clip:

- :ref:`bool<class_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<class_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<class_Sprite_property_region_enabled>` must be ``true``.

----

.. _class_Sprite_property_shininess:

- :ref:`float<class_float>` **shininess**

+-----------+----------------------+
| *Default* | ``1.0``              |
+-----------+----------------------+
| *Setter*  | set_shininess(value) |
+-----------+----------------------+
| *Getter*  | get_shininess()      |
+-----------+----------------------+

Strength of the specular light effect of this ``Sprite``.

----

.. _class_Sprite_property_specular_color:

- :ref:`Color<class_Color>` **specular_color**

+-----------+---------------------------+
| *Default* | ``Color( 1, 1, 1, 1 )``   |
+-----------+---------------------------+
| *Setter*  | set_specular_color(value) |
+-----------+---------------------------+
| *Getter*  | get_specular_color()      |
+-----------+---------------------------+

The color of the specular light effect.

----

.. _class_Sprite_property_specular_map:

- :ref:`Texture2D<class_Texture2D>` **specular_map**

+----------+-------------------------+
| *Setter* | set_specular_map(value) |
+----------+-------------------------+
| *Getter* | get_specular_map()      |
+----------+-------------------------+

The specular map is used for more control on the shininess effect.

----

.. _class_Sprite_property_texture:

- :ref:`Texture2D<class_Texture2D>` **texture**

+----------+--------------------+
| *Setter* | set_texture(value) |
+----------+--------------------+
| *Getter* | get_texture()      |
+----------+--------------------+

:ref:`Texture2D<class_Texture2D>` object to draw.

----

.. _class_Sprite_property_vframes:

- :ref:`int<class_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<class_Rect2>` **get_rect** **(** **)** const

Returns a :ref:`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!")

----

.. _class_Sprite_method_is_pixel_opaque:

- :ref:`bool<class_bool>` **is_pixel_opaque** **(** :ref:`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.