TimerEvent

.Time. TimerEvent

计时器事件表示延迟的函数调用.它由场景的Clock管理,并会在经过一定时间后调用其函数.定时器事件可以选择性地重复——即.在结束之前多次调用它的函数,或者无限循环. 因为它是由时钟管理的,计时器事件是基于游戏时间的,将受到时钟时间范围的影响,如果时钟暂停,将暂停.

Constructor

new TimerEvent(config)

Since:
  • 3.0.0
Parameters:
Name Type Description
config Phaser.Types.Time.TimerEventConfig 计时器事件的配置,包括其延迟和回调.

Members

args :array

Since:
  • 3.0.0
要传递给回调的附加参数.
Type:
  • array

callback :function

Since:
  • 3.0.0
计时器事件发生时将调用的回调.
Type:
  • function

callbackScope :object

Since:
  • 3.0.0
将在其中调用回调的范围.
Type:
  • object

(readonly) delay :number

Since:
  • 3.0.0
Default Value:
  • 0
此时间触发事件的延迟时间(毫秒).
Type:
  • number

elapsed :number

Since:
  • 3.0.0
Default Value:
  • 0
自计时器事件创建以来经过的时间(毫秒). 该值是计时器事件的本地值,并且与其时钟相关.因此,它会受到时钟的时间刻度和暂停状态,计时器事件的初始#startAt属性以及计时器事件的#timeScale#paused状态的影响.
Type:
  • number

hasDispatched :boolean

Since:
  • 3.0.0
Default Value:
  • false
计时器事件的函数是否已被调用. 当计时器事件触发时,该属性将在回调函数被调用之前被设置为 `true` ,如果计时器事件重复,该属性将在调用之后立即被重置.此属性的值不直接影响计时器事件是否将从其时钟中移除,但可以防止其触发.
Type:
  • boolean

(readonly) loop :boolean

Since:
  • 3.0.0
Default Value:
  • false
如果此计时器循环,则为True,否则为false.
Type:
  • boolean

paused :boolean

Since:
  • 3.0.0
Default Value:
  • false
此计时器是否暂停.
Type:
  • boolean

(readonly) repeat :number

Since:
  • 3.0.0
Default Value:
  • 0
本次在结束前重复的总次数.
Type:
  • number

repeatCount :number

Since:
  • 3.0.0
Default Value:
  • 0
如果重复,这包含当前重复计数.
Type:
  • number

startAt :number

Since:
  • 3.0.0
Default Value:
  • 0
在经过的时间里开始这么多毫秒(如果您想要长时间重复,但第一个循环要快速启动,这很有用)
Type:
  • number

timeScale :number

Since:
  • 3.0.0
Default Value:
  • 1
缩放时间,使此计时器更新.
Type:
  • number

Methods

destroy()

Since:
  • 3.0.0
销毁计时器事件中的所有对象引用,即.它的回调,作用域和参数. 通常,这个方法只有在时钟关闭时才会被调用.因此,它不会停止计时器事件.如果手动调用,计时器事件仍将由时钟更新,但它在触发时不会做任何事情.

getElapsed() → {number}

Since:
  • 3.0.0
返回计时器事件当前迭代的本地运行时间.
Returns:
以毫秒为单位的本地运行时间.
Type
number

getElapsedSeconds() → {number}

Since:
  • 3.0.0
以秒为单位返回计时器事件当前迭代的本地运行时间.
Returns:
以秒为单位的本地运行时间.
Type
number

getOverallProgress() → {number}

Since:
  • 3.0.0
将重复因素考虑在内,获取计时器的整体进度.
Returns:
计时器事件的总进度,介于0和1之间.
Type
number

getOverallRemaining() → {number}

Since:
  • 3.50.0
返回计时器事件最后一次迭代之前的时间间隔.
Returns:
以毫秒为单位的时间间隔.
Type
number

getOverallRemainingSeconds() → {number}

Since:
  • 3.50.0
以秒为单位返回计时器事件最后一次迭代之前的时间间隔.
Returns:
以秒为单位的时间间隔.
Type
number

getProgress() → {number}

Since:
  • 3.0.0
获取当前迭代的进度,不考虑重复.
Returns:
一个介于0和1之间的数字,表示当前进度.
Type
number

getRemaining() → {number}

Since:
  • 3.50.0
返回计时器事件下一次迭代之前的时间间隔.
Returns:
以毫秒为单位的时间间隔.
Type
number

getRemainingSeconds() → {number}

Since:
  • 3.50.0
以秒为单位返回计时器事件下一次迭代之前的时间间隔.
Returns:
以秒为单位的时间间隔.
Type
number

getRepeatCount() → {number}

Since:
  • 3.0.0
返回此计时器事件在结束前重复的次数. 这不应与计时器事件在结束前触发的次数混淆.返回值0并不表示计时器事件已经结束运行,而是表示下次触发后不会重复.
Returns:
计时器事件将重复多少次.
Type
number

remove(dispatchCallbackopt)

Since:
  • 3.0.0
强制计时器事件立即到期,从而安排在下一帧将其删除.
Parameters:
Name Type Attributes Default Description
dispatchCallback boolean <optional>
false 如果 `true` ,定时器事件的功能将在其移除之前被调用.

reset(config) → {Phaser.Time.TimerEvent}

Since:
  • 3.0.0
根据配置对象,完全重新初始化计时器事件,无论其当前状态如何.
Parameters:
Name Type Description
config Phaser.Types.Time.TimerEventConfig 计时器事件的新状态.
Returns:
此时间显示对象.
Type
Phaser.Time.TimerEvent