(info) Other great resources: Official JS API docs, Scripting Forum

countStruct()

Owned by Aubergine
Last updated: Dec 10, 2012Version comment
1 min read
Count the number of structures of a given type...

 

Syntax

var numStructs = countStruct(structureID[, player]);

Parameters

ParameterTypeMandatoryNotesGame Version
structureIDString(tick)The ID of the structure type to count.3.1.0
player

Number

Constant

(error)

Which player(s) should the structures be counted for?

You can specify a specific player ID, or one of the following constants:

  • ALLIES — Send a chat message to your allies.
  • ALL_PLAYERS — Send a chat message to all players.
  • ENEMIES — Filter enumeration to enemy objects.

Default: me

3.1.0

Return value

ValueTypeNotesWarzone Version
<number>NumberThe number of structures of the specified type for the specified player(s).3.1.0
<error>ErrorAn error occurred, most likely you used an unsupported structureID or the specified player does not exist.3.1.0

Notes

Does not count off-world structures (use enumStructOffWorld() to list those).

Example

 

 

This function is significantly faster than using enumStruct() and inspecting the .length property of the returned array, because countStruct() is referencing an existing value within the game engine and just returning that value.
Availability 3.1.0+

Requires:

  • Warzone 3.1.0 and above
Contents

Jump to:

See also

Related articles:

Â