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

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

@@ -4,11 +4,70 @@ import { SpineParams } from '@eva/spine-base';
 import { SpineSystem as SpineSystem_2 } from '@eva/spine-base';
 export { PixiSpine }
 
+/**
+ * Spine 骨骼动画组件（pixi-spine 4.2 版本）
+ *
+ * 此组件继承自 `@eva/spine-base` 的 Spine 基类，使用 pixi-spine 4.2 版本。
+ * 适用于需要使用 Spine 4.2 格式骨骼动画的场景。
+ *
+ * 详细的 API 文档和使用示例请参考 `@eva/spine-base` 中的 Spine 类。
+ *
+ * @see {@link @eva/spine-base.Spine} 基类文档
+ * @see {@link SpineSystem} 配套系统
+ *
+ * @example
+ * ```typescript
+ * import { Spine } from '@eva/plugin-renderer-spine';
+ *
+ * const character = new GameObject('character');
+ * const spine = new Spine({
+ *   resource: 'heroSpine',
+ *   animationName: 'idle',
+ *   autoPlay: true,
+ * });
+ * character.addComponent(spine);
+ * ```
+ */
 export declare class Spine extends Spine_2 {
 }
 export { SpineParams }
 
+/**
+ * Spine 骨骼动画渲染系统（pixi-spine 4.2 版本）
+ *
+ * 此系统继承自 `@eva/spine-base` 的 SpineSystem 基类，使用 pixi-spine 4.2 版本。
+ * 负责管理所有 Spine 组件的骨架创建、动画更新和资源管理。
+ *
+ * 适用于需要使用 Spine 4.2 格式骨骼动画的场景。
+ *
+ * 详细的 API 文档请参考 `@eva/spine-base` 中的 SpineSystem 类。
+ *
+ * @see {@link @eva/spine-base.SpineSystem} 基类文档
+ * @see {@link Spine} 配套组件
+ *
+ * @example
+ * ```typescript
+ * import { Game } from '@eva/eva.js';
+ * import { RendererSystem } from '@eva/plugin-renderer';
+ * import { SpineSystem } from '@eva/plugin-renderer-spine';
+ *
+ * const game = new Game({
+ *   systems: [
+ *     new RendererSystem({
+ *       canvas: document.getElementById('canvas'),
+ *       width: 750,
+ *       height: 1000,
+ *     }),
+ *     new SpineSystem(),
+ *   ],
+ * });
+ * ```
+ */
 export declare class SpineSystem extends SpineSystem_2 {
+    /**
+     * 初始化系统，注入 pixi-spine 4.2 版本
+     * @override
+     */
     init(): void;
 }