include()

Include library scripts in to your main script...

Syntax

var returnValue = include(file);

Parameters

Parameter Type Mandatory Description Game verison

file

String

The path (relative to your mods folder), file name and extension of the file that should be included.

For example, if you're writing an AI script and want to include a "whatever.js" script that's stored in the same folder as your AI script, you'd specify:

include("multiplay/skirmish/whatever.js");

If you were loading a file from the 'challenges/' folder as part of a Challenge Game, it would be something like:

include("challenges/whatever.js");

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.

Value Type Description Game version

undefined

Undefined

The file was successfully included.

Note: undefined type-coerces to false in an if statement.

3.1 Betas 1 & 2 only

true Boolean The file was successfully included. 3.1 Beta 4 and above

false Boolean There was a problem including the file (most likely path or file not found). 3.1 Beta 1

Example

Including a file

if (include("multiplay/skirmish/foo.js") !== false) {
  // foo.js was loaded successfully
}

Using a variable to define the path...

var path = "multiplay/skirmish/";
 
include(path+"foo.js");
include(path+"bar.js");
include(path+"moo.js");

Availability STABLE

Requires:

Warzone 3.1 Beta 1 and above.
Return value improved in 3.1 Beta 4