类 Tween

En

The Tween class is an easing class. It is used to implement the interpolation of properties of a target object.

Zh

Tween 类是一个缓动类。使用此类能够实现对目标对象属性的渐变。

示例

//tween a numeric property of an object
let tween = Laya.Tween.create(target).duration(1000).delay(1000)
 .to("x", 100).to("y", 200).ease(Laya.Ease.sineInOut).then(callback);

//tween a vector property of an object
Laya.Tween.create(target.transform, target).duration(1000).to("localPosition", new Laya.Vector3(1,1,1));

//tween a hex color property of an object, r/g/b channel are tweened separately.
Laya.Tween.create(target).duration(1000).to("color", 0xffffff).interp(Laya.Tween.seperateChannel, 3);

//Somewhere want to kill the tween immediately.
tween.kill();

//or kill by target
Laya.Tween.killAll(target);

//use chain and parallel to create complex sequences
Laya.Tween.create(target).duration(1000).to("x", 100)
  .chain().duration(500).to("y", 200)
  .parallel().to("visible", true)

访问器

completed

方法

breakpoint chain clear complete delay duration ease findTweener from go ignoreEngineTimeScale interp kill name onStart onUpdate parallel pause recover repeat resume seek snapping then timeScale to userData clear clearAll create from getTween getTweens isTweening kill killAll seperateChannel shake to useCurvePath

访问器

completed

  • get completed(): boolean

    返回 boolean

    En

    Whether the Tween is completed. If the Tween is killed, this property will still be false.

    Zh

    缓动是否已结束。如果缓动是被kill掉的，此属性仍然为false。

方法

breakpoint

  • breakpoint(value: number): this

    参数

    • value: number

      The breakpoint in milliseconds.

    返回 this

    The Tween object.

    En

    Set the breakpoint of the current task. If the time reaches the breakpoint, the task will end.

    Zh

    设置当前任务的断点时间。如果时间达到断点时间，任务将会结束。

chain

  • chain(target?: any, lifecycleOwner?: { destroyed: boolean }): this

    参数

    • 可选target: any

      The target object of the Tween. If it is empty, the target object pass in create method will be used.

    • 可选lifecycleOwner: { destroyed: boolean }

      The lifecycle object, when destroyed, the tween will automatically stop. In general, if the target object of the task has a destroyed property, this property does not need to be set. If the target object of the task does not have a destroyed property, this property can be set.

    返回 this

    The Tween object.

    En

    Start a new tween task, which will start immediately after the current task ends.

    Zh

    开启一个新的缓动任务，它将在当前任务结束后立刻开始。

clear

complete

delay

  • delay(value: number): this

    参数

    • value: number

      The delay time in milliseconds.

    返回 this

    Tween object.

    En

    Set the delay time of the current task.

    Zh

    设置当前任务的延迟时间。

duration

  • duration(value: number): this

    参数

    • value: number

      The duration in milliseconds.

    返回 this

    The Tween object.

    En

    Set the duration of the current task.

    Zh

    设置当前任务的持续时间。

ease

  • ease(
        value:
            | EaseFunction
            | "linear"
            | "linearNone"
            | "linearIn"
            | "linearInOut"
            | "linearOut"
            | "bounceIn"
            | "bounceInOut"
            | "bounceOut"
            | "backIn"
            | "backInOut"
            | "backOut"
            | "elasticIn"
            | "elasticInOut"
            | "elasticOut"
            | "strongIn"
            | "strongInOut"
            | "strongOut"
            | "sineInOut"
            | "sineIn"
            | "sineOut"
            | "quintIn"
            | "quintInOut"
            | "quintOut"
            | "quartIn"
            | "quartInOut"
            | "quartOut"
            | "cubicIn"
            | "cubicInOut"
            | "cubicOut"
            | "quadIn"
            | "quadInOut"
            | "quadOut"
            | "expoIn"
            | "expoInOut"
            | "expoOut"
            | "circIn"
            | "circInOut"
            | "circOut",
        ...args: any[],
    ): this

    参数

    • value:
          | EaseFunction
          | "linear"
          | "linearNone"
          | "linearIn"
          | "linearInOut"
          | "linearOut"
          | "bounceIn"
          | "bounceInOut"
          | "bounceOut"
          | "backIn"
          | "backInOut"
          | "backOut"
          | "elasticIn"
          | "elasticInOut"
          | "elasticOut"
          | "strongIn"
          | "strongInOut"
          | "strongOut"
          | "sineInOut"
          | "sineIn"
          | "sineOut"
          | "quintIn"
          | "quintInOut"
          | "quintOut"
          | "quartIn"
          | "quartInOut"
          | "quartOut"
          | "cubicIn"
          | "cubicInOut"
          | "cubicOut"
          | "quadIn"
          | "quadInOut"
          | "quadOut"
          | "expoIn"
          | "expoInOut"
          | "expoOut"
          | "circIn"
          | "circInOut"
          | "circOut"

      The easing function, or the name of the easing function.

    • ...args: any[]

      Extra parameters for the easing function.

    返回 this

    The Tween object.

    En

    Set the easing function of the current task. Use the Laya.Ease class for preset easing functions.

    Zh

    设置当前任务的缓动函数。可以使用Laya.Ease类中的预设缓动函数，或者一个缓动函数的名称。

