Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

Allows you to cancel all timers associated with a specific function.

If there are multiple timers associated with a specific function, it's not possible to cancel one specific timer.

Syntax

removeTimer(functionName);

Parameters

ParameterMandatoryTypeDescription
functionName(tick)String

All timers (including queued function calls) associated with the named function (referenced by it's name in quotes) will be cancelled.

Return value

It's not clear what the value will be, so don't do anything with it.

Example

Setting / removing a timer
function foo() {
  // do stuff
}

setTimer("foo",1000);
 
removeTimer("foo"); // cancel all timers that relate to function "foo"

See also

  • No labels