Tweens

Tweens

Type Definitions

Event

Since:
  • 3.19.0
吐温事件.
Type:
  • string

GetActiveCallback(target, key, value, targetIndex, totalTargets, tween) → {number}

Since:
  • 3.19.0
Parameters:
Name Type Description
target any The tween target.
key string The target property.
value number The current value of the target property.
targetIndex number The index of the target within the Tween.
totalTargets number The total number of targets in this Tween.
tween Phaser.Tweens.Tween The Tween that invoked this callback.
Returns:
- The new value.
Type
number

GetEndCallback(target, key, value, targetIndex, totalTargets, tween) → {number}

Since:
  • 3.18.0
Parameters:
Name Type Description
target any The tween target.
key string The target property.
value number The current value of the target property.
targetIndex number The index of the target within the Tween.
totalTargets number The total number of targets in this Tween.
tween Phaser.Tweens.Tween The Tween that invoked this callback.
Returns:
- The new value.
Type
number

GetStartCallback(target, key, value, targetIndex, totalTargets, tween) → {number}

Since:
  • 3.18.0
Parameters:
Name Type Description
target any The tween target.
key string The target property.
value number The current value of the target property.
targetIndex number The index of the target within the Tween.
totalTargets number The total number of targets in this Tween.
tween Phaser.Tweens.Tween The Tween that invoked this callback.
Returns:
- The new value.
Type
number

NumberTweenBuilderConfig

Since:
  • 3.18.0
Properties:
Name Type Attributes Default Description
from number <optional>
0 起始号码.
to number <optional>
1 结束号码.
delay number <optional>
0 补间动画开始前要延迟的毫秒数.
duration number <optional>
1000 补间的持续时间,以毫秒为单位.
ease string | function <optional>
'Power0' 用于补间的缓和方程.
easeParams array <optional>
可选放松参数.
hold number <optional>
0 悠悠球开始前保持补间的毫秒数.
repeat number <optional>
0 重复补间的次数.
repeatDelay number <optional>
0 补间动画重复前暂停的毫秒数.
yoyo boolean <optional>
false 补间是否应该完成,然后逐步反转这些值以返回到开始补间值?反向补间也需要 `duration` 毫秒才能完成.
offset string | number | function | object | array <optional>
null 当补间是时间线的一部分时使用.
completeDelay string | number | function | object | array <optional>
0 完成后,补间在发送完成事件之前等待的时间,以毫秒为单位.
loop string | number | function | object | array <optional>
0 补间将重复的次数.(值1表示补间将播放两次,因为它重复一次.第一个循环在每个属性补间完成一次后开始.
loopDelay string | number | function | object | array <optional>
0 在开始悠悠球或返回开始重复之前,补间将暂停的时间.
paused boolean <optional>
false 补间动画是以暂停状态(真)还是播放状态(假)开始?
useFrames boolean <optional>
false 用帧还是毫秒?
callbackScope any <optional>
回调的作用域(此).默认范围是补间.
onComplete Phaser.Types.Tweens.TweenOnCompleteCallback <optional>
补间动画完成时要调用的函数.
onCompleteParams array <optional>
要传递给 `onComplete` 的附加参数.
onCompleteScope any <optional>
范围(此处)为 `onComplete` .
onLoop Phaser.Types.Tweens.TweenOnLoopCallback <optional>
每次补间动画循环时调用的函数.
onLoopParams array <optional>
要传递给 `onLoop` 的附加参数.
onLoopScope any <optional>
`onLoop` 的作用域(此).
onRepeat Phaser.Types.Tweens.TweenOnRepeatCallback <optional>
每次补间动画重复时调用的函数.每个目标每个属性调用一次.
onRepeatParams array <optional>
要传递给 `onRepeat` 的附加参数.
onRepeatScope any <optional>
`onRepeat` 的作用域(this).
onStart Phaser.Types.Tweens.TweenOnStartCallback <optional>
补间动画开始时要调用的函数.
onStartParams array <optional>
要传递给 `onStart` 的附加参数.
onStartScope any <optional>
`onStart` 的作用域(this).
onStop Phaser.Types.Tweens.TweenOnStopCallback <optional>
补间动画停止时要调用的函数.
onStopParams array <optional>
要传递给 `onStop` 的附加参数.
onStopScope any <optional>
`onStop` 的作用域(此).
onUpdate Phaser.Types.Tweens.TweenOnUpdateCallback <optional>
每次补间步骤时要调用的函数.每个目标每个属性调用一次.
onUpdateParams array <optional>
要传递给 `onUpdate` 的附加参数.
onUpdateScope any <optional>
`onUpdate` 的范围(此处).
onYoyo Phaser.Types.Tweens.TweenOnYoyoCallback <optional>
每次补间操作时要调用的函数.每个目标每个属性调用一次.
onYoyoParams array <optional>
要传递给 `onYoyo` 的附加参数.
onYoyoScope any <optional>
范围(本)为 `onYoyo` .
Type:
  • object

StaggerConfig

Since:
  • 3.19.0
Properties:
Name Type Attributes Default Description
start number <optional>
0 开始交错的值.可以用作偏移交错的一种方式,同时仍然使用该值的范围.
ease string | function <optional>
'Linear' 易于在交错值之间应用.可以是字符串,如 `sine.inout` ,也可以是函数.
from string | number <optional>
0 开始交错的索引.可以是字符串 `first` , `last` 或 `center` ,或者代表交错位置的整数.
grid Array.<number> <optional>
通过提供一个数组,将交错设置为穿过网格,其中元素0是网格的宽度,元素1是高度.与 `from` 属性结合使用以控制方向.
Type:
  • object
Example
{
  grid: [ 20, 8 ],
  from: 'center',
  ease: 'Power0',
  start: 100
};

TimelineBuilderConfig

Since:
  • 3.18.0
See:
Properties:
Name Type Attributes Default Description
tweens Array.<Phaser.Types.Tweens.TweenBuilderConfig> | Array.<object> | function <optional>
要创建并添加到新时间线的补间配置对象的数组.如果不存在或为空,时间线将暂停,并且不会读取任何其他配置设置.如果它是一个函数,它将被调用,它的返回值将被用作数组.
targets any <optional>
应用时间线的默认目标数组(或返回其中一个的函数).每个单独的补间配置都可以覆盖此值.
totalDuration number <optional>
0 如果指定,默认情况下,时间线中的每个补间动画将获得该持续时间的相等部分,通常以毫秒为单位.每个单独的补间配置都可以覆盖补间的持续时间.
duration number <optional>
1000 如果未指定 `totalDuration` ,将创建的每个补间的默认持续时间,通常以毫秒为单位.每个单独的补间配置都可以覆盖补间的持续时间.
delay number <optional>
0 补间动画开始前要延迟的毫秒数.每个单独的补间配置都可以覆盖此值.
easeParams array <optional>
可选放松参数.每个单独的补间配置都可以覆盖此值.
ease string | function <optional>
'Power0' 用于每个补间的宽松方程式.每个单独的补间配置都可以覆盖此值.
hold number <optional>
0 悠悠球开始前每个补间保持的毫秒数.每个单独的补间配置都可以覆盖此值.
repeat number <optional>