| Excerpt |
|---|
Returns an array of feature objects (like trees and boulders), optionally filtered to a specific looking player... |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
var returnValue = enumFeature([viewer[, featureID]]); |
Parameters
| Parameter | Type | Mandatory | Description | Game version |
|---|---|---|---|---|
| viewer | Number |  | List features that a specific player can see (eg. on their sensors), with the player specified by their player ID. Defaults to me. You can specify -1 which means "don't filter based on viewer" so you get a list of all features on the map. In more recent Warzone versions you can specify ALL_PLAYERS to get a similar effect. | 3.1 Beta 1 |
| featureID | String |
| Optionally filter the list to features of a specific type as defined by their feature ID. You can get a list of feature IDs from the first column in features.txt In Warzone 3.1 RC3 and earlier:
In Warzone
| 3.1 Beta 1 Bug fixed in Warzone |
Return value
| Value | Type | Description | Game version |
|---|---|---|---|
| <array> | Array of Feature object | An array of matching Feature objects | 3.1 Beta 1 |
| [] | Empty Array | If no matching features are found, you get an empty array. | 3.1 Beta 1 |
| <error> | Error | If the viewer does not exist, or you specify an invalid feature ID, an error is thrown. | 3.1 Beta 1 |
Example
| Code Block | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
var visibleFeatures = enumFeature(); |
| |
// get a list of all features I can see
var visibleFeatures = enumFeature();
// get a list of all features on the map
var allFeatures = enumFeature(ALL_PLAYERS, ""); // WZ 3.1
var allFeatures = enumFeature(ALL_PLAYERS); // WZ 3.2 |
| Div | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||
|---|---|---|
| ||
See alsoRelated articles:
|