2D Sprite node in 3D world.
    public class Sprite3D : SpriteBase3D

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.

Inheritance Chain


    public Sprite3D()


    "frame_changed" ()

Emitted when the Frame changes.


    public int Frame { get; set; }

Current frame to display from sprite sheet. Vframes or Hframes must be greater than 1.

    public int Hframes { get; set; }

The number of columns in the sprite sheet.

    public bool RegionEnabled { get; set; }

If true texture will be cut from a larger atlas texture. See RegionRect. Default value: false.

    public Rect2 RegionRect { get; set; }

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

    public Texture Texture { get; set; }

Texture object to draw.

    public int Vframes { get; set; }

The number of rows in the sprite sheet.


    public int GetFrame()

Getter for Frame

    public int GetHframes()

Getter for Hframes

    public Rect2 GetRegionRect()

Getter for RegionRect

    public Texture GetTexture()

Getter for Texture

    public int GetVframes()

Getter for Vframes

    public bool IsRegion()

Getter for RegionEnabled

    public void SetFrame(int frame)

Setter for Frame

    public void SetHframes(int hframes)

Setter for Hframes

    public void SetRegion(bool enabled)

Setter for RegionEnabled

    public void SetRegionRect(Rect2 rect)

Setter for RegionRect

    public void SetTexture(Texture texture)

Setter for Texture

    public void SetVframes(int vframes)

Setter for Vframes