setTimer()

Allows you to trigger a function at some point in the future.

Purpose

One set, a timer will keep calling the specified function until you stop the timer using removeTimer().

The function, when called, will be run in the context of the global scope ("this" will be the global scope). So, if you've added properties or methods to the function, they won't be available from within the function when it's run by the timer.

Timers persist the save/load cycle. You can therefore look at Saved game files to see what timers were running at the time when the game was saved.

Syntax

setTimer(functionName, delay[, gameObject]);

Parameters

Parameter

Mandatory

Type

Description

functionName

String

A string containing the name of the function to call.

The function must be defined on the global scope - it cannot be a method of an object.

delay

Number

The amount of time, in milliseconds, to wait before the function is called.

Avoid setting delays less than 110ms, because gameTime only gets incremented once per 100ms.

gameObject

Game object

An optional game object that will be passed in to your function when it gets called. The object will automatically be refreshed with the latest game data.

If the object gets destroyed, the associated timer will be cancelled automatically.

Return value

Value	Type	Description
`undefined`	Undefined	The timer was set.
<error>	Error	Did you forget to specify functionName as a string?

Example

Call function "foo" every second

function foo(gameObj) {
  // do stuff
}
// after 1000ms (1 second), global["foo"](someGameObject) will be called:
setTimer("foo", 1000, someGameObject);

A common mistake is to assume that the setTimer() is the same as Javascript's setTimeout() function. While it serves a similar purpose, it's definitely not the same as the Javascript implementation.

Availability 3.1 B1+

Requires:

Warzone 3.1 Beta 1 or above