Virtjs Class: SerialTimer

new SerialTimer()

A SerialTimer is a synchronous timer device. You can use it to run your emulator synchronously (ie. blocking the main thread). It also has the ability to only run a finite number of ticks before returning, which is quite valuable when debugging engines.

Implements:

Timer

Source:

timers/SerialTimer.js, line 15

Methods

cancelTick(handler)

An engine will call this function if it wants to prevent a scheduled function from being executed.

Parameters:

Name	Type	Description
`handler`	Opaque	The handler returned by Timer#nextTick.

Implements:

Timer#cancelTick

Source:

timers/Timer.js, line 16

nextTick(fn)

An engine will call this function if it wants to schedule a function to be called at the next tick.

Parameters:

Name	Type	Description
`fn`	function	The function that should be registered.

Implements:

Timer#nextTick

Source:

timers/Timer.js, line 6

Returns:

handler

Type: Opaque

one()

Start the emulator. Run a single cycle then exit.

Source:

timers/SerialTimer.js, line 93

start(beginning, ending)

Start the timer.

Parameters:

Name	Type	Argument	Description
`beginning`	function	<optional>	An optional function that will be called before each tick.
`ending`	function	<optional>	An optional function that will be caled after each tick.