mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
325 lines
13 KiB
ReStructuredText
325 lines
13 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the Sprite2D.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Sprite2D:
|
|
|
|
Sprite2D
|
|
========
|
|
|
|
**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.
|
|
|
|
Tutorials
|
|
---------
|
|
|
|
- `Instancing Demo <https://godotengine.org/asset-library/asset/148>`__
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`centered<class_Sprite2D_property_centered>` | ``true`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`flip_h<class_Sprite2D_property_flip_h>` | ``false`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`flip_v<class_Sprite2D_property_flip_v>` | ``false`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`frame<class_Sprite2D_property_frame>` | ``0`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Vector2i<class_Vector2i>` | :ref:`frame_coords<class_Sprite2D_property_frame_coords>` | ``Vector2i(0, 0)`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`hframes<class_Sprite2D_property_hframes>` | ``1`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_Sprite2D_property_offset>` | ``Vector2(0, 0)`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`region_enabled<class_Sprite2D_property_region_enabled>` | ``false`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`region_filter_clip_enabled<class_Sprite2D_property_region_filter_clip_enabled>` | ``false`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`region_rect<class_Sprite2D_property_region_rect>` | ``Rect2(0, 0, 0, 0)`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_Sprite2D_property_texture>` | |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
| :ref:`int<class_int>` | :ref:`vframes<class_Sprite2D_property_vframes>` | ``1`` |
|
|
+-----------------------------------+---------------------------------------------------------------------------------------+-----------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+---------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Rect2<class_Rect2>` | :ref:`get_rect<class_Sprite2D_method_get_rect>` **(** **)** |const| |
|
|
+---------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_pixel_opaque<class_Sprite2D_method_is_pixel_opaque>` **(** :ref:`Vector2<class_Vector2>` pos **)** |const| |
|
|
+---------------------------+---------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_Sprite2D_signal_frame_changed:
|
|
|
|
- **frame_changed** **(** **)**
|
|
|
|
Emitted when the :ref:`frame<class_Sprite2D_property_frame>` changes.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_signal_texture_changed:
|
|
|
|
- **texture_changed** **(** **)**
|
|
|
|
Emitted when the :ref:`texture<class_Sprite2D_property_texture>` changes.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_Sprite2D_property_centered:
|
|
|
|
- :ref:`bool<class_bool>` **centered**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``true`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_centered(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | is_centered() |
|
|
+-----------+---------------------+
|
|
|
|
If ``true``, texture is centered.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_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_Sprite2D_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_Sprite2D_property_frame:
|
|
|
|
- :ref:`int<class_int>` **frame**
|
|
|
|
+-----------+------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+------------------+
|
|
| *Setter* | set_frame(value) |
|
|
+-----------+------------------+
|
|
| *Getter* | get_frame() |
|
|
+-----------+------------------+
|
|
|
|
Current frame to display from sprite sheet. :ref:`hframes<class_Sprite2D_property_hframes>` or :ref:`vframes<class_Sprite2D_property_vframes>` must be greater than 1.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_property_frame_coords:
|
|
|
|
- :ref:`Vector2i<class_Vector2i>` **frame_coords**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``Vector2i(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_Sprite2D_property_frame>` property. :ref:`hframes<class_Sprite2D_property_hframes>` or :ref:`vframes<class_Sprite2D_property_vframes>` must be greater than 1.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_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_Sprite2D_property_offset:
|
|
|
|
- :ref:`Vector2<class_Vector2>` **offset**
|
|
|
|
+-----------+-------------------+
|
|
| *Default* | ``Vector2(0, 0)`` |
|
|
+-----------+-------------------+
|
|
| *Setter* | set_offset(value) |
|
|
+-----------+-------------------+
|
|
| *Getter* | get_offset() |
|
|
+-----------+-------------------+
|
|
|
|
The texture's drawing offset.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_property_region_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **region_enabled**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_region_enabled(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | is_region_enabled() |
|
|
+-----------+---------------------------+
|
|
|
|
If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect<class_Sprite2D_property_region_rect>`.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_property_region_filter_clip_enabled:
|
|
|
|
- :ref:`bool<class_bool>` **region_filter_clip_enabled**
|
|
|
|
+-----------+---------------------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+---------------------------------------+
|
|
| *Setter* | set_region_filter_clip_enabled(value) |
|
|
+-----------+---------------------------------------+
|
|
| *Getter* | is_region_filter_clip_enabled() |
|
|
+-----------+---------------------------------------+
|
|
|
|
If ``true``, the outermost pixels get blurred out. :ref:`region_enabled<class_Sprite2D_property_region_enabled>` must be ``true``.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_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_Sprite2D_property_region_enabled>` must be ``true``.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_property_texture:
|
|
|
|
- :ref:`Texture2D<class_Texture2D>` **texture**
|
|
|
|
+----------+--------------------+
|
|
| *Setter* | set_texture(value) |
|
|
+----------+--------------------+
|
|
| *Getter* | get_texture() |
|
|
+----------+--------------------+
|
|
|
|
:ref:`Texture2D<class_Texture2D>` object to draw.
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_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_Sprite2D_method_get_rect:
|
|
|
|
- :ref:`Rect2<class_Rect2>` **get_rect** **(** **)** |const|
|
|
|
|
Returns a :ref:`Rect2<class_Rect2>` representing the Sprite2D's boundary in local coordinates. Can be used to detect if the Sprite2D was clicked. Example:
|
|
|
|
|
|
.. 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 inputEvent)
|
|
{
|
|
if (inputEvent is InputEventMouseButton inputEventMouse)
|
|
{
|
|
if (inputEventMouse.Pressed && inputEventMouse.ButtonIndex == (int)ButtonList.Left)
|
|
{
|
|
if (GetRect().HasPoint(ToLocal(inputEventMouse.Position)))
|
|
{
|
|
GD.Print("A click!");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
|
|
----
|
|
|
|
.. _class_Sprite2D_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.
|
|
|
|
.. |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.)`
|
|
.. |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.)`
|