setMissionTime()

Syntax

setMissionTime(time);

Parameters

Parameter	Type	Mandatory	Notes	Game Version
time	Number		Defines the amount of time the player has to complete the mission, causing a mission timer to be shown to the user. In Warzone 3.1, the time was specified in 1/10ths of a second (so 1 = 100ms). In Warzone 3.2 and above, the time is specified in seconds (so 1 = 1000ms). Specify a value of -1 to disable the timer.	3.1 Beta 1 Updated in 3.2

Return value

Notes

When the timer is activated, by providing a positive value for the time parameter, a mission timer will be shown in the top-right corner of the screen.

When the mission timer reaches 0, eventMissionTimeout() is triggered and the game will continue unless instructed otherwise within your event handler.

It's common to play audio prompts (using playSound() function) to let the user know how long is left on the timer – a list of audio files can be found in the sidebar to the right... →

Examples

// setting timer of 20 minutes on Warzone 3.2.x
setMissionTime( 20 * 60 ); // 20 x 60 seconds
 
// setting timer of 10 minutes on Warzone 3.1.x
setMissionTime( 20 * 60 * 10 ); // 20 * 60 seconds * 10 1/10ths of a second
 
// clearing the timer on any version of Warzone
setMissionTime(-1);