Phaser API Documentation

  Version: 

Member of: Phaser.Types.Time

TimelineEvent
Properties:
name type arguments Default description
complete boolean

Has this event completed yet?
once boolean

Is this a once only event?
time number

The time (in elapsed ms) at which this event will fire.
repeat function <optional> 0

The amount of times this Event has repeated.
if function <optional> null

User-land callback which will be called if set. If it returns true then this event run all of its actions, otherwise it will be skipped.
run function <optional> null

User-land callback which will be called when the Event fires.
loop function <optional> null

User-land callback which will be called when the Event loops.
tween Phaser.Tweens.Tween | Phaser.Tweens.TweenChain | Phaser.Types.Tweens.TweenBuilderConfig | Phaser.Types.Tweens.TweenChainBuilderConfig <optional> null

Tween configuration object which will be used to create a Tween when the Event fires if set.
set object <optional> null

Object containing properties to set on the target when the Event fires if set.
sound string | object <optional> null

Sound configuration object which will be used to create a Sound when the Event fires if set.
target * <optional>

The scope (this object) with which to invoke the run callback.
event string <optional>

Optional event name to emit when the Event fires.
tweenInstance Phaser.Tweens.Tween | Phaser.Tweens.TweenChain <optional> null

If this Event is using a Tween to manage its actions, this property will contain a reference to it.
Type:
object
Since: 3.60.0