Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Tween

缓动动画

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Tween(target?: Node, prop?: string, from?: number, to?: number, duration?: number): Tween
  • new Tween(target?: Node, prop?: string, from?: number, to?: number, ease?: number | ((time: number) => number)): Tween

  • 缓动动画

    Parameters

    • Optional target: Node

      目标节点

    • Optional prop: string

      属性key

    • Optional from: number

      开始值

    • Optional to: number

      结束值

    • Optional duration: number

      动画持续时长，默认为1000毫秒

    Returns Tween

  • 缓动动画

    Parameters

    • Optional target: Node

      目标节点

    • Optional prop: string

      属性key

    • Optional from: number

      开始值

    • Optional to: number

      结束值

    • Optional ease: number | ((time: number) => number)

      缓动函数

    Returns Tween

Properties

awaked

awaked: boolean = false

脚本或动画是否激活

currentTime

currentTime: number = 0

当前播放到的时间，单位为毫秒，如果loop=true，则此时间可能会被重置

delay

delay: number = 0

脚本或动画延迟激活的时间，单位为毫秒

destroyed

destroyed: boolean = false

脚本是否被销毁

duration

duration: number = 1000

动画效果持续时长，单位为毫秒

ease

ease: (time: number) => number

Type declaration

    • (time: number): number

    • 缓动效果

      Parameters

      • time: number

      Returns number

ended

ended: boolean = false

脚本或动画是否结束

from

from: number = 0

属性起始值

id

id: number = -1

脚本或动画的ID，由编辑器产生

loop

loop: boolean = false

是否重复播放

loopInterval

loopInterval: number = 0

重复间隔，单位为毫秒

loopTimes

loopTimes: number = -1

循环次数,-1为无限循环

name

name: string = ''

脚本或动画名称，可以用来作为调试显示

playBySelf

playBySelf: boolean = false

是否自我驱动，设置为true后，脚本或动画不再受场景时间轴的控制，即使场景时间轴停止，脚本或动画也会继续执行

prop

prop: string = 'x'

需要缓动的节点的属性

to

to: number = 1

属性目标值

Accessors

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

  • 是否启用脚本或动画

    Returns boolean

  • 是否启用脚本或动画

    Parameters

    • value: boolean

    Returns void

root

  • get root(): undefined | IAnimation

  • 获得所在的根节点，如果是互动组件，则是 Animation，否者和 this.scene 相同

    Returns undefined | IAnimation

scene

  • get scene(): undefined | Scene

  • 当前场景的引用

    Returns undefined | Scene

target

  • get target(): undefined | Node
  • set target(value: undefined | Node): void

  • 脚本或动画控制的对象

    Returns undefined | Node

  • 脚本或动画控制的对象

    Parameters

    • value: undefined | Node

    Returns void

time

  • get time(): number
  • set time(value: number): void
  • deprecated

    请用delay属性代替

    Returns number

  • deprecated

    请用delay属性代替

    Parameters

    • value: number

    Returns void

Methods

destroy

  • destroy(): void

  • 销毁动画

    Returns void

end

  • end(): void

  • 结束动画效果，并停止到最后一帧

    Returns void

onAwake

  • onAwake(): void

  • 脚本或动画被激活时触发，在时间轴运行到脚本位置时，脚本会被激活，此时脚本才开始被执行，激活只会被触发一次

    Returns void

onClick

  • onClick(): void

  • 鼠标或者手指在对象上点击时触发

    Returns void

onCollisionEnter

  • 2D物体开始触发或碰撞时执行

    Parameters

    Returns void

onCollisionEnter3D

  • onCollisionEnter3D(collision: Collision3D): void

  • 3D物体开始碰撞时执行 此方法为虚方法，使用时重写覆盖即可

    Parameters

    • collision: Collision3D

    Returns void

onCollisionExit

  • 2D物体结束触发或碰撞时执行

    Parameters

    Returns void

onCollisionExit3D

  • onCollisionExit3D(collision: Collision3D): void

  • 3D物体结束碰撞时执行 此方法为虚方法，使用时重写覆盖即可

    Parameters

    • collision: Collision3D

    Returns void

onCollisionStay

  • 2D物体持续触发或碰撞时执行

    Parameters

    Returns void

onCollisionStay3D

  • onCollisionStay3D(collision: Collision3D): void

  • 3D物体持续碰撞时执行 此方法为虚方法，使用时重写覆盖即可

    Parameters

    • collision: Collision3D

    Returns void

onDestroy

  • onDestroy(): void

  • 脚本或动画被销毁时触发，场景被销毁，脚本会跟随一起销毁

    Returns void

onDisable

  • onDisable(): void

  • 脚本或动画被禁用时触发，在enabled=false，或者target=undefined 时会被禁用

    Returns void

onEditor

  • onEditor(): void

  • 用于自定义脚本实现编辑时可视化效果。在编辑器里进行编辑的情况下，每当脚本属性发生变化时触发 注意：该接口被执行后，脚本实例会立即销毁掉，请不要在脚本实例里保存变量。如有需要，请保存在目标对象target内。

    Returns void

onEnable

  • onEnable(): void

  • 脚本或动画被启用时触发，此时 this.target 对象可以使用了，但脚本还未被执行，可能会被触发多次

    Returns void

onEnter

  • onEnter(): void

  • 脚本或动画每次开始播放时触发，可能会被触发多次

    Returns void

onKeyDown

  • onKeyDown(keyCode: number): void

  • 键盘按下时

    Parameters

    • keyCode: number

      键盘按键

    Returns void

onKeyUp

  • onKeyUp(keyCode: number): void

  • 键盘抬起时

    Parameters

    • keyCode: number

      键盘按键

    Returns void

onLateUpdate

  • onLateUpdate(): void

  • 脚本或动画被激活后，会被每帧调用，在所有 onUpdate 调用完后调用，即使场景被暂停，onLateUpdate 也会继续更新，注意避免不必要的计算

    Returns void

onLeave

  • onLeave(): void

  • 脚本或动画每次播放完毕后触发，可能会被触发多次

    Returns void

onLoopComplete

  • onLoopComplete(): void

  • 动画循环播放完毕后触发

    Returns void

onMouseDown

  • onMouseDown(): void

  • 鼠标或者手指在对象上按下时触发

    Returns void

onMouseMove

  • onMouseMove(): void

  • 鼠标或者手指在对象上移动时触发

    Returns void

onMouseUp

  • onMouseUp(): void

  • 鼠标或者手指在对象上抬起时触发

    Returns void

onReset

  • onReset(): void

  • 脚本或动画被重置时触发，调用动画的gotoAndStop(time)时，在满足条件 script.awaked && time < script.delay 时会被重置

    Returns void

onStageMouseDown

  • onStageMouseDown(target: Node): void

  • 鼠标或者手指在舞台按下时触发

    Parameters

    • target: Node

      当前目标对象

    Returns void

onStageMouseMove

  • onStageMouseMove(target: Node): void

  • 鼠标或者手指在舞台上移动时触发

    Parameters

    • target: Node

      当前目标对象

    Returns void

onStageMouseUp

  • onStageMouseUp(target: Node): void

  • 鼠标或者手指在舞台抬起时触发

    Parameters

    • target: Node

      当前目标对象

    Returns void

onTriggerEnter3D

  • onTriggerEnter3D(other: Sprite3D): void

  • 3D物体开始触发时执行 此方法为虚方法，使用时重写覆盖即可

    Parameters

    • other: Sprite3D

    Returns void

onTriggerExit3D

  • onTriggerExit3D(other: Sprite3D): void

  • 3D物体结束触发时执行 此方法为虚方法，使用时重写覆盖即可

    Parameters

    • other: Sprite3D

    Returns void

onTriggerStay3D

  • onTriggerStay3D(other: Sprite3D): void

  • 3D物体持续触发时执行 此方法为虚方法，使用时重写覆盖即可

    Parameters

    • other: Sprite3D

    Returns void

onUpdate

  • onUpdate(): void

  • 脚本或动画被激活后，会被每帧调用，即使场景被暂停，onUpdate也会继续更新，注意避免不必要的计算

    Returns void

onValueChange

  • onValueChange(value: number): void

  • 动画效果值发生变化时触发

    Parameters

    • value: number

    Returns void

play

  • 播放效果，效果只播放一次，播放结束后自动终止

    Returns Promise<Effect>

reset

  • reset(): void

  • 重置动画，方便再次播放

    Returns void

stop

  • stop(): void

  • 停止播放动画

    Returns void

Static to

  • to(target: Node, prop: string, to?: number, duration?: number, ease?: (time: number) => number): Promise<Tween>

  • 缓动动画

    Parameters

    • target: Node

      目标节点

    • prop: string

      属性key，比如 'x'

    • Optional to: number

      结束值，默认为 1

    • Optional duration: number

      动画持续时长，默认为1000毫秒

    • Optional ease: (time: number) => number

      缓动函数，默认为匀速

        • (time: number): number

        • Parameters

          • time: number

          Returns number

    Returns Promise<Tween>