Overview
| Excerpt |
|---|
Returns a list of all labels defined in the current |
...
map |
...
. |
...
. |
...
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.
Availability
...
. |
...
| |||||
var returnValue = enumLabels(); |
Parameters
The function has no parameters.
Return value
| Value | Type | Description | Game version |
|---|---|---|---|
| <array> | Array | An array of strings, each string being the name of a label defined in the current map's labels.ini file.
| 3.2 |
| [] | Array | If there are no labels defined in the current map (or it has no labels.ini file) an empty array will be returned. | 3.2 |
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
| Code Block | |
|---|---|
|
...
...
...
...
...
...
...