Sprite2D

public bool Centered { get; set; }

If true, texture is centered. Note: For games with a pixel art aesthetic, textures may appear deformed when centered. This is caused by their position being between pixels. To prevent this, set this property to false, or consider enabling ProjectSettings.rendering/2d/snap/snap_2d_vertices_to_pixel and ProjectSettings.rendering/2d/snap/snap_2d_transforms_to_pixel.

public bool FlipH { get; set; }

If true, texture is flipped horizontally.

public bool FlipV { get; set; }

If true, texture is flipped vertically.

public int Frame { get; set; }

Current frame to display from sprite sheet. Sprite2D.Hframes or Sprite2D.Vframes must be greater than 1. This property is automatically adjusted when Sprite2D.Hframes or Sprite2D.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.

public Vector2I FrameCoords { get; set; }

Coordinates of the frame to display from sprite sheet. This is as an alias for the Sprite2D.Frame property. Sprite2D.Hframes or Sprite2D.Vframes must be greater than 1.

public int Hframes { get; set; }

The number of columns in the sprite sheet. When this property is changed, Sprite2D.Frame is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, Sprite2D.Frame is reset to 0.

public Vector2 Offset { get; set; }

The texture's drawing offset. Note: When you increase Sprite2D.Offset.y in Sprite2D, the sprite moves downward on screen (i.e., +Y is down).

public bool RegionEnabled { get; set; }

Enables sampling RegionRect instead of the full texture. RegionRect uses source texture pixels. In the tested shader path, UV already includes the region; do not apply its offset again.

public bool RegionFilterClipEnabled { get; set; }

If true, the area outside of the Sprite2D.RegionRect is clipped to avoid bleeding of the surrounding texture pixels. Sprite2D.RegionEnabled must be true.

public Rect2 RegionRect { get; set; }

Source rectangle in Texture pixels, used when RegionEnabled is true. It is neither the normalized shader REGION_RECT nor the scaled sprite size. Hframes/Vframes further divide the selected rectangle into frames.

public Texture2D Texture { get; set; }

Texture2D object to draw.

public int Vframes { get; set; }

The number of rows in the sprite sheet. When this property is changed, Sprite2D.Frame is adjusted so that the same visual frame is maintained (same row and column). If that's impossible, Sprite2D.Frame is reset to 0.

public Rect2 GetRect();

Returns a Rect2 representing the Sprite2D's boundary in local coordinates. Example: Detect if the Sprite2D was clicked:

public override void _Input(InputEvent @event)
{
    if (@event is InputEventMouseButton inputEventMouse)
    {
        if (inputEventMouse.Pressed && inputEventMouse.ButtonIndex == MouseButton.Left)
        {
            if (GetRect().HasPoint(ToLocal(inputEventMouse.Position)))
            {
                ReckfellApi.Print("A click!");
            }
        }
    }
}

public Rect2 GetRegionRect();

Source rectangle in Texture pixels, used when RegionEnabled is true. It is neither the normalized shader REGION_RECT nor the scaled sprite size. Hframes/Vframes further divide the selected rectangle into frames.

public bool IsPixelOpaque(Vector2 pos);

Returns true if the pixel at the given position is opaque, false otherwise. Also returns false if the given position is out of bounds or this sprite's Sprite2D.Texture is null. pos is in local coordinates.

public bool IsRegionEnabled();

Enables sampling RegionRect instead of the full texture. RegionRect uses source texture pixels. In the tested shader path, UV already includes the region; do not apply its offset again.

public void SetRegionEnabled(bool enabled);

Enables sampling RegionRect instead of the full texture. RegionRect uses source texture pixels. In the tested shader path, UV already includes the region; do not apply its offset again.

public void SetRegionRect(Rect2 rect);

Source rectangle in Texture pixels, used when RegionEnabled is true. It is neither the normalized shader REGION_RECT nor the scaled sprite size. Hframes/Vframes further divide the selected rectangle into frames.

public event Action FrameChanged;

Emitted when the Sprite2D.Frame changes.

public event Action TextureChanged;

Emitted when the Sprite2D.Texture changes.