findTweener

from

  • from(propName: string, value: any): this

    参数

    • propName: string

      The name of the property. The property can be a number, string, boolean, Vector2, Vector3, Vector4, or Color. If it is a string, it is implicitly a color value.

    • value: any

      The start value of the property.

    返回 this

    The Tween object.

    En

    Tweens the object's property from the specified value to the current value.

    Zh

    缓动对象的属性从指定值到当前值。

go

  • go<T>(propName: string, startValue: T, endValue: T): this

    类型参数

    • T

    参数

    • propName: string

      The name of the property. The property can be a number, string, boolean, Vector2, Vector3, Vector4, or Color. If it is a string, it is implicitly a color value.

    • startValue: T

      The start value of the property.

    • endValue: T

      The end value of the property.

    返回 this

    The Tween object.

    En

    Tweens the object's property from the start value to the end value.

    Zh

    缓动对象的属性从指定的起始值到指定的结束值。

ignoreEngineTimeScale

  • ignoreEngineTimeScale(value: boolean): this

    参数

    • value: boolean

      If true, then the time scale of current task will not be affected by Laya.timer.

    返回 this

    The Tween object.

    En

    Set whether current task will ignore the time scale from Laya.timer.

    Zh

    设置当前任务是否忽略Laya.timer的时间缩放。

interp

  • interp<T extends any[]>(value: TweenInterpolator<T>, ...args: T): this

    类型参数

    • T extends any[]

    参数

    • value: TweenInterpolator<T>

      The interpolation function.

    • ...args: T

      Extra parameters for the interpolation function.

    返回 this

    The Tween object.

    En

    Set the interpolation function of the current task. e.g. Laya.Tween.seperateChannel.

    Zh

    设置当前任务的插值函数。比如Laya.Tween.seperateChannel。

kill

  • kill(complete?: boolean): void

    参数

    • 可选complete: boolean

      If true, the Tween will be set to the end state, and the complete callback will be called. If false, the complete callback will not be called.

    返回 void

    The Tween object.

    En

    Kill the Tween. The Tween will be stopped and will be removed from the Tween system.

    Zh

    结束缓动。缓动将会停止，并从缓动系统中移除。

name

  • name(value: string): this

    参数

    • value: string

      The name of the current task.

    返回 this

    The Tween object.

    En

    Set the name of current task.

    Zh

    设置当前任务的名称。

onStart

  • onStart(callback: TweenCallback, callbackThis?: any): this

    参数

    • callback: TweenCallback

      The start callback.

    • 可选callbackThis: any

      The start callback execution context.

    返回 this

    The Tween object.

    En

    Set a custom start callback for the current task. The start callback is executed when the task starts.

    Zh

    设置当前任务的自定义开始回调。开始回调会在任务开始时执行。

onUpdate

  • onUpdate(callback: TweenCallback, callbackThis?: any): this

    参数

    • callback: TweenCallback

      The update callback.

    • 可选callbackThis: any

      The update callback execution context.

    返回 this

    The Tween object.

    En

    Set a custom update callback for the current task. The update callback is executed for every frame during the task.

    Zh

    设置当前任务的自定义更新回调。更新回调会在任务的每一帧执行。

parallel

  • parallel(target?: any, lifecycleOwner?: { destroyed: boolean }): this

    参数

    • 可选target: any

      The target object of the Tween. If it is empty, the target object pass in chain or create method will be used.

    • 可选lifecycleOwner: { destroyed: boolean }

      The lifecycle object, when destroyed, the tween will automatically stop. In general, if the target object of the task has a destroyed property, this property does not need to be set. If the target object of the task does not have a destroyed property, this property can be set.

    返回 this

    The Tween object.

    En

    Start a new tween task, which will start at the same time as the current task.

    Zh

    开启一个新的缓动任务，它和当前任务同时开始。

pause

  • pause(): this

    返回 this

    En

    Pause the tween. It can be resumed using resume() or restart().

    Zh

    暂停缓动。可以通过 resume() 重新开始。

recover

  • recover(): void

    返回 void

    En

    Clear the tween and return it to the object pool. Note: After calling this method, this object cannot be used again, otherwise it will cause unpredictable problems.

    Zh

    清理缓动，并将缓动对象回收到对象池。注意：调用此方法，本对象不能再使用，否则会造成不可预料的问题。

