Flash CS3 Documentation

ActionScript 2.0 Language Reference > ActionScript language elements > Global Functions > clearInterval function

clearInterval function

clearInterval(intervalID:Number) : Void

Stops the setInterval() call.

Availability: ActionScript 1.0; Flash Player 6

Parameters

intervalID:Number - A numeric (integer) identifier returned from a call to setInterval().

Example

The following example first sets and then clears an interval call:

function callback() {
 trace("interval called: "+getTimer()+" ms.");
}

var intervalID:Number = setInterval(callback, 1000);

You must clear the interval when you have finished using the function. Create a button called clearInt_btn and use the following ActionScript to clear setInterval():

clearInt_btn.onRelease = function(){
 clearInterval( intervalID );
 trace("cleared interval");
};

See also

setInterval function

Flash CS3