Tween

.Tweens. Tween

基于,补间能够将一个或多个对象的属性操作为任何给定值 持续时间和轻松程度.它们很少被直接实例化,而是应该 通过TweenManager创建.

Constructor

new Tween(parent, data, targets)

Since:
  • 3.0.0
Parameters:
Name Type Description
parent Phaser.Tweens.TweenManager | Phaser.Tweens.Timeline 对此补间的父级的引用.补间管理器或补间时间线实例.
data Array.<Phaser.Types.Tweens.TweenDataConfig> 一个TweenData对象数组,每个对象包含一个要补间的唯一属性.
targets array 要补间的目标数组.

Extends

Members

calculatedOffset :number

Since:
  • 3.0.0
Default Value:
  • 0
仅当此补间是时间线的一部分时设置.计算的偏移量.
Type:
  • number

callbacks :object

Since:
  • 3.0.0
包含不同补间回调函数的对象. 您可以在补间配置中进行设置,也可以通过调用`补间.设置回调`方法进行设置. 当补间在补间管理器中从待定列表移动到活动列表时,即使回放暂停也是如此. 当补间动画在延迟状态后开始播放时.如果没有延迟,将与 `onActive` 同时发生. 当TweenData开始yoyo时.这发生在 `hold` 延迟到期后(如果设置). 当TweenData重复播放时.这发生在 `repeatDelay` 到期后,如果设置的话. 当补间动画完全结束播放时.如果补间被设置为无限重复,则从不调用. 当TweenData在回放期间更新源目标的属性时. 当补间动画循环时.这发生在 `loopDelay` 到期后,如果设置的话.
Type:
  • object

callbackScope :any

Since:
  • 3.0.0
调用所有回调的上下文.
Type:
  • any

completeDelay :number

Since:
  • 3.0.0
Default Value:
  • 0
`onComplete` 事件触发前的时间(毫秒/帧).如果循环= -1,则永远不会触发(因为它永远不会完成)
Type:
  • number

countdown :number

Since:
  • 3.0.0
Default Value:
  • 0
倒计时定时器(由时间线偏移,循环延迟和完全延迟使用)
Type:
  • number

data :Array.<Phaser.Types.Tweens.TweenDataConfig>

Since:
  • 3.0.0
一个TweenData对象数组,每个对象都包含一个唯一的属性和被补间的目标.
Type:

duration :number

Since:
  • 3.0.0
Default Value:
  • 0
整个补间播放一次的时间(毫秒/帧),不包括循环次数和循环延迟.
Type:
  • number

elapsed :number

Since:
  • 3.0.0
Default Value:
  • 0
在补间动画中运行的时间(毫秒/帧).
Type:
  • number

(readonly) hasStarted :boolean

Since:
  • 3.19.0
这个Tween已经开始播放了吗? 当补间动画离开 `delayed` 状态并开始运行时,该布尔值被切换.
Type:
  • boolean

(readonly) isSeeking :boolean

Since:
  • 3.19.0
这个Tween目前正在寻找吗? 该布尔值在 `Tween.seek` 方法中切换. 当一个补间寻找时,它不会分派任何事件或回调.
Type:
  • boolean

loop :number

Since:
  • 3.0.0
Default Value:
  • 0
循环这个吐温?对于无限循环,可以是-1,也可以是整数. 启用后,它将再次播放所有的TweenDatas.使用TweenData.repeat循环单个元素.
Type:
  • number

loopCounter :number

Since:
  • 3.0.0
Default Value:
  • 0
还剩多少圈可以跑?
Type:
  • number

loopDelay :number

Since:
  • 3.0.0
Default Value:
  • 0
补间循环前的时间(毫秒/帧).
Type:
  • number

offset :number

Since:
  • 3.0.0
Default Value:
  • 0
仅当此补间是时间线的一部分时设置.
Type:
  • number

parent :Phaser.Tweens.TweenManager|Phaser.Tweens.Timeline

Since:
  • 3.0.0
对此补间的父级的引用. 补间管理器或补间时间线实例.
Type:

parentIsTimeline :boolean

Since:
  • 3.0.0
这个补间的父级是时间轴吗?
Type:
  • boolean

paused :boolean

Since:
  • 3.0.0
Default Value:
  • false
补间动画开始时是否暂停?(如果是这样,需要从Tween.play开始)
Type:
  • boolean

progress :number

Since:
  • 3.0.0
Default Value:
  • 0
介于0和1之间的值.通过补间的数量,不包括循环.
Type:
  • number

startDelay :number

Since:
  • 3.19.0
Default Value:
  • 0
`onStart` 事件触发前的时间(毫秒/帧). 这是此补间的所有补间中最短的 `delay` 值.
Type:
  • number

state :number

Since:
  • 3.0.0
补间动画的当前状态
Type:
  • number

targets :Array.<object>

Since:
  • 3.0.0
对此补间操作的目标的引用数组.
Type:
  • Array.<object>

timeScale :number

