enumLabels()

Syntax

var returnValue = enumLabels();

Parameters

The function has no parameters.

Return value

Notes

Map makers can use labels as a way of passing information about their map to scripts. The labels are defined in a "labels.ini" file (example) either manually or by using Flame, the Warzone map editor. The enumLabels() function gets a list of all the label names defined in labels.ini (the bits in square brackets).

Once you have a list of labels, use label() to get the objects associated with them.

Labels are generally only useful in campaigns and challenges, where there are specific scripts running that know what to expect in the maps being used.

For general maps, used in skirmish and multiplayer games, I've posted some ideas about a naming convention for labels that could possibly make labels more widely applicable.

Example

var labels = enumLabel(); // get list of all labels
var labelObjects = [];
 
labels.forEach( function(label) { // get object associated with each label in turn
	labelObjects.push[label];
	labelObjects[label] = label(label);
} );
 
// you now have an object that lists all labels, and their objects...
labelObjects.forEach( function(label) {
	labelObjects[label]; // the object associated with the label
} );