repeat

  • repeat(repeat: number, yoyo?: boolean): this

    参数

    • repeat: number

      The number of repetitions of the task.

    • 可选yoyo: boolean

      If yoyo is true, after the first play, the task will alternate back and forth.

    返回 this

    The Tween object.

    En

    Set the number of repetitions of the current task. If the repeat is 0, then the task will play once. If the repeat is -1, then the task will loop indefinitely. If the repeat is 1, then the task will play twice, and so on.

    Zh

    设置当前任务的重复次数。 如果 repeat 为 0，则任务将播放一次。如果 repeat 为 -1，则任务将无限循环。 如果 repeat 为 1，则任务将播放两次，依此类推。

resume

seek

  • seek(time: number): this

    参数

    • time: number

      The time to seek to, in milliseconds.

    返回 this

    The Tween object.

    En

    Seek current task to a specified time.

    Zh

    将当前任务的播放头跳转到指定的时间。

snapping

  • snapping(value: boolean): this

    参数

    • value: boolean

      If true, the property values will be rounded to an integer.

    返回 this

    The Tween object.

    En

    Set whether the property values of current task is rounded to an integer.

    Zh

    设置当前任务的属性值是否取整。

then

  • then(callback: TweenCallback, callbackThis?: any): this

    参数

    • callback: TweenCallback

      The complete callback.

    • 可选callbackThis: any

      The complete callback execution context.

    返回 this

    The Tween object.

    En

    Set a custom complete callback for the current task. The complete callback is executed when the task finishes. Note that if there are parallel tasks, the complete callback will only be called when all tasks are finished. If the task is killed before it ends, and the parameter complete is false, the complete callback will not be called.

    Zh

    设置当前任务的自定义结束回调。结束回调会在任务结束时执行。 注意，如果有并行任务，只是在当前任务结束就会调用结束回调，而并不是所有并行的任务。 如果任务在结束前被 kill，并且参数 complete 为 false，则不会调用结束回调。

timeScale

  • timeScale(value: number): this

    参数

    • value: number

      The time scale.

    返回 this

    The Tween object.

    En

    Set the time scale of the current task.

    Zh

    设置当前任务的时间缩放。

to

  • to(propName: string, value: any): this

    参数

    • propName: string

      The name of the property. The property can be a number, string, boolean, Vector2, Vector3, Vector4, or Color. If it is a string, it is implicitly a color value.

    • value: any

      The target value of the property.

    返回 this

    The Tween object.

    En

    Tweens the object's property to the sepecified value.

    Zh

    缓动对象的属性到指定值。 属性类型可以是数字，字符串，布尔值，Vector2, Vector3, Vector4, Color。如果是字符串，则隐含为颜色值。

userData

  • userData(value: any): this

    参数

    • value: any

      The user data of the current task.

    返回 this

    The Tween object.

    En

    Set the user data of the current task.

静态clear

静态clearAll

静态create

  • create(target?: any, lifecycleOwner?: { destroyed: boolean }): Tween

    参数

    • 可选target: any

      The target object of the Tween. It can be empty.

    • 可选lifecycleOwner: { destroyed: boolean }

      The lifecycle object, when destroyed, the tween will automatically stop. In general, if the target object of the task has a destroyed property, this property does not need to be set. If the target object of the task does not have a destroyed property, this property can be set.

    返回 Tween

    A Tween object.

    En

    Create a new Tween object. You can set the properties of the Tween by chaining. It will start automatically and does not need to be called separately.

    Zh

    创建一个新的缓动对象。使用返回的对象可以设置缓动的属性和其他选项。 缓动会自动开始，无需额外API调用。如果不想tween被立刻执行，可以调用pause，后续再调用resume。

静态from

  • from(
        target: any,
        props: Record<string, any>,
        duration: number,
        ease?: EaseFunction,
        complete?: Handler,
        delay?: number,
        coverBefore?: boolean,
    ): Tween

    参数

    • target: any

      The target object whose properties will be tweened.

    • props: Record<string, any>

      The list of properties to change, e.g., {x:100, y:20, ease:Ease.backOut, complete:Handler.create(this,onComplete), update:new Handler(this,onUpdate)}.

    • duration: number

      The time taken for the tween in milliseconds.

    • 可选ease: EaseFunction

      The type of easing, defaults to linear motion.

    • 可选complete: Handler

      The callback function when the tween completes.

    • 可选delay: number

      The delay before the tween starts.

    • 可选coverBefore: boolean

      Whether to override the previous tween.

    返回 Tween

    Returns the Tween object.

    En

    From the props attribute, tween to the current state. This is a compatibility function, recommended to use Tween.create instead.

    Zh

    从props属性，缓动到当前状态。 这是兼容老版本的函数签名，建议使用Twee.create替代。

