Repository

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

Member Summary

Public Members
public
public
public
public
public

Method Summary

Public Methods
public

off()

Deactivate the component

public

Resets the timer

public

Setup the timer with the current time

public

Starts the timer

public

stop()

Stop the timer

public

Updates the timer's state

Inherited Summary

From class Component
public
public
public

events: *

public

id: *

public

name: *

private

_nexts: *[]

private
public
public

chain(component: Component)

Adds a component to this chained component array

public

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

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 the component This empty method is usually overriden to perform setup actions for the component.

public

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

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 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:

NameTypeAttributeDescription
paramsObject

Parameters object, given by the constructor.

params.intervalNumber

the number of millisecond to wait before the next timer's fire

params.callbackFunction

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();

Public Members

public callback: * source

public currentTime: * source

public interval: * source

public running: boolean source

public startTime: * source

Public Methods

public off() source

Deactivate the component

Override:

Component#off

public reset() source

Resets the timer

public setup() source

Setup the timer with the current time

Override:

Component#setup

public start() source

Starts the timer

public stop() source

Stop the timer

public update() source

Updates the timer's state

Override:

Component#update