Overlay

TypeScript

type Overlay = {
  path: string
  name: string
  category: string
  description?: string
  fields: OverlayField<K>[]
  minWidth?: number
  maxWidth?: number
  minHeight?: number
  maxHeight?: number
  previewBackgroundColor?: string
}

C#

struct Overlay
{
    public string Path;
    public string Name;
    public string Category;
    public string? Description;
    public OverlayField[] Fields;
    public int? MinWidth;
    public int? MaxWidth;
    public int? MinHeight;
    public int? MaxHeight;
    public string? PreviewBackgroundColor;
}

The Overlay object contains the following properties:

Path

The relative path of the overlay. This is prefixed with the basePath of the OverlayProvider to form the full URL of the overlay.

Name

The name of the overlay.

Category

The category of the overlay. This could help users to find the overlay they are looking for.

Description

The description of the overlay.

Fields

A list of settings fields that can be configured for this overlay.

Dimensions limits

This helps prevent the overlay from being cropped or overly stretched.

Preview background color

The background color of the overlay preview. This is used in the overlay explorer.