Phaser API Documentation

  Version: 
Phaser . Types . Time . TimelineEventConfig
TimelineEventConfig
Properties:
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 already running, this is the time (in ms) at which the Event will fire based on its current elapsed value. If set, overrides the at property.
from number <optional>

Fire this event 'from' milliseconds after the previous event in the Timeline. If set it overrides the at and in properties.
run function <optional>

A function which will be called when the Event fires.
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 (this object) with which to invoke the run callback, if set.
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 target when the Event fires. Ignored if no target is given.
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: key and config. The key is the key of the sound to play, and the config is the config is a Phaser.Types.Sound.SoundConfig object.
Type:
object
Since: 3.60.0