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

setStructureLimits()

Owned by Aubergine
Last updated: Dec 11, 2012Version comment
1 min read
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

ParameterTypeMandatoryDescriptionGame version
structureIdString(tick)The ID of the structure, taken from structures.txt3.1 Beta 1
limitNumber(tick)The maximum number of the structure the player can build.3.1 Beta 1
playerNumber(error)

The player ID to apply the limits to.

Defaults to me.

3.1 Beta 1

Return value

ValueTypeDescriptionGame version
undefinedUndefinedThe function always returns undefined3.1 Beta 1
<error>ErrorInvalid 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();
You must wrap this function with hackNetOff() and hackNetOn() functions. 
The setStructureLimits() function is primarily used when applying
Player Initialisation.
Availability 3.1 B1+

Requires:

  • Warzone 3.1 Beta 1 and above
Contents

Jump to:

See also

Related articles: