include()

Overview

Availability

Warzone 3.1 Beta 1 and above. Improved in 3.1 Beta 4.

Syntax

var returnValue = include(filename);

Parameters

Parameter	Type	Mandatory	Description	Game verison
filename	String		The name of the file to include. If it's in a different folder, include the relative path?	3.1 Beta 1

Return value

In version 3.1 Beta 2 and earlier, this function would return undefined if the file was successfully loaded, however undefined is treated as false in an if statement, and false is the return value used to indicate the file failing to load!

As of 3.1 Beta 4 and above, the function will return true if the file was included, which is far easier to work with. However, if your script supports older versions of the game, then you need to be careful with earlier versions returning undefined instead of true.

 The include() function traps any uncaught errors and writes them to the log files, then returns false. So you don't need to wrap this function in a "try ... catch" clause.

Example

include("foo.js"); // include foo.js