Type Alias TimelineEventConfig

The time (in ms) at which the Event will fire. The Timeline starts at 0.

Optional string-based event name to emit when the Event fires. The event is emitted from the Timeline instance.

Fire this event 'from' milliseconds after the previous event in the Timeline. If set it will override the at and in properties.

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 at property.

A function which will be called when the Event loops, this does not get called if the repeat method is not used or on first iteration.

If set, the Event will be removed from the Timeline when it fires.

A function which will be called when the Event fires.

A key-value object of properties to set on the target when the Event fires. Ignored if no target is given.

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.

If set, the Timeline will stop and enter a complete state when this Event fires, even if there are other events after it.

The scope (this object) with which to invoke the run callback, if set.

A Tween or TweenChain configuration object or instance. If set, the Event will create this Tween when it fires.