Class: Timer
Defined in: time.ts:14
Represents a timer able to invoke a callback when it triggers.
Constructors
Constructor
new Timer(
ms,callback,loop?):Timer
Defined in: time.ts:44
Parameters
ms
number
The interval of this timer, in milliseconds.
callback
The function to call when this timer triggers.
loop?
boolean = false
Should the callback be invoked continuously every given interval?
Returns
Timer
Accessors
isRunning
Get Signature
get isRunning():
boolean
Defined in: time.ts:35
true if this timer is running, false if it has been stopped or if it's not looping and has already triggered.
Returns
boolean
loops
Get Signature
get loops():
boolean
Defined in: time.ts:27
true if this timer triggers on regular interval, false if it's a one-shot.
Returns
boolean
Methods
restart()
restart():
void
Defined in: time.ts:58
Restarts this timer.
Returns
void
stop()
stop():
void
Defined in: time.ts:72
Stops this timer.
Returns
void