A TimerEvent is a single event that is processed by a Phaser.Timer.
It consists of a delay, which is a value in milliseconds after which the event will fire.
When the event fires it calls a specific callback with the specified arguments.
TimerEvents are removed by their parent timer once finished firing or repeating.
Use Phaser.Timer#add, Phaser.Timer#repeat, or Phaser.Timer#loop methods to create a new event.
| Name | Type | Description |
|---|---|---|
timer | Phaser.Timer | The Timer object that this TimerEvent belongs to. |
delay | number | The delay in ms at which this TimerEvent fires. |
tick | number | The tick is the next game clock time that this event will fire at. |
repeatCount | number | If this TimerEvent repeats it will do so this many times. |
loop | boolean | True if this TimerEvent loops, otherwise false. |
callback | function | The callback that will be called when the TimerEvent occurs. |
callbackContext | object | The context in which the callback will be called. |
arguments | Array.<any> | Additional arguments to be passed to the callback. |
| Name | Type | Description |
|---|---|---|
arguments | Array.<any> | Additional arguments to be passed to the callback. |
The callback that will be called when the TimerEvent occurs.
The context in which the callback will be called.
The delay in ms at which this TimerEvent fires.
True if this TimerEvent loops, otherwise false.
A flag that controls if the TimerEvent is pending deletion.
If this TimerEvent repeats it will do so this many times.
The tick is the next game clock time that this event will fire at.
The Timer object that this TimerEvent belongs to.
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/Phaser.TimerEvent.html