Class Tween

constructor

• new Tween(): Tween

  Returns Tween

Optionallabel

destroyed

• get destroyed(): boolean

  动画是否已被销毁

  销毁后的动画实例不能再次使用，需要创建新实例。

  Returns boolean

isPlaying

• get isPlaying(): boolean

  动画是否正在播放中

  包括正在执行和暂停状态的动画。

  Returns boolean

paused

• get paused(): boolean

  动画是否已暂停

  暂停状态下动画不会更新，但保持播放状态。

  Returns boolean

call

• call(callback: () => void): this

  添加回调函数到动画队列

  在动画序列中的特定时机执行回调函数。 常用于在动画过程中触发游戏逻辑或状态改变。

  Parameters

  • callback: () => void

    要执行的回调函数

  Returns this

  当前 Tween 实例，支持链式调用

destroy

• destroy(): void

  销毁动画实例

  清理所有资源并从全局管理列表中移除。 销毁后的实例不能再次使用，需要创建新实例。 会自动停止正在播放的动画。

  Returns void

from

• from(options: TweenOption): this

  添加从指定状态到当前状态的动画到队列

  在动画队列末尾添加一个新的 from 动画。 支持链式调用以创建复杂的动画序列。

  Parameters

  • options: TweenOption

    动画配置选项

  Returns this

  当前 Tween 实例，支持链式调用

onAllComplete

• onAllComplete(callback: () => void): this

  设置所有动画完成时的回调

  当动画队列中的所有动画效果都执行完毕后调用指定的回调函数。 在 play() 返回的 Promise 解析之前触发。

  Parameters

  • callback: () => void

    完成回调函数

  Returns this

  当前 Tween 实例，支持链式调用

pause

• pause(): this

  暂停动画播放

  暂停当前正在播放的动画，保持所有状态。 可以通过 resume() 方法恢复播放。 对未播放或已销毁的动画无效果。

  Returns this

  当前 Tween 实例，支持链式调用

play

• play(): Promise<void>

  开始播放动画队列

  按顺序执行队列中的所有动画效果。 如果动画已在播放或已被销毁，会直接返回已解析的 Promise。 动画完成后会自动销毁实例。

  Returns Promise<void>

  Promise，当所有动画完成时解析

resume

• resume(): this

  恢复动画播放

  恢复之前暂停的动画继续播放。 对未暂停或已销毁的动画无效果。

  Returns this

  当前 Tween 实例，支持链式调用

set

• set(target: EffectTarget, props: Record<string, any>): this

  立即设置对象属性值

  直接修改目标对象的属性，不产生动画过渡效果。 常用于在动画序列中立即更改对象状态。

  Parameters

  • target: EffectTarget

    目标对象
  • props: Record<string, any>

    要设置的属性键值对

  Returns this

  当前 Tween 实例，支持链式调用

stop

• stop(): this

  停止动画播放

  停止当前动画播放，但不销毁实例。 可以通过 play() 方法重新开始播放整个动画队列。 停止时会重置暂停状态。

  Returns this

  当前 Tween 实例，支持链式调用

to

• to(options: TweenOption): this

  添加从当前状态到目标状态的动画到队列

  在动画队列末尾添加一个新的 to 动画。 支持链式调用以创建复杂的动画序列。

  Parameters

  • options: TweenOption

    动画配置选项

  Returns this

  当前 Tween 实例，支持链式调用

wait

• wait(seconds: number): this

  添加等待时间到动画队列

  在动画序列中插入指定时长的等待时间。 常用于在连续动画之间创建停顿效果。

  Parameters

  • seconds: number

    等待时长（秒）

  Returns this

  当前 Tween 实例，支持链式调用

Staticclear

• clear(label: string): void

  停止指定标签的动画

  查找并销毁具有指定标签的第一个动画实例。 用于精确控制特定动画的生命周期。

  Parameters

  • label: string

    要停止的动画标签

  Returns void

StaticclearAll

• clearAll(): void

  停止所有动画

  销毁所有存在的 Tween 实例并清空全局动画列表。 常用于场景切换或游戏重置时的资源清理。

  Returns void

Staticfrom

• from(options: TweenOption): Tween

  创建从指定状态到当前状态的动画

  先将对象属性设置为指定值，然后动画过渡回原来的状态。 常用于对象淡入效果（从透明到可见）或位置复位动画。 如果指定了 label，会自动停止具有相同 label 的现有动画。

  Parameters

  • options: TweenOption

    动画配置选项

  Returns Tween

  新创建的 Tween 实例，可用于链式调用

Staticto

• to(options: TweenOption): Tween

  创建从当前状态到目标状态的动画

  这是最常用的动画方法，从对象当前属性值平滑过渡到指定的目标值。 如果指定了 label，会自动停止具有相同 label 的现有动画。

  Parameters

  • options: TweenOption

    动画配置选项

  Returns Tween

  新创建的 Tween 实例，可用于链式调用