@galacean/effects-specification 1.1.0-alpha.0 → 2.0.0-alpha.1

package/dist/src/type.d.ts

@@ -1,4 +1,4 @@
-import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, ShapeSplits, FixedNumberExpression } from './numberExpression';
+import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, ShapeSplits, FixedNumberExpression } from './number-expression';
 /**
  * 播放器版本
  */
@@ -539,7 +539,11 @@ export declare enum ItemType {
     /**
      * 天空盒元素
      */
-    skybox = "skybox"
+    skybox = "skybox",
+    /**
+     * 特效元素
+     */
+    effect = "effect"
 }
 /**
  * 渲染模式

package/dist/src/vfx-item-data.d.ts

@@ -0,0 +1,74 @@
+import type { ComponentData, EffectsObjectData } from './components';
+import type { ItemEndBehavior, ParentItemEndBehavior, BaseContent, TransformData } from './item/base-item';
+import type { ItemType, RenderLevel } from './type';
+export interface VFXItemData extends EffectsObjectData {
+    /**
+     * 元素 id
+     * 非预合成的元素 id 为 int 类型的数字字符串
+     * 预合成元素 id 为 `'{ref元素id}+{合成内id}'` 字符串
+     */
+    id: string;
+    /**
+     * 元素名称
+     */
+    name: string;
+    /**
+     * 元素时常，单位秒
+     */
+    duration: number;
+    /**
+     * 元素类型，string 类型
+     * Galacean Effects 内部元素使用 int 数字字符串
+     * plugin 模块实现者自由实现命名
+     * 2022.12更新: spine: "spine", 陀螺仪: "5"
+     */
+    type: ItemType | string;
+    /**
+     * 父节点ID
+     * 如果父节点无法找到，播放将直接报错
+     */
+    parentId?: string;
+    /**
+     * 元素可视状态
+     * 如果为 true 或者不存在时，元素可见
+     * 仅当为 false 时，元素不被创建
+     */
+    visible?: boolean;
+    /**
+     * 元素结束行为
+     * @default destroy
+     */
+    endBehavior: ItemEndBehavior | ParentItemEndBehavior;
+    /**
+     * 元素播放延时（单位秒）
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * 元素渲染信息属性
+     */
+    content: BaseContent;
+    /**
+     * 元素渲染等级
+     */
+    renderLevel?: RenderLevel;
+    /**
+     * 元素的插件模块名，如果不指定，则和 type 相同
+     * 从数组的 plugins 中获取 name
+     * 例如：pn:1, plugins:["model@1.0",'spine@1.0']
+     * pn 实际为 spine
+     */
+    pn?: number;
+    /**
+     * 元素的插件模块名, 优先级高于 pn
+     */
+    pluginName?: string;
+    /**
+     * 元素的基础位置
+     */
+    transform?: TransformData;
+    /**
+     * 元素的组件数据
+     */
+    components: ComponentData[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "1.1.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "description": "Galacean Effects JSON Specification",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -60,7 +60,8 @@
     "rollup": "^2.70.1",
     "rollup-plugin-livereload": "^2.0.5",
     "rollup-plugin-serve": "^1.1.0",
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.2",
+    "uuid": "9.0.1"
   },
   "author": "Ant Group CO., Ltd.",
   "license": "MIT",