getStructureLimit()

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

getStructureLimit()

Determine the structure limits for a given type of structure...

 

Syntax

var limit = getStructureLimit(structureID[, player]);

Parameters

Parameter

Type

Mandatory

Notes

Game Version

Parameter

Type

Mandatory

Notes

Game Version

structureID

String

The ID of the structure to check.

3.1.0

player

Number

The ID of the player to determine limits for.

Default: me

3.1.0

Return values

Value

Type

Notes

Game Version

Value

Type

Notes

Game Version

<limit>

Number

The limit set for the structure.

3.1.0

<error>

Error

Invalid parameters specified or structure/player not found.

3.1.0

Example