Class: Timer

Constructor#

new Timer(timeLeftopt)#

Create a timer object set time passed in

Parameters:

Name	Type	Attributes	Description
`timeLeft`	Number	<optional>	How much time left before the timer elapses in seconds

Source: engineUtilities.js, line 886

Example

CODE

 let a = new Timer;    // creates a timer that is not set
a.set(3);             // sets the timer to 3 seconds
 
let b = new Timer(1); // creates a timer with 1 second left
b.unset();            // unset the timer

Methods#

active() → {Boolean}#

Returns true if set and has not elapsed

Source: engineUtilities.js, line 905

Returns:

Type:: Boolean

elapsed() → {Boolean}#

Returns true if set and elapsed

Source: engineUtilities.js, line 909

Returns:

Type:: Boolean

get() → {Number}#

Get how long since elapsed, returns 0 if not set (returns negative if currently active)

Source: engineUtilities.js, line 913

Returns:

Type:: Number

getPercent() → {Number}#

Get percentage elapsed based on time it was set to, returns 0 if not set

Source: engineUtilities.js, line 917

Returns:

Type:: Number

isSet() → {Boolean}#

Returns true if set

Source: engineUtilities.js, line 901

Returns:

Type:: Boolean

set(timeLeftopt)#

Set the timer with seconds passed in

Parameters:

Name	Type	Attributes	Default	Description
`timeLeft`	Number	<optional>	0	How much time left before the timer is elapsed in seconds

Source: engineUtilities.js, line 894

toString() → {String}#

Returns this timer expressed as a string

Source: engineUtilities.js, line 921

Returns:

Type:: String

unset()#

Unset the timer

Source: engineUtilities.js, line 897

valueOf() → {Number}#

Get how long since elapsed, returns 0 if not set (returns negative if currently active)

Source: engineUtilities.js, line 925

Returns:

Type:: Number

	let a = new Timer; // creates a timer that is not set
	a.set(3); // sets the timer to 3 seconds

	let b = new Timer(1); // creates a timer with 1 second left
	b.unset(); // unset the timer