: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/Sprite3D.xml. .. _class_Sprite3D: Sprite3D ======== **Inherits:** :ref:`SpriteBase3D` **<** :ref:`GeometryInstance3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` 2D sprite node in a 3D world. .. rst-class:: classref-introduction-group Description ----------- A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation. See also :ref:`SpriteBase3D` where properties such as the billboard mode are defined. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`frame` | ``0`` | +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`Vector2i` | :ref:`frame_coords` | ``Vector2i(0, 0)`` | +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`hframes` | ``1`` | +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`region_enabled` | ``false`` | +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`Rect2` | :ref:`region_rect` | ``Rect2(0, 0, 0, 0)`` | +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`texture` | | +-----------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`vframes` | ``1`` | +-----------------------------------+---------------------------------------------------------------+-----------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_Sprite3D_signal_frame_changed: .. rst-class:: classref-signal **frame_changed**\ (\ ) :ref:`🔗` Emitted when the :ref:`frame` changes. .. rst-class:: classref-item-separator ---- .. _class_Sprite3D_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_Sprite3D_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_Sprite3D_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_Sprite3D_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_Sprite3D_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``, the sprite will use :ref:`region_rect` and display only the specified part of its texture. .. rst-class:: classref-item-separator ---- .. _class_Sprite3D_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_Sprite3D_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. If :ref:`GeometryInstance3D.material_override` is used, this will be overridden. The size information is still used. .. rst-class:: classref-item-separator ---- .. _class_Sprite3D_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``. .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`