Filter
The Clock is a Scene plugin which creates and updates Timer Events for its Scene.
Constructor:
new Clock(scene)
Members
Description:
The current time of the Clock, in milliseconds.
If accessed externally, this is equivalent to the time parameter normally passed to a Scene's update method.
Type:
Description:
Whether the Clock is paused (true) or active (false).
When paused, the Clock will not update any of its Timer Events, thus freezing time.
Type:
Description:
The Scene Systems object of the Scene which owns this Clock.
Type:
Description:
The scale of the Clock's time delta.
The time delta is the time elapsed between two consecutive frames and influences the speed of time for this Clock and anything which uses it, such as its Timer Events. 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 Clock.
Type:
Methods
Description:
Creates a Timer Event and adds it to the Clock at the start of the frame.
You can also pass in an existing Timer Event, which will be reset and added to this Clock.
Note that if the Timer Event is being used by another Clock (in another Scene) it will still be updated by that Clock as well, so be careful when using this feature.
Parameters:
| name | type | description |
|---|---|---|
| config | Phaser.Time.TimerEvent | Phaser.Types.Time.TimerEventConfig |
The configuration for the Timer Event, or an existing Timer Event object. |
Returns:
Description:
The Timer Event which was created, or passed in.
Type:
Description:
Clears and recreates the array of pending Timer Events.
Returns:
Description:
- This Clock instance.
Type:
Description:
Creates a Timer Event and adds it to the Clock at the start of the frame.
This is a shortcut for #addEvent which can be shorter and is compatible with the syntax of the GreenSock Animation Platform (GSAP).
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| delay | number |
The delay of the function call, in milliseconds. |
|
| callback | function |
The function to call after the delay expires. |
|
| args | Array.<*> | <optional> |
The arguments to call the function with. |
| callbackScope | * | <optional> |
The scope ( |
Returns:
Description:
The Timer Event which was created.
Type:
Description:
Updates the arrays of active and pending Timer Events. Called at the start of the frame.
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:
Schedules all active Timer Events for removal at the start of the frame.
Returns:
Description:
- This Clock instance.
Type:
Description:
Removes the given Timer Event, or an array of Timer Events, from this Clock.
The events are removed from all internal lists (active, pending and removal), freeing the event up to be re-used.
Parameters:
| name | type | description |
|---|---|---|
| events | Phaser.Time.TimerEvent | Array.<Phaser.Time.TimerEvent> |
The Timer Event, or an array of Timer Events, to remove from this Clock. |
Returns:
Description:
- This Clock instance.
Type:
Description:
Updates the Clock's internal time and all of its Timer Events.
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. |