Extension 基类

import { Extension, extension } from "@avg-studio/sdk";

@extension({ id: "my-panel", label: "我的面板" })
export class MyPanel extends Extension {
  render() {
    return {
      component: () => <div>这是一个自定义面板</div>,
      props: {},
    };
  }
}

@extension({ id: "save-screen", label: "存档画面" })
export class SaveScreen extends Extension {
  static onRegister(ctx: ExtensionContext) {
    ctx.input.registerAction({
      id: "save-screen.quick-save",
      label: "快速存档",
      defaultKeys: ["F5"],
    });
    ctx.input.onAction("save-screen.quick-save", () => {
      ctx.archive.quickSave();
    });
  }
}

export class SaveScreen extends Extension {
  onInit() {
    // 进 DOM 前先截一张游戏画面，供存档缩略图复用
    this.context.archive.cacheGameSnapshot();
  }

  onClose() {
    this.context.archive.clearGameSnapshot();
  }

  render() { ... }
}

render() {
  return {
    component: MyPanelComponent,   // React FC
    props: { data: this.data },    // 传给该组件的 props
  };
}

import { useExtensionContext } from "@avg-studio/sdk";

function MyPanelComponent() {
  const ctx = useExtensionContext();
  const [bgmVolume] = ctx.config.useValue("bgmVolume");
  return <div>当前 BGM 音量：{bgmVolume}</div>;
}

import type { SaveAPI } from "@avg-studio/sdk";

type MySaveMap = {
  items: readonly string[];
  gold: number;
};

@extension({ id: "inventory", label: "背包" })
export class Inventory extends Extension {
  static saveSchema = defineSave({
    items: { type: "list", persistence: "slot", default: [] as string[] },
    gold: { type: "number", persistence: "slot", default: 0 },
  });

  static addItem = method({
    title: "增加物品",
    schema: { itemId: { type: "string", label: "物品 ID", required: true } },
    run(_ctx, params) {
      // 显式收窄 this.save 类型，避免 method() 里类型丢失
      const save = this.save as unknown as SaveAPI<MySaveMap>;
      save.set("items", [...save.get("items"), params.itemId]);
    },
  });
}

@extension({ id: "toolbar", label: "工具栏", autonomous: true })
export class Toolbar extends Extension {
  static onRegister(ctx) {
    // 对话出现时显示工具栏，对话消失时隐藏
    ctx.subscribe("dialogue:changed", () => {
      if (ctx.dialogue.line()) {
        ctx.ui.show("toolbar");
      } else {
        ctx.ui.hide("toolbar");
      }
    });
  }

  render() {
    return { component: ToolbarComponent, props: {} };
  }
}

import { Extension, extension, INTERNAL_SYSTEM_SLOT } from "@avg-studio/sdk";

@extension({
  id: "title-screen",
  label: "标题画面",
  supportsSlot: INTERNAL_SYSTEM_SLOT.Title,
})
export class MyTitleScreen extends Extension {
  render() {
    return { component: TitleScreenComponent, props: {} };
  }
}

import {
  Extension, extension, defineSave, method, settings,
  type SettingsBuilder, type SaveAPI,
} from "@avg-studio/sdk";

type GallerySaveMap = {
  unlockedShared: readonly GalleryEntry[];
  unlockedSlot: readonly GalleryEntry[];
};

@extension({ id: "gallery-screen", label: "鉴赏画面" })
export class GalleryScreen extends Extension {
  // 两种存档作用域：shared 跨存档全局解锁，slot 跟随当前存档
  static saveSchema = defineSave({
    unlockedShared: { type: "list", persistence: "shared", default: [] as GalleryEntry[] },
    unlockedSlot:   { type: "list", persistence: "slot",   default: [] as GalleryEntry[] },
  });

  // 设置：新解锁条目写入哪个桶
  static settings = settings((s: SettingsBuilder) => ({
    unlockScope: s
      .enum("解锁记录范围", ["shared", "slot"] as const)
      .labels({ shared: "全局共享", slot: "跟随存档" })
      .default("shared"),
  }));

  // 剧本方法：加入鉴赏
  static addToGallery = method({
    title: "加入鉴赏",
    schema: { scene: { type: "scene", label: "场景", required: true } },
    run(ctx, params) {
      const save = this.save as unknown as SaveAPI<GallerySaveMap>;
      const scope = ctx.settings.get<"shared" | "slot">("unlockScope") ?? "shared";
      const entry: GalleryEntry = buildEntry(params);
      if (scope === "slot") {
        save.set("unlockedSlot", [...save.get("unlockedSlot"), entry]);
      } else {
        save.set("unlockedShared", [...save.get("unlockedShared"), entry]);
      }
    },
  });

  // 剧本方法：移除/清空 ……（同款写法，略）

  // 界面
  render() {
    return { component: GalleryScreenComponent, props: {} };
  }
}