SetTimer

<< Click to Display Table of Contents >>

Manual > Control Reference > Common to all controls > Common methods >

SetTimer


 

Start the timer.

 


syntax

SetTimer(

         timerID,

         interval

         [,counter = -1]

         [,delayRecoveryRate = 0]

         [,delayStackTime = 10000]

         )

 


Parameters

 

timerID

 

Type:

Number

 

The timer ID.

 

interval

 

Type:

Number

 

The timer period in ms.

 

counter

 

Type:

Number

 

Number of times the timer will fire. If set to -1, it will fire forever.

 

delayRecoveryRate

 

Type:

Number

 

Specify a value between 0 and 1. Recovers the delay time of the timer period by up to [delayRecoveryRate x 100]%. When 1 is specified, 100% of the delay time is recovered. When 0 is specified, no recovery is performed.

 

delayStackTime

 

Type:

Number

 

Specify in ms. Accumulates the update cycle delay time up to a maximum of [delayStackTime]ms.

 

Return Value

 

 

Type:

Boolean

 

FALSE - Failure. TRUE - Success.

 


hmtoggle_plus1Explanation

 

hmtoggle_plus1Example

 


Supported


Script Action

Browser script

×

Calculation Expression Syntax

 


reference