name | type | arguments | Default | description |
---|---|---|---|---|
at | number | <optional> | 0 |
The time (in ms) at which the Event will fire. The Timeline starts at 0. |
in | number | <optional> |
If the Timeline is running, this is the time (in ms) at which the Event will fire based on its current elapsed value. If set it will override the |
|
from | number | <optional> |
Fire this event 'from' milliseconds after the previous event in the Timeline. If set it will override the |
|
run | function | <optional> |
A function which will be called when the Event fires. |
|
loop | function | <optional> |
A function which will be called when the Event loops, this does not get called if the |
|
event | string | <optional> |
Optional string-based event name to emit when the Event fires. The event is emitted from the Timeline instance. |
|
target | * | <optional> |
The scope ( |
|
once | boolean | <optional> | false |
If set, the Event will be removed from the Timeline when it fires. |
stop | boolean | <optional> | false |
If set, the Timeline will stop and enter a complete state when this Event fires, even if there are other events after it. |
tween | Phaser.Tweens.Tween | Phaser.Tweens.TweenChain | Phaser.Types.Tweens.TweenBuilderConfig | Phaser.Types.Tweens.TweenChainBuilderConfig | <optional> |
A Tween or TweenChain configuration object or instance. If set, the Event will create this Tween when it fires. |
|
set | object | <optional> |
A key-value object of properties to set on the |
|
sound | string | object | <optional> |
A key from the Sound Manager to play, or a config object for a sound to play when the Event fires. If a config object it must provide two properties: |