Versions Compared

Old Version 7

changes.mady.by.user Aubergine

Saved on

compared with

New Version 8

changes.mady.by.user Aubergine

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

List structures on the current map...

 

Syntax

Code Block
themeRDark
languagejavascript
linenumberstrue
var structures = enumStruct([player[, structTypeOrID[, viewer]]]);

Parameters

ParameterTypeMandatoryDescriptionGame version
playerNumber(error)

The ID number of the player who's structures you want to list.

Defaults to me.

3.1 Beta 1

structTypeOrID

Constant

String

(error)

The type of structure you want to list, usually specified by it's .stattype constant:

Child pages (Children Display)
alltrue
depthall
page.stattype
excerpttrue

You can alternatively specify a structure type by it's ID as defined in structures.txt

If the parameter is not specified, structures of all types will be returned.

3.1 Beta 1
viewerNumber(error)

List structures that a specific player can see (eg. on their sensors), with the player specified by their player ID.

Defaults to ALL_PLAYERS which means "don't filter based on viewer".

3.1 Beta 1

Return value

ValueTypeDescriptionGame version
<array>Array of
Structure objects 		If structures matching the criteria are found, an array of structure objects will be returned.3.1 Beta 1
[]ArrayIf no matching structures are found, you get an empty array.3.1 Beta 1
<error>ErrorIf the player/viewer or structure type specified is incorrect, an error is thrown.3.1 Beta 1

Example

Code Block
themeRDark
languagejavascript
titleGet a list of all my structures...
linenumberstrue
// get a list of all my structures
var myStructures = enumStruct();
Code Block
themeRDark
languagejavascript
titleBuild a list of all enemy structures...
linenumberstrue
var enemyStructs = [];
 
playerData.forEach( function(player) {
  if ( !allianceExistsBetween(me, player) ) { // enemy player
    enemyStructs = enemyStructs.concat(enumStruct(player));
  }
} );
Div
classnotice box ping

In the early beta releases bug bug #3123 prevented scripts from getting lists of scavenger droids and structures. See scavengerPlayer for some ideas as to how to deal with that.

Div
classbox
Availability
Status
colourGreen
title3.1 b1+

Requires:

  • Warzone 3.1 Beta 1 or above
Info

There have been numerous changes to Structure objects across various Warzone versions.

Div
classbox
Contents

Jump to:

Table of Contents
maxLevel5

Div
classbox

See also

Related articles: 

  • Structures – quick reference to all JS API stuff relating to structures
  • enumBlips() – get a list of radar detector blips on the map
  • enumDroid() – get a list of droids on the map
  • enumFeature() – get a list of features on the map
  • enumStructOffWorld() – similar to enumStruct(), but gets a list of structures that aren't on the current map (used in campaigns when doing off-world missions)