Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Returns an array of feature objects (like trees and boulders), optionally filtered to a specific looking player...

 

Syntax

var returnValue = enumFeature([viewer[, featureID]]);

Parameters

ParameterTypeMandatoryDescriptionGame version
viewerNumber(error)

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
featureIDString(error)

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:

  • If no parameters are specified, defaults to listing everything (no filtering).
  • If the viewer parameter is specified, defaults to listing nothing (everything gets filtered out)

In Warzone (question) and above:

  • Defaults to listing all features (no filtering) regardless of whether viewer parameter is specified or not.

3.1 Beta 1

Bug fixed in Warzone (question)

Return value

ValueTypeDescriptionGame version
<array>ArrayAn array of Feature objects3.1 Beta 1
[]ArrayIf no matching features are found, you get an empty array.3.1 Beta 1
<error>ErrorIf the viewer does not exist, or you specify an invalid feature ID, an error is thrown.3.1 Beta 1

Example

Get a list of all my droids
var visibleFeatures = enumFeature();
Availability STABLE

Requires:

  • Warzone 3.1 Beta 1 or above
  • The featureID parameter is optional in Warzone (question) and above
Contents

Jump to:

See also

Related articles:

  • Features – quick reference to all JS API stuff relating to features
  • Feature object – enumFeatures() returns a list of these objects
  • enumBlips() – get a list of radar detector blips on the map
  • enumDroid() – get a list of droids on the map
  • enumStruct() – get a list of structures on the map

 

  • No labels