Since:
  • 3.0.0
Default Value:
  • 1
缩放应用于此补间动画的时间.值1实时运行.0.5的值运行速度慢50%,以此类推. 计算补间动画的总持续时间时不使用该值,它只是一个运行时增量调整.
Type:
  • number

totalData :number

Since:
  • 3.0.0
数据数组的缓存长度.
Type:
  • number

totalDuration :number

Since:
  • 3.0.0
Default Value:
  • 0
补间完成的时间(以毫秒/帧为单位)(包括循环)
Type:
  • number

totalElapsed :number

Since:
  • 3.0.0
Default Value:
  • 0
整个补间动画的总运行时间(毫秒/帧),包括循环.
Type:
  • number

totalProgress :number

Since:
  • 3.0.0
Default Value:
  • 0
介于0和1之间的值.整个补间动画的数量,包括循环.
Type:
  • number

totalTargets :number

Since:
  • 3.0.0
缓存的目标总数(不一定与数据总数相同)
Type:
  • number

useFrames :boolean

Since:
  • 3.0.0
Default Value:
  • false
如果 `true` ,则持续时间,延迟等值都是帧总数.
Type:
  • boolean

Methods

addListener(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

calcDuration()

Since:
  • 3.0.0
计算补间动画总持续时间的内部方法.

complete(delayopt) → {this}

Since:
  • 3.2.0
将补间标记为完成,无论它处于哪个进度阶段. 如果一个完整的回调已经被定义,它将自动调用它,除非一个 参数,在这种情况下,补间将在调用回调之前延迟一段时间. 如果您不需要延迟,或者有一个完整的回调,那么请调用 `Tween.stop`.
Parameters:
Name Type Attributes Default Description
delay number <optional>
0 调用完整回调之前等待的时间.如果为零,它将立即开火.
Fires:
Returns:
此Tween实例.
Type
this

destroy()

Since:
  • 3.0.0
Inherited From:
移除所有侦听器.

dispatchTweenDataEvent(event, callback, tweenData)

Since:
  • 3.19.0
将发出基于TweenData的事件并调用给定回调的内部方法.
Parameters:
Name Type Description
event Phaser.Types.Tweens.Event 要调度的事件.
callback function 要调用的回调.可以是 `null` 或 `undefined` 以跳过调用.
tweenData Phaser.Types.Tweens.TweenDataConfig 导致此事件的TweenData对象.

dispatchTweenEvent(event, callback)

Since:
  • 3.19.0
将发出基于补间的事件并调用给定回调的内部方法.
Parameters:
Name Type Description
event Phaser.Types.Tweens.Event 要调度的事件.
callback function 要调用的回调.可以是 `null` 或 `undefined` 以跳过调用.

emit(event, …argsopt) → {boolean}

Since:
  • 3.0.0
Inherited From:
调用为给定事件注册的每个侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
args * <optional>
<repeatable>
将传递给事件处理程序的附加参数.
Returns:
`true` 如果事件有侦听器,则为 `false` .
Type
boolean

eventNames() → {Array.<(string|symbol)>}

Since:
  • 3.0.0
Inherited From:
返回一个数组,列出发射器已注册侦听器的事件.
Returns:
Type
Array.<(string|symbol)>

getTimeScale() → {number}

Since:
  • 3.0.0
返回应用于此补间动画的时间比例.
Returns:
此补间动画的时间刻度(介于0和1之间)
Type
number

getValue(indexopt) → {number}

Since:
  • 3.0.0
返回指定补间数据的当前值.
Parameters:
Name Type Attributes Default Description
index number <optional>
0 要从中返回值的补间数据.
Returns:
请求的补间数据的值.
Type
number

hasTarget(target) → {boolean}

Since:
  • 3.0.0
查看该补间当前是否作用于给定目标.
Parameters:
Name Type Description
target object 要对照此补间进行检查的目标.
Returns:
如果给定目标是此补间动画的目标,则为 `true` ,否则为 `false` .
Type
boolean

init() → {boolean}

Since:
  • 3.0.0
由TweenManager.preUpdate调用,作为其循环的一部分,用于检查挂起和活动的补间. 不应该直接调用.
Returns:
如果此补间应该由补间管理器从待定列表移到活动列表,则返回 `true` .
Type
boolean

isPaused() → {boolean}

Since:
  • 3.0.0
检查补间当前是否暂停.
Returns:
如果补间动画暂停,则为 `true` ,否则为 `false` .
Type
boolean

isPlaying() → {boolean}

Since:
  • 3.0.0
检查补间当前是否处于活动状态.
Returns:
如果补间动画处于活动状态,则为 `true` ,否则为 `false` .
Type
boolean

listenerCount(event) → {number}

Since:
  • 3.0.0
Inherited From:
返回监听给定事件的侦听器数量.
Parameters:
Name Type Description
event string | symbol 事件名称.
Returns:
侦听器的数量.
Type
number

listeners(event) → {Array.<function()>}

Since:
  • 3.