Filter
A Timeline is a way to schedule events to happen at specific times in the future.
You can think of it as an event sequencer for your game, allowing you to schedule the running of callbacks, events and other actions at specific times in the future.
A Timeline is a Scene level system, meaning you can have as many Timelines as you like, each belonging to a different Scene. You can also have multiple Timelines running at the same time.
If the Scene is paused, the Timeline will also pause. If the Scene is destroyed, the Timeline will be automatically destroyed. However, you can control the Timeline directly, pausing, resuming and stopping it at any time.
Create an instance of a Timeline via the Game Object Factory:
const timeline = this.add.timeline();
The Timeline always starts paused. You must call play on it to start it running.
You can also pass in a configuration object on creation, or an array of them:
const timeline = this.add.timeline({
at: 1000,
run: () => {
this.add.sprite(400, 300, 'logo');
}
});
timeline.play();
In this example we sequence a few different events:
const timeline = this.add.timeline([
{
at: 1000,
run: () => { this.logo = this.add.sprite(400, 300, 'logo'); },
sound: 'TitleMusic'
},
{
at: 2500,
tween: {
targets: this.logo,
y: 600,
yoyo: true
},
sound: 'Explode'
},
{
at: 8000,
event: 'HURRY_PLAYER',
target: this.background,
set: {
tint: 0xff0000
}
}
]);
timeline.play();
The Timeline can also be looped with the repeat method:
timeline.repeat().play();
There are lots of options available to you via the configuration object. See the Phaser.Types.Time.TimelineEventConfig typedef for more details.
Constructor:
new Timeline(scene, [config])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| scene | Phaser.Scene |
The Scene which owns this Timeline. |
|
| config | Phaser.Types.Time.TimelineEventConfig | Array.<Phaser.Types.Time.TimelineEventConfig> | <optional> |
The configuration object for this Timeline Event, or an array of them. |
Extends
Members
Description:
Whether the Timeline is complete (true) or not (false).
A Timeline is considered complete when all of its events have been run.
If you wish to reset a Timeline after it has completed, you can do so
by calling the Timeline.reset method.
You can also use the Timeline.stop method to stop a running Timeline,
at any point, without resetting it.
Type:
Description:
The elapsed time counter.
Treat this as read-only.
Type:
Description:
An array of all the Timeline Events.
Type:
Description:
The number of times this Timeline has looped.
This value is incremented each loop if looping is enabled.
Type:
Description:
The number of times this timeline should loop.
If this value is -1 or any negative number this Timeline will not stop.
Type:
Description:
Whether the Timeline is running (true) or active (false).
When paused, the Timeline will not run any of its actions.
By default a Timeline is always paused and should be started by
calling the Timeline.play method.
You can use the Timeline.pause and Timeline.resume methods to control
this value in a chainable way.
Type:
Description:
The Timeline's delta time scale.
Values higher than 1 increase the speed of time, while values smaller than 1 decrease it. A value of 0 freezes time and is effectively equivalent to pausing the Timeline.
This doesn't affect the delta time scale of any Tweens created by the Timeline.
You will have to set the timeScale of each Tween or the Tween Manager if you want them to match.
Type:
Description:
The total number of events that have been run.
This value is reset to zero if the Timeline is restarted.
Treat this as read-only.
Type:
Methods
Description:
Adds one or more events to this Timeline.
You can pass in a single configuration object, or an array of them:
const timeline = this.add.timeline({
at: 1000,
run: () => {
this.add.sprite(400, 300, 'logo');
}
});
Parameters:
| name | type | description |
|---|---|---|
| config | Phaser.Types.Time.TimelineEventConfig | Array.<Phaser.Types.Time.TimelineEventConfig> |
The configuration object for this Timeline Event, or an array of them. |
Returns:
Description:
This Timeline instance.
Type:
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Type:
Description:
Removes all events from this Timeline, resets the elapsed time to zero and pauses the Timeline.
Any Tweens that were currently running as a result of this Timeline will be stopped.
Returns:
Description:
This Timeline instance.
Type:
Description:
Destroys this Timeline.
This will remove all events from the Timeline and stop it from processing.
Any Tweens that were currently running as a result of this Timeline will be stopped.
This method is called automatically when the Scene shuts down, but you may also call it directly should you need to destroy the Timeline earlier.
Description:
Calls each of the listeners registered for a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| args | * | <optional> |
Additional arguments that will be passed to the event handler. |
Returns:
Description:
true if the event had listeners, else false.
Type:
- boolean
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Returns a number between 0 and 1 representing the progress of this Timeline.
A value of 0 means the Timeline has just started, 0.5 means it's half way through, and 1 means it's complete.
If the Timeline has no events, or all events have been removed, this will return 1.
If the Timeline is paused, this will return the progress value at the time it was paused.
Note that the value returned is based on the number of events that have been completed, not the 'duration' of the events (as this is unknown to the Timeline).
Returns:
Description:
A number between 0 and 1 representing the progress of this Timeline.
Type:
- number
Description:
Returns true if this Timeline is currently playing.
A Timeline is playing if it is not paused or not complete.
Returns:
Description:
true if this Timeline is playing, otherwise false.
Type:
- boolean
Description:
Return the number of listeners listening to a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The number of listeners.
Type:
- number
Description:
Return the listeners registered for a given event.
Parameters:
| name | type | description |
|---|---|---|
| event | string | symbol |
The event name. |
Returns:
Description:
The registered listeners.
Type:
- Array.<function()>
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Type:
Description:
Add a listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Type:
Description:
Add a one-time listener for a given event.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| event | string | symbol |
The event name. |
||
| fn | function |
The listener function. |
||
| context | * | <optional> | this |
The context to invoke the listener with. |
Returns:
Description:
this.
Type:
Description:
Pauses this Timeline.
To resume it again, call the Timeline.resume method or set the Timeline.paused property to false.
If the Timeline is paused while processing the current game step, then it will carry on with all events that are due to run during that step and pause from the next game step.
Note that if any Tweens have been started prior to calling this method, they will not be paused as well.
Returns:
Description:
This Timeline instance.
Type:
Description:
Starts this Timeline running.
If the Timeline is already running and the fromStart parameter is true,
then calling this method will reset the Timeline events as incomplete.
If you wish to resume a paused Timeline, then use the Timeline.resume method instead.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| fromStart | boolean | <optional> | true |
Reset this Timeline back to the start before playing. |
Returns:
Description:
This Timeline instance.
Type:
Description:
Updates the elapsed time counter, if this Timeline is not paused.
Parameters:
| name | type | description |
|---|---|---|
| time | number |
The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout. |
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Description:
Remove all listeners, or those of the specified event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol | <optional> |
The event name. |
Returns:
Description:
this.
Type:
Description:
Remove the listeners of a given event.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| event | string | symbol |
The event name. |
|
| fn | function | <optional> |
Only remove the listeners that match this function. |
| context | * | <optional> |
Only remove the listeners that have this context. |
| once | boolean | <optional> |
Only remove one-time listeners. |
Returns:
Description:
this.
Type:
Description:
Repeats this Timeline.
If the value for amount is positive, the Timeline will repeat that many additional times.
For example a value of 1 will actually run this Timeline twice.
Depending on the value given, false is 0 and true, undefined and negative numbers are infinite.
If this Timeline had any events set to once that have already been removed,
they will not be repeated each loop.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| amount | number | boolean | <optional> | -1 |
Amount of times to repeat, if |
Returns:
Description:
This Timeline instance.
Type:
Description:
Resets this Timeline back to the start.
This will set the elapsed time to zero and set all events to be incomplete.
If the Timeline had any events that were set to once that have already
been removed, they will not be present again after calling this method.
If the Timeline isn't currently running (i.e. it's paused or complete) then
calling this method resets those states, the same as calling Timeline.play(true).
Any Tweens that were currently running by this Timeline will be stopped.
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| loop | boolean | <optional> | false |
Set to true if you do not want to reset the loop counters. |
Returns:
Description:
This Timeline instance.
Type:
Description:
Resumes this Timeline from a paused state.
The Timeline will carry on from where it left off.
If you need to reset the Timeline to the start, then call the Timeline.reset method.
Returns:
Description:
This Timeline instance.
Type:
Description:
Removes all listeners.
Description:
Stops this Timeline.
This will set the paused and complete properties to true.
If you wish to reset the Timeline to the start, then call the Timeline.reset method.
Returns:
Description:
This Timeline instance.
Type:
Description:
Called automatically by the Scene update step.
Iterates through all of the Timeline Events and checks to see if they should be run.
If they should be run, then the TimelineEvent.action callback is invoked.
If the TimelineEvent.once property is true then the event is removed from the Timeline.
If the TimelineEvent.event property is set then the Timeline emits that event.
If the TimelineEvent.run property is set then the Timeline invokes that method.
If the TimelineEvent.loop property is set then the Timeline invokes that method when repeated.
If the TimelineEvent.target property is set then the Timeline invokes the run method on that target.
Parameters:
| name | type | description |
|---|---|---|
| time | number |
The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout. |
| delta | number |
The delta time in ms since the last frame. This is a smoothed and capped value based on the FPS rate. |
Fires: