- Source: src/time/typedefs/index.js (Line 7)
Type Definitions
-
TimerEventConfig
-
Type:
- object
- Since: 3.0.0
- Source: src/time/typedefs/TimerEventConfig.js (Line 1)
Properties:
Name Type Argument Default Description delaynumber <optional>
0 The delay after which the Timer Event should fire, in milliseconds.
repeatnumber <optional>
0 The total number of times the Timer Event will repeat before finishing.
loopboolean <optional>
false trueif the Timer Event should repeat indefinitely.callbackfunction <optional>
The callback which will be called when the Timer Event fires.
callbackScope* <optional>
The scope (
thisobject) with which to invoke thecallback.argsArray.<*> <optional>
Additional arguments to be passed to the
callback.timeScalenumber <optional>
1 The scale of the elapsed time.
startAtnumber <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.
pausedboolean <optional>
false trueif the Timer Event should be paused.
