Timer

class Timer

a Timer class to manage timing related function (FPS, Game Tick, Time...)

See: timer the default global timer instance

Summary

Properties from Timer

number	fps = 0
boolean	interpolation = false
number	maxfps = 60
number	tick = 1

Methods from Timer

	clearInterval(intervalID: number)
	clearTimeout(timeoutID: number)
number	getDelta()
number	getTime()
number	setInterval(fn: Function, delay: number, pauseable: boolean, args: unknown)
number	setTimeout(fn: Function, delay: number, pauseable: boolean, args: unknown)

Public Properties

fps timer.js:26

fps: number = 0

number

Last measured fps rate.
This feature is disabled by default, unless the debugPanel is enabled/visible.

interpolation timer.js:44

interpolation: boolean = false

boolean

Enable/disable frame interpolation

See: tick

maxfps timer.js:35

maxfps: number = 60

number

Set the maximum target display frame per second

See: tick

tick timer.js:14

tick: number = 1

number

Last game tick value.
Use this value to scale velocities during frame drops due to slow hardware or when setting an FPS limit. This feature is disabled by default (Enable interpolation to use it).

See: interpolation

Public Methods

clearInterval timer.js:168

clearInterval(intervalID: number) → {}

cancels the timed, repeating action which was previously established by a call to setInterval().

Parameters:
Name	Type	Description
intervalID	number	ID of the interval to be cleared

clearTimeout timer.js:158

clearTimeout(timeoutID: number) → {}

Cancels a timeout previously established by calling setTimeout().

Parameters:
Name	Type	Description
timeoutID	number	ID of the timeout to be cancelled

getDelta timer.js:187

getDelta() → {number}

Return elapsed time in milliseconds since the last update

Returns:
Type	Description
number

getTime timer.js:178

getTime() → {number}

Return the current timestamp in milliseconds
since the game has started or since linux epoch (based on browser support for High Resolution Timer)

Returns:
Type	Description
number

setInterval timer.js:132

setInterval(fn: Function, delay: number, pauseable: boolean, args: unknown) → {number}

Calls a function continously at the specified interval. See setTimeout to call function a single time.

// set a timer to call "myFunction" every 1000ms
me.timer.setInterval(myFunction, 1000);
// set a timer to call "myFunction" every 1000ms (respecting the pause state) and passing param1 and param2
me.timer.setInterval(myFunction, 1000, true, param1, param2);

Parameters:
Name	Type	Attributes	Default	Description
fn	Function			the function to execute
delay	number			the number of milliseconds (thousandths of a second) on how often to execute the function
pauseable	boolean	<optional>	true	respects the pause state of the engine.
args	unknown			optional parameters which are passed through to the function specified by fn once the timer expires.

Returns:
Type	Description
number	a numeric, non-zero value which identifies the timer created by the call to setInterval(), which can be used later with me.timer.clearInterval().

setTimeout timer.js:106

setTimeout(fn: Function, delay: number, pauseable: boolean, args: unknown) → {number}

Calls a function once after a specified delay. See me.timer.setInterval to repeativly call a function.

// set a timer to call "myFunction" after 1000ms
me.timer.setTimeout(myFunction, 1000);
// set a timer to call "myFunction" after 1000ms (respecting the pause state) and passing param1 and param2
me.timer.setTimeout(myFunction, 1000, true, param1, param2);

Parameters:
Name	Type	Attributes	Default	Description
fn	Function			the function you want to execute after delay milliseconds.
delay	number			the number of milliseconds (thousandths of a second) that the function call should be delayed by.
pauseable	boolean	<optional>	true	respects the pause state of the engine.
args	unknown			optional parameters which are passed through to the function specified by fn once the timer expires.

Returns:
Type	Description
number	a positive integer value which identifies the timer created by the call to setTimeout(), which can be used later with me.timer.clearTimeout().