import Timer from '@mobilizing/library/js/Mobilizing/time/Timer.js'

public class |source

Timer

Extends:

Component → Timer

A timer is a time manager that gives the possibily to schedule a function every <i>n</i> ms.

Constructor Summary

Public Constructor
public	constructor(params: Object)

Member Summary

Public Members
public	callback: *
public	currentTime: *
public	interval: *
public	running: boolean
public	startTime: *

Method Summary

Public Methods
public	off() Deactivate the component
public	reset() Resets the timer
public	setup() Setup the timer with the current time
public	start() Starts the timer
public	stop() Stop the timer
public	update() Updates the timer's state

Inherited Summary

From class Component
public	active: boolean
public	context: *
public	events: *
public	id: *
public	name: *
private	_nexts: *[]
private	_setupDone: boolean
public	byPass()
public	chain(component: Component) Adds a component to this chained component array
public	getChainedComponents(): Array Returns the array of attached children components
public	off() Deactivate the component
public	on() Activate the component A call to this method calls the setup method if it has not been run yet
public	postUpdate() Run code after the update of all components is run This empty method is usually overriden to perform post-update actions for the component It is called periodically by an internal Mobilizing mechanism
public	preLoad() preLoad the component This empty method is usually overriden to perform preLoad actions for the component.
public	preUpdate() Run code before the update of all components is run This empty method is usually overriden to perform pre-update actions for the component It is called once per component by an internal Mobilizing mechanism
public	prepare() prepare the component This empty method is usually overriden to perform preparation actions for the component, from external process as a server.
public	setup() Set's up the component This empty method is usually overriden to perform setup actions for the component This is where all the initialization (such as adding event listeners)should be done It is called automatically by an internal Mobilizing mechanism and should thus not be called directly
public	update() Update the component This empty method is usually overriden to perform update actions for the component It is called periodically by an internal Mobilizing mechanism

Public Constructors

public constructor(params: Object) source

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
params	Object		Parameters object, given by the constructor.
params.interval	Number		the number of millisecond to wait before the next timer's fire
params.callback	Function		the function to fires every time the timer's interval is passed. Can be an anonymous fonction or not.

Example:

  let myTimer = new Mobilizing.Timer({
"interval": 200,
"callback": function(){
//your code here
}
});
  myTimer.start();

Timer

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(params: Object) source

Override:

Params:

Example:

Public Members

public callback: * source

public currentTime: * source

public interval: * source

public running: boolean source

public startTime: * source

Public Methods

public off() source

Override:

public reset() source

public setup() source

Override:

public start() source

public stop() source

public update() source

Override: