Other great resources: Official JS API docs, Scripting Forum
setStructureLimits()
Set limits on how many structures of a specific type a player can build.
Syntax
hackNetOff();
setStructureLimits(structure,limit[,player]);
applyLimitSet(); // need to call this to apply the limits
hackNetOn();Parameters
Parameter | Type | Mandatory | Description | Game version |
|---|---|---|---|---|
structureId | String | The ID of the structure, taken from structures.txt | 3.1 Beta 1 | |
limit | Number | The maximum number of the structure the player can build. | 3.1 Beta 1 | |
player | Number | The player ID to apply the limits to. Defaults to me. | 3.1 Beta 1 |
Return value
Value | Type | Description | Game version |
|---|---|---|---|
| Undefined | The function always returns | 3.1 Beta 1 |
<error> | Error | Invalid structure or the limit value was too high (too many buildings) | 3.1 Beta 1 |
Example
hackNetOff();
for (var playnum=0; playnum<maxPlayers; playnum++) {
setStructureLimits("A0LightFactory", 5, playnum);
setStructureLimits("A0PowerGenerator", 8, playnum);
setStructureLimits("A0ResearchFacility", 5, playnum);
setStructureLimits("A0CommandCentre", 1, playnum);
setStructureLimits("A0ComDroidControl", 1, playnum);
setStructureLimits("A0CyborgFactory", 5, playnum);
setStructureLimits("A0VTolFactory1", 5, playnum);
}
applyLimitSet();
hackNetOn();