@eva/plugin-renderer-dragonbone 2.0.1-beta.9 → 2.0.2-beta.0

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

@@ -7,16 +7,71 @@ import { Renderer } from '@eva/plugin-renderer';
 import { RendererManager } from '@eva/plugin-renderer';
 import { RendererSystem } from '@eva/plugin-renderer';
 
+/**
+ * DragonBones 骨骼动画组件
+ *
+ * DragonBone 组件用于播放 DragonBones 骨骼动画。
+ * DragonBones 是一个开源的 2D 骨骼动画解决方案，
+ * 支持复杂的角色动画、换装、动画融合等高级功能，
+ * 适用于游戏角色、UI 动效等需要骨骼动画的场景。
+ *
+ * 主要功能：
+ * - 播放 DragonBones 骨骼动画
+ * - 支持多个骨架（Armature）
+ * - 支持动画切换和融合
+ * - 支持骨骼和插槽操作
+ * - 支持换装和皮肤切换
+ * - 提供动画事件监听
+ *
+ * @example
+ * ```typescript
+ * // 基础用法
+ * const character = new GameObject('character');
+ * character.addComponent(new DragonBone({
+ *   resource: 'heroAnimation', // DragonBones 资源
+ *   armatureName: 'Hero', // 骨架名称
+ *   animationName: 'idle', // 默认动画
+ *   autoPlay: true
+ * }));
+ *
+ * // 切换动画
+ * const dragonbone = character.getComponent('DragonBone');
+ * dragonbone.play('run'); // 播放跑步动画
+ * dragonbone.play('attack', 1); // 播放攻击动画 1 次
+ *
+ * // 停止动画
+ * dragonbone.stop();
+ * dragonbone.stop('walk'); // 停止指定动画
+ * ```
+ */
 export declare class DragonBone extends Component<DragonBoneParams> {
+    /** 组件名称 */
     static componentName: string;
+    /** DragonBones 骨架实例 */
     private _armature;
+    /** 等待播放标志 */
     private waitPlay;
+    /** 等待停止标志 */
     private waitStop;
+    /** 待播放的动画信息 */
     private waitPlayInfo;
+    /** DragonBones 资源名称 */
     resource: string;
+    /** 骨架名称 */
     armatureName: string;
+    /** 动画名称 */
     animationName: string;
+    /** 是否自动播放 */
     autoPlay: boolean;
+    /**
+     * 初始化组件
+     * @param obj - 初始化参数
+     * @param obj.resource - DragonBones 资源名称
+     * @param obj.armatureName - 骨架名称（必填）
+     * @param obj.animationName - 默认动画名称
+     * @param obj.autoPlay - 是否自动播放
+     * @throws 如果未提供 armatureName 则抛出错误
+     */
     init(obj?: DragonBoneParams): void;
     play(name?: string, times?: number): void;
     stop(name?: string): void;

package/dist/plugin-renderer-dragonbone.esm.js

@@ -3,19 +3,19 @@ import { Component, resource, RESOURCE_TYPE, OBSERVER_TYPE, decorators } from '@
 import { Texture, Rectangle, Sprite, Graphics, BLEND_MODES, mesh, ticker } from 'pixi.js';
 import { Renderer, RendererSystem } from '@eva/plugin-renderer';
 
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
 
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
 
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
 
 function __decorate(decorators, target, key, desc) {
@@ -26,27 +26,86 @@ function __decorate(decorators, target, key, desc) {
 }
 
 function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
-}
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
 
+/**
+ * DragonBones 骨骼动画组件
+ *
+ * DragonBone 组件用于播放 DragonBones 骨骼动画。
+ * DragonBones 是一个开源的 2D 骨骼动画解决方案，
+ * 支持复杂的角色动画、换装、动画融合等高级功能，
+ * 适用于游戏角色、UI 动效等需要骨骼动画的场景。
+ *
+ * 主要功能：
+ * - 播放 DragonBones 骨骼动画
+ * - 支持多个骨架（Armature）
+ * - 支持动画切换和融合
+ * - 支持骨骼和插槽操作
+ * - 支持换装和皮肤切换
+ * - 提供动画事件监听
+ *
+ * @example
+ * ```typescript
+ * // 基础用法
+ * const character = new GameObject('character');
+ * character.addComponent(new DragonBone({
+ *   resource: 'heroAnimation', // DragonBones 资源
+ *   armatureName: 'Hero', // 骨架名称
+ *   animationName: 'idle', // 默认动画
+ *   autoPlay: true
+ * }));
+ *
+ * // 切换动画
+ * const dragonbone = character.getComponent('DragonBone');
+ * dragonbone.play('run'); // 播放跑步动画
+ * dragonbone.play('attack', 1); // 播放攻击动画 1 次
+ *
+ * // 停止动画
+ * dragonbone.stop();
+ * dragonbone.stop('walk'); // 停止指定动画
+ * ```
+ */
 class DragonBone$3 extends Component {
     constructor() {
         super(...arguments);
+        /** 等待播放标志 */
         this.waitPlay = false;
+        /** 等待停止标志 */
         this.waitStop = false;
+        /** 待播放的动画信息 */
         this.waitPlayInfo = {
             animationName: null,
         };
+        /** DragonBones 资源名称 */
         this.resource = '';
+        /** 骨架名称 */
         this.armatureName = '';
+        /** 动画名称 */
         this.animationName = '';
+        /** 是否自动播放 */
         this.autoPlay = true;
     }
+    /**
+     * 初始化组件
+     * @param obj - 初始化参数
+     * @param obj.resource - DragonBones 资源名称
+     * @param obj.armatureName - 骨架名称（必填）
+     * @param obj.animationName - 默认动画名称
+     * @param obj.autoPlay - 是否自动播放
+     * @throws 如果未提供 armatureName 则抛出错误
+     */
     init(obj) {
         if (!obj)
             return;
@@ -96,6 +155,7 @@ class DragonBone$3 extends Component {
         this.removeAllListeners();
     }
 }
+/** 组件名称 */
 DragonBone$3.componentName = 'DragonBone';
 __decorate([
     type('string')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eva/plugin-renderer-dragonbone",
-  "version": "2.0.1-beta.9",
+  "version": "2.0.2-beta.0",
   "description": "@eva/plugin-renderer-dragonbone",
   "main": "index.js",
   "module": "dist/plugin-renderer-dragonbone.esm.js",
@@ -19,8 +19,8 @@
   "homepage": "https://eva.js.org",
   "dependencies": {
     "@eva/inspector-decorator": "^0.0.5",
-    "@eva/plugin-renderer": "2.0.1-beta.9",
-    "@eva/eva.js": "2.0.1-beta.9",
-    "pixi.js": "^8.8.1"
+    "@eva/plugin-renderer": "2.0.2-beta.0",
+    "@eva/eva.js": "2.0.2-beta.0",
+    "pixi.js": "^8.17.0"
   }
 }