@eva/plugin-renderer-sprite-animation 2.0.1-beta.27 → 2.0.1-beta.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -39,19 +39,74 @@ function __awaiter(thisArg, _arguments, P, generator) {
39
39
  });
40
40
  }
41
41
 
42
+ /**
43
+ * 精灵动画组件
44
+ *
45
+ * SpriteAnimation 组件用于播放帧动画(序列帧动画)。
46
+ * 通过快速切换精灵图集中的不同帧,实现动画效果,
47
+ * 适用于角色动作、特效、UI 动画等场景。
48
+ *
49
+ * 主要功能:
50
+ * - 支持自动播放和手动控制
51
+ * - 可配置播放速度和循环次数
52
+ * - 支持跳转到指定帧
53
+ * - 提供播放完成事件
54
+ * - 支持 forwards 模式(停在最后一帧)
55
+ *
56
+ * @example
57
+ * ```typescript
58
+ * // 基础用法 - 自动播放
59
+ * const character = new GameObject('character');
60
+ * character.addComponent(new SpriteAnimation({
61
+ * resource: 'walkAnimation', // 帧动画资源
62
+ * autoPlay: true,
63
+ * speed: 100 // 播放速度(毫秒/帧)
64
+ * }));
65
+ *
66
+ * // 控制播放
67
+ * const anim = character.getComponent('SpriteAnimation');
68
+ * anim.play(3); // 播放 3 次
69
+ * anim.play(Infinity); // 无限循环
70
+ * anim.stop(); // 停止播放
71
+ * anim.gotoAndPlay(10); // 跳到第 10 帧并播放
72
+ * anim.gotoAndStop(0); // 跳到第 0 帧并停止
73
+ *
74
+ * // 监听播放完成
75
+ * anim.on('complete', () => {
76
+ * console.log('动画播放完成');
77
+ * });
78
+ * ```
79
+ */
42
80
  class SpriteAnimation$2 extends eva_js.Component {
43
81
  constructor() {
44
82
  super(...arguments);
83
+ /** 帧动画资源名称 */
45
84
  this.resource = '';
85
+ /** 是否自动播放 */
46
86
  this.autoPlay = true;
87
+ /** 播放速度(毫秒/帧) */
47
88
  this.speed = 100;
89
+ /** 是否在最后一帧停止(forwards 模式) */
48
90
  this.forwards = false;
91
+ /** 等待播放标志(资源加载前调用 play) */
49
92
  this.waitPlay = false;
93
+ /** 等待停止标志 */
50
94
  this.waitStop = false;
95
+ /** 播放次数 */
51
96
  this.times = Infinity;
97
+ /** 当前已播放次数 */
52
98
  this.count = 0;
99
+ /** 是否播放完成 */
53
100
  this.complete = false;
54
101
  }
102
+ /**
103
+ * 初始化组件
104
+ * @param obj - 初始化参数
105
+ * @param obj.resource - 帧动画资源名称
106
+ * @param obj.autoPlay - 是否自动播放
107
+ * @param obj.speed - 播放速度
108
+ * @param obj.forwards - 是否停在最后一帧
109
+ */
55
110
  init(obj) {
56
111
  obj && Object.assign(this, obj);
57
112
  this.on('loop', () => {
@@ -121,6 +176,7 @@ class SpriteAnimation$2 extends eva_js.Component {
121
176
  return (_b = (_a = this.animate) === null || _a === void 0 ? void 0 : _a.animatedSprite) === null || _b === void 0 ? void 0 : _b.totalFrames;
122
177
  }
123
178
  }
179
+ /** 组件名称 */
124
180
  SpriteAnimation$2.componentName = 'SpriteAnimation';
125
181
  __decorate([
126
182
  inspectorDecorator.type('string')
@@ -7,18 +7,75 @@ import { RendererManager } from '@eva/plugin-renderer';
7
7
  import { RendererSystem } from '@eva/plugin-renderer';
8
8
  import { SpriteAnimation as SpriteAnimation_2 } from '@eva/renderer-adapter';
9
9
 
10
+ /**
11
+ * 精灵动画组件
12
+ *
13
+ * SpriteAnimation 组件用于播放帧动画(序列帧动画)。
14
+ * 通过快速切换精灵图集中的不同帧,实现动画效果,
15
+ * 适用于角色动作、特效、UI 动画等场景。
16
+ *
17
+ * 主要功能:
18
+ * - 支持自动播放和手动控制
19
+ * - 可配置播放速度和循环次数
20
+ * - 支持跳转到指定帧
21
+ * - 提供播放完成事件
22
+ * - 支持 forwards 模式(停在最后一帧)
23
+ *
24
+ * @example
25
+ * ```typescript
26
+ * // 基础用法 - 自动播放
27
+ * const character = new GameObject('character');
28
+ * character.addComponent(new SpriteAnimation({
29
+ * resource: 'walkAnimation', // 帧动画资源
30
+ * autoPlay: true,
31
+ * speed: 100 // 播放速度(毫秒/帧)
32
+ * }));
33
+ *
34
+ * // 控制播放
35
+ * const anim = character.getComponent('SpriteAnimation');
36
+ * anim.play(3); // 播放 3 次
37
+ * anim.play(Infinity); // 无限循环
38
+ * anim.stop(); // 停止播放
39
+ * anim.gotoAndPlay(10); // 跳到第 10 帧并播放
40
+ * anim.gotoAndStop(0); // 跳到第 0 帧并停止
41
+ *
42
+ * // 监听播放完成
43
+ * anim.on('complete', () => {
44
+ * console.log('动画播放完成');
45
+ * });
46
+ * ```
47
+ */
10
48
  export declare class SpriteAnimation extends Component<SpriteAnimationParams> {
49
+ /** 组件名称 */
11
50
  static componentName: string;
51
+ /** 帧动画资源名称 */
12
52
  resource: string;
53
+ /** 是否自动播放 */
13
54
  autoPlay: boolean;
55
+ /** 播放速度(毫秒/帧) */
14
56
  speed: number;
57
+ /** 是否在最后一帧停止(forwards 模式) */
15
58
  forwards: boolean;
59
+ /** 动画引擎实例 */
16
60
  _animate: SpriteAnimation_2;
61
+ /** 等待播放标志(资源加载前调用 play) */
17
62
  private waitPlay;
63
+ /** 等待停止标志 */
18
64
  private waitStop;
65
+ /** 播放次数 */
19
66
  private times;
67
+ /** 当前已播放次数 */
20
68
  private count;
69
+ /** 是否播放完成 */
21
70
  private complete;
71
+ /**
72
+ * 初始化组件
73
+ * @param obj - 初始化参数
74
+ * @param obj.resource - 帧动画资源名称
75
+ * @param obj.autoPlay - 是否自动播放
76
+ * @param obj.speed - 播放速度
77
+ * @param obj.forwards - 是否停在最后一帧
78
+ */
22
79
  init(obj?: SpriteAnimationParams): void;
23
80
  play(times?: number): void;
24
81
  stop(): void;
@@ -34,6 +91,7 @@ export declare interface SpriteAnimationParams {
34
91
  resource: string;
35
92
  autoPlay?: boolean;
36
93
  speed?: number;
94
+ /** Stop at last frame */
37
95
  forwards?: boolean;
38
96
  }
39
97
 
@@ -35,19 +35,74 @@ function __awaiter(thisArg, _arguments, P, generator) {
35
35
  });
36
36
  }
37
37
 
38
+ /**
39
+ * 精灵动画组件
40
+ *
41
+ * SpriteAnimation 组件用于播放帧动画(序列帧动画)。
42
+ * 通过快速切换精灵图集中的不同帧,实现动画效果,
43
+ * 适用于角色动作、特效、UI 动画等场景。
44
+ *
45
+ * 主要功能:
46
+ * - 支持自动播放和手动控制
47
+ * - 可配置播放速度和循环次数
48
+ * - 支持跳转到指定帧
49
+ * - 提供播放完成事件
50
+ * - 支持 forwards 模式(停在最后一帧)
51
+ *
52
+ * @example
53
+ * ```typescript
54
+ * // 基础用法 - 自动播放
55
+ * const character = new GameObject('character');
56
+ * character.addComponent(new SpriteAnimation({
57
+ * resource: 'walkAnimation', // 帧动画资源
58
+ * autoPlay: true,
59
+ * speed: 100 // 播放速度(毫秒/帧)
60
+ * }));
61
+ *
62
+ * // 控制播放
63
+ * const anim = character.getComponent('SpriteAnimation');
64
+ * anim.play(3); // 播放 3 次
65
+ * anim.play(Infinity); // 无限循环
66
+ * anim.stop(); // 停止播放
67
+ * anim.gotoAndPlay(10); // 跳到第 10 帧并播放
68
+ * anim.gotoAndStop(0); // 跳到第 0 帧并停止
69
+ *
70
+ * // 监听播放完成
71
+ * anim.on('complete', () => {
72
+ * console.log('动画播放完成');
73
+ * });
74
+ * ```
75
+ */
38
76
  class SpriteAnimation$2 extends Component {
39
77
  constructor() {
40
78
  super(...arguments);
79
+ /** 帧动画资源名称 */
41
80
  this.resource = '';
81
+ /** 是否自动播放 */
42
82
  this.autoPlay = true;
83
+ /** 播放速度(毫秒/帧) */
43
84
  this.speed = 100;
85
+ /** 是否在最后一帧停止(forwards 模式) */
44
86
  this.forwards = false;
87
+ /** 等待播放标志(资源加载前调用 play) */
45
88
  this.waitPlay = false;
89
+ /** 等待停止标志 */
46
90
  this.waitStop = false;
91
+ /** 播放次数 */
47
92
  this.times = Infinity;
93
+ /** 当前已播放次数 */
48
94
  this.count = 0;
95
+ /** 是否播放完成 */
49
96
  this.complete = false;
50
97
  }
98
+ /**
99
+ * 初始化组件
100
+ * @param obj - 初始化参数
101
+ * @param obj.resource - 帧动画资源名称
102
+ * @param obj.autoPlay - 是否自动播放
103
+ * @param obj.speed - 播放速度
104
+ * @param obj.forwards - 是否停在最后一帧
105
+ */
51
106
  init(obj) {
52
107
  obj && Object.assign(this, obj);
53
108
  this.on('loop', () => {
@@ -117,6 +172,7 @@ class SpriteAnimation$2 extends Component {
117
172
  return (_b = (_a = this.animate) === null || _a === void 0 ? void 0 : _a.animatedSprite) === null || _b === void 0 ? void 0 : _b.totalFrames;
118
173
  }
119
174
  }
175
+ /** 组件名称 */
120
176
  SpriteAnimation$2.componentName = 'SpriteAnimation';
121
177
  __decorate([
122
178
  type('string')
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eva/plugin-renderer-sprite-animation",
3
- "version": "2.0.1-beta.27",
3
+ "version": "2.0.1-beta.29",
4
4
  "description": "@eva/plugin-renderer-sprite-animation",
5
5
  "main": "index.js",
6
6
  "module": "dist/plugin-renderer-sprite-animation.esm.js",
@@ -19,9 +19,9 @@
19
19
  "homepage": "https://eva.js.org",
20
20
  "dependencies": {
21
21
  "@eva/inspector-decorator": "^0.0.5",
22
- "@eva/plugin-renderer": "2.0.1-beta.27",
23
- "@eva/renderer-adapter": "2.0.1-beta.27",
24
- "@eva/eva.js": "2.0.1-beta.27",
22
+ "@eva/plugin-renderer": "2.0.1-beta.29",
23
+ "@eva/renderer-adapter": "2.0.1-beta.29",
24
+ "@eva/eva.js": "2.0.1-beta.29",
25
25
  "pixi.js": "^8.8.1"
26
26
  }
27
27
  }