@eva/plugin-renderer-lottie 2.0.1-beta.3 → 2.0.1-beta.30

package/dist/plugin-renderer-lottie.d.ts

@@ -22,31 +22,104 @@ declare interface IExpandOpts {
             [key: string]: any;
         };
     }>;
+    direction?: 1 | -1;
 }
 
 declare interface IOptions {
     resource: string;
     width?: number;
     height?: number;
+    replaceData?: boolean;
 }
 
+/**
+ * Lottie 动画组件
+ *
+ * Lottie 组件用于播放 Adobe After Effects 导出的 Lottie 动画文件。
+ * Lottie 是一种基于 JSON 的动画格式，可以实现复杂的矢量动画效果，
+ * 文件体积小、性能高，适用于图标动画、loading 动画、复杂 UI 动效等场景。
+ *
+ * 主要功能：
+ * - 播放 Lottie JSON 动画
+ * - 支持动画片段播放和循环
+ * - 支持插槽（slot）动态替换内容
+ * - 支持帧事件监听
+ * - 支持交互热区绑定
+ * - 支持动态替换动画数据
+ *
+ * @example
+ * ```typescript
+ * // 基础用法
+ * const animation = new GameObject('animation');
+ * animation.addComponent(new Lottie({
+ *   resource: 'loadingAnimation', // Lottie JSON 资源
+ *   autoStart: true
+ * }));
+ *
+ * // 播放指定片段
+ * const lottie = animation.getComponent('Lottie');
+ * lottie.play([0, 60], { repeats: -1 }); // 播放 0-60 帧，无限循环
+ *
+ * // 动态替换插槽内容
+ * lottie.play([0, 120], {
+ *   slot: [{
+ *     name: 'avatar',
+ *     type: 'IMAGE',
+ *     value: 'user-avatar.png',
+ *     style: { width: 100, height: 100 }
+ *   }, {
+ *     name: 'username',
+ *     type: 'TEXT',
+ *     value: '玩家名称',
+ *     style: { fontSize: 24 }
+ *   }]
+ * });
+ *
+ * // 监听特定帧事件
+ * lottie.on('@30', () => {
+ *   console.log('到达第 30 帧');
+ * });
+ *
+ * // 绑定点击热区
+ * lottie.onTap('buttonLayer', () => {
+ *   console.log('按钮被点击');
+ * });
+ * ```
+ */
 export declare class Lottie extends Component {
+    /** 插槽配置 */
     slot: {
         [key: string]: string;
     };
+    /** 待替换的数据 */
+    _replaceData: Record<string, string> | null;
+    /** 组件名称 */
     static componentName: string;
+    /** Lottie 动画实例 */
     anim: any;
+    /** Lottie 配置选项 */
     options: ExtendOptions;
+    /** 资源加载状态 */
     loadStatus: boolean;
+    /** 首次播放回调 */
     firstPlay: () => void | null;
+    /** 前一次的插槽内容 */
     prevSlot: {
         [name: string]: any;
     };
+    /** 当前的插槽内容 */
     currentSlot: {
         [name: string]: any;
     };
+    /**
+     * 构造 Lottie 组件
+     * @param options - Lottie 配置选项
+     * @param options.resource - Lottie JSON 资源名称
+     * @param options.autoStart - 是否自动开始播放
+     */
     constructor(options: IOptions);
     play(params?: number[], expandOpts?: IExpandOpts): void;
+    replaceData(data: Record<string, string>): void;
     playParamsHandle(params: any): any[];
     onTap(name: any, callback: any): void;
 }
@@ -59,9 +132,16 @@ export declare class LottieSystem extends Renderer {
     rendererManager: RendererManager;
     containerManager: ContainerManager;
     managerLife: string[];
+    /**
+     * System 初始化用，可以配置参数，游戏未开始
+     *
+     * System init, set params, game is not begain
+     * @param param init params
+     */
     init(): void;
     componentChanged(changed: ComponentChanged): Promise<void>;
     add(changed: ComponentChanged): Promise<void>;
+    getDir(url: string): string;
     remove(changed: ComponentChanged): void;
 }