new TimerEvent(timer, delay, tick, repeatCount, loop, callback, callbackContext, arguments)
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. It can call a specific callback, passing in optional parameters.
Parameters:
| 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 | The values to be passed to the callback. |
- Source:
Members
-
args
-
- Source:
Properties:
Name Type Description argumentsarray The values to be passed to the callback.
-
callback
-
- Source:
Properties:
Name Type Description callbackfunction The callback that will be called when the TimerEvent occurs.
-
callbackContext
-
- Source:
Properties:
Name Type Description callbackContextobject The context in which the callback will be called.
-
delay
-
- Source:
Properties:
Name Type Description delaynumber The delay in ms at which this TimerEvent fires.
-
loop
-
- Source:
Properties:
Name Type Description loopboolean True if this TimerEvent loops, otherwise false.
-
repeatCount
-
- Source:
Properties:
Name Type Description repeatCountnumber If this TimerEvent repeats it will do so this many times.
-
tick
-
- Source:
Properties:
Name Type Description ticknumber The tick is the next game clock time that this event will fire at.
-
timer
-
- Source:
Properties:
Name Type Description timerPhaser.Timer The Timer object that this TimerEvent belongs to.