three-editor-ai 0.0.1 → 0.0.2

package/declare/modules.d.ts

@@ -8,6 +8,7 @@ import type Stats from "three/examples/jsm/libs/stats.module.js";
 import type { GUI } from "lil-gui";
 import type { Vector3Like } from "./main";
 import type { EditorEventApi } from "./events";
+import type { ComponentMetadata } from "./component";
 
 /* ------------------------------------------------------------------ *
  * 场景
@@ -140,7 +141,7 @@ export interface EffectInstallArgs {
 
 /**
  * 自定义后期特效描述符。
- * `id` 与 `install` 必填；`id` 已存在时 `installEffect` 直接返回已有 Pass。
+ * `id`、`description` 与 `install` 必填；`id` 已存在时 `installEffect` 直接返回已有 Pass。
  */
 export interface EffectDescriptor {
   /** 必填，唯一标识，同时作为 `effectComposer.SHEET[id]` 的键 */
@@ -149,6 +150,21 @@ export interface EffectDescriptor {
   /** 面板显示名 */
   name?: string;
 
+  /** 必填，通道描述，说明用途、可配置内容及行为 */
+  description: string;
+
+  /**
+   * 安装前的默认值。提供 `meta.init` 时定义对应字段。
+   * `install` 读取此对象写入新建的 Pass；已安装的通道不随它变化。
+   */
+  initParams?: Record<string, unknown>;
+
+  /**
+   * 外层可配置项。`meta.init` 相对 `initParams`，`meta.props` 相对 `install` 返回的 Pass。
+   * 内核面板仍使用 `setPanel`。
+   */
+  meta?: ComponentMetadata;
+
   /** 必填，返回一个 Pass */
   install: (args: EffectInstallArgs) => Pass | null | undefined;