Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Set limits on how many structures of a specific type a player can build.

 

Syntax

(warning) You must wrap this function call with hackNetOff() and hackNetOn() functions.

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();
The setStructureLimits() function is primarily used when applying
Player Initialisation.

Contents

Assimilate:

Availability

This function is compatible with:

  • Warzone 3.1 Beta 1 and above

See also

The following JS API features relate to this function:

  • applyLimitSet() – must be called to make setStructureLimits() take effect
  • isStructureAvailable() – check if you can build the specified structure (eg. not reached structure limits)

 

  • No labels