静态getTween

静态getTweens

  • getTweens(target: any, out?: Tween[]): Tween[]

    参数

    • target: any

      The target object.

    • 可选out: Tween[]

      An array to receive the Tween objects.

    返回 Tween[]

    An array of Tween objects that are running on the specified target.

    En

    Get all Tweens that are running on the specified target. If none, returns an empty array or the passed-in non-null array.

    Zh

    获取指定对象上正在运行的所有 Tween。如果没有，返回空数组或传入的非空对象。

静态isTweening

  • isTweening(target: any): boolean

    参数

    • target: any

      The target object.

    返回 boolean

    Returns true if there is a Tween running on the target.

    En

    Check if any Tween is running on the specified target.

    Zh

    检查指定对象上是否有任何 Tween 正在运行。

静态kill

静态killAll

  • killAll(target: any, completed?: boolean): boolean

    参数

    • target: any

      The target object.

    • 可选completed: boolean

      If true, the tweens will be set to the end state, and the complete callback will be called. If false, the complete callback will not be called.

    返回 boolean

    Returns true if there any tweens are existing and killed.

    En

    Kill all Tweens by the specified target.

    Zh

    结束指定对象上的所有 Tween。

静态seperateChannel

  • seperateChannel(
        time: number,
        start: readonly number[],
        end: readonly number[],
        result: number[],
        channels?: number,
    ): void

    参数

    • time: number
    • start: readonly number[]
    • end: readonly number[]
    • result: number[]
    • 可选channels: number

      The number of channels to interpolate. For example, if it is RGB, this value is 3. If it is RGBA, this value is 4. Default is 3.

    返回 void

    En

    This is an interpolator that separates a numeric color value into each channel for interpolation. For example, from 0x000000 to 0xffffff tween, by default, it will increase directly from 0x000000 to 0xffffff, instead of R/G/B increasing from 0x00 to 0xff respectively. Using this interpolator, R/G/B can increase from 0x00 to 0xff respectively.

    Zh

    这是一个实现将一个数字颜色值分离各个通道分别进行插值的插值器。 例如从0x000000到0xffffff缓动，默认情况下是直接从0x000000一直增大到0xffffff，而不是R/G/B分别从0x00到0xff。使用这个插值器可以让R/G/B分别从0x00到0xff。

    示例

    Laya.Tween.create(target).duration(1000).to("color",0xffffff).interp(Laya.Tween.seperateChannel, 3);

静态shake

  • shake(
        time: number,
        start: readonly number[],
        end: readonly number[],
        result: number[],
        amplitude: number,
    ): void

    参数

    • time: number
    • start: readonly number[]
    • end: readonly number[]
    • result: number[]
    • amplitude: number

      The amplitude of the shake effect.

    返回 void

    En

    This is an interpolator that implements a shake effect.

    Zh

    这是一个实现震动效果的插值器。

    示例

    //The value pass in `to` is not used, so it can be any value.
    Laya.Tween.create(target).duration(1000).to("x",0).to("y",0).interp(Laya.Tween.shake, 3);

静态to

  • to(
        target: any,
        props: Readonly<Record<string, any>>,
        duration: number,
        ease?: EaseFunction,
        complete?: Handler,
        delay?: number,
        coverBefore?: boolean,
    ): Tween

    参数

    • target: any

      The target object whose properties will be tweened.

    • props: Readonly<Record<string, any>>

      The list of properties to change, e.g., {x:100, y:20, ease:Ease.backOut, complete:Handler.create(this,onComplete), update:new Handler(this,onUpdate)}.

    • duration: number

      The time taken for the tween in milliseconds.

    • 可选ease: EaseFunction

      The type of easing, defaults to linear motion.

    • 可选complete: Handler

      The callback function when the tween completes.

    • 可选delay: number

      The delay before the tween starts.

    • 可选coverBefore: boolean

      Whether to override the previous tween.

    返回 Tween

    Returns the Tween object.

    En

    Tweens the object's properties to the target values. This is a compatibility function, recommended to use Tween.create instead.

    Zh

    缓动对象的props属性到目标值。这是兼容老版本的函数签名，建议使用Twee.create替代。

静态useCurvePath

  • useCurvePath(
        time: number,
        start: readonly number[],
        end: readonly number[],
        result: number[],
        path: CurvePath,
    ): void

    参数

    • time: number
    • start: readonly number[]
    • end: readonly number[]
    • result: number[]
    • path: CurvePath

    返回 void

    En

    This is an interpolator that uses a curve path. The value will be obtained from the curve path.

    Zh

    这是一个使用曲线路径的插值器。数值将从曲线路径中获取。

显示设置

成员可见性

目录

访问器
方法