覆盖层

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;
}

Overlay 对象包含以下属性：

路径

覆盖层的相对路径，这会使用 OverlayProvider 的 basePath 作为前缀组合成完整的覆盖层 URL。

名称

覆盖层的名称。

类别

覆盖层的类别，这可以帮助用户找到所需要的覆盖层。

描述

覆盖层的描述。

字段

一个可以配置的字段列表。

尺寸限制

这有助于限制覆盖层的尺寸，以防止被裁剪或过度拉伸。

预览背景颜色

覆盖层预览的背景色，在覆盖层浏览器中使用。