name | type | arguments | Default | description |
---|---|---|---|---|
complete | boolean |
Has this event completed yet? |
||
once | boolean |
Is this a once only event? |
||
time | number |
The time (in elapsed ms) at which this event will fire. |
||
repeat | function | <optional> | 0 |
The amount of times this Event has repeated. |
if | function | <optional> | null |
User-land callback which will be called if set. If it returns |
run | function | <optional> | null |
User-land callback which will be called when the Event fires. |
loop | function | <optional> | null |
User-land callback which will be called when the Event loops. |
tween | Phaser.Tweens.Tween | Phaser.Tweens.TweenChain | Phaser.Types.Tweens.TweenBuilderConfig | Phaser.Types.Tweens.TweenChainBuilderConfig | <optional> | null |
Tween configuration object which will be used to create a Tween when the Event fires if set. |
set | object | <optional> | null |
Object containing properties to set on the |
sound | string | object | <optional> | null |
Sound configuration object which will be used to create a Sound when the Event fires if set. |
target | * | <optional> |
The scope ( |
|
event | string | <optional> |
Optional event name to emit when the Event fires. |
|
tweenInstance | Phaser.Tweens.Tween | Phaser.Tweens.TweenChain | <optional> | null |
If this Event is using a Tween to manage its actions, this property will contain a reference to it. |
name | type | arguments | Default | description |
---|---|---|---|---|
at | number | <optional> | 0 |
The time (in ms) at which the Event will fire. The Timeline starts at 0. |
in | number | <optional> |
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 |
|
from | number | <optional> |
Fire this event 'from' milliseconds after the previous event in the Timeline. If set it will override the |
|
run | function | <optional> |
A function which will be called when the Event fires. |
|
loop | function | <optional> |
A function which will be called when the Event loops, this does not get called if the |
|
event | string | <optional> |
Optional string-based event name to emit when the Event fires. The event is emitted from the Timeline instance. |
|
target | * | <optional> |
The scope ( |
|
once | boolean | <optional> | false |
If set, the Event will be removed from the Timeline when it fires. |
stop | boolean | <optional> | false |
If set, the Timeline will stop and enter a complete state when this Event fires, even if there are other events after it. |
tween | Phaser.Tweens.Tween | Phaser.Tweens.TweenChain | Phaser.Types.Tweens.TweenBuilderConfig | Phaser.Types.Tweens.TweenChainBuilderConfig | <optional> |
A Tween or TweenChain configuration object or instance. If set, the Event will create this Tween when it fires. |
|
set | object | <optional> |
A key-value object of properties to set on the |
|
sound | string | object | <optional> |
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: |
name | type | arguments | Default | description |
---|---|---|---|---|
delay | number | <optional> | 0 |
The delay after which the Timer Event should fire, in milliseconds. |
repeat | number | <optional> | 0 |
The total number of times the Timer Event will repeat before finishing. |
loop | boolean | <optional> | false |
|
callback | function | <optional> |
The callback which will be called when the Timer Event fires. |
|
callbackScope | * | <optional> |
The scope ( |
|
args | Array.<*> | <optional> |
Additional arguments to be passed to the |
|
timeScale | number | <optional> | 1 |
The scale of the elapsed time. |
startAt | number | <optional> | 0 |
The initial elapsed time in milliseconds. Useful if you want a long duration with repeat, but for the first loop to fire quickly. |
paused | boolean | <optional> | false |
|