Sprite3D

Inherits: SpriteBase3D < GeometryInstance < VisualInstance < Spatial < Node < Object

2D sprite node in a 3D world.

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.

Signals

  • frame_changed ( )

Emitted when the frame changes.

Property Descriptions

Default0
Setterset_frame(value)
Getterget_frame()

Current frame to display from sprite sheet. vframes or hframes must be greater than 1.


DefaultVector2( 0, 0 )
Setterset_frame_coords(value)
Getterget_frame_coords()

Coordinates of the frame to display from sprite sheet. This is as an alias for the frame property. vframes or hframes must be greater than 1.


Default1
Setterset_hframes(value)
Getterget_hframes()

The number of columns in the sprite sheet.


Defaultfalse
Setterset_region(value)
Getteris_region()

If true, texture will be cut from a larger atlas texture. See region_rect.


DefaultRect2( 0, 0, 0, 0 )
Setterset_region_rect(value)
Getterget_region_rect()

The region of the atlas texture to display. region_enabled must be true.


Setterset_texture(value)
Getterget_texture()

Texture object to draw.


Default1
Setterset_vframes(value)
Getterget_vframes()

The number of rows in the sprite sheet.

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.