Structure object

Describes a structure (something a truck can build) on the map.

Properties

Inherits all the properties of a Game objects (id, x, y, z, player, selected, name, health, armour, thermal, born, etc.) then adds/overrides the properties listed below.

Property	Type	Description	Game version
type	Constant	STRUCTURE	3.1
status	Constant	Describes construction status of the structure: BEING_BUILT BUILT BEING_DEMOLISHED — This constant is no longer available, but this article provides some guidance on dealing with structure demolition...	3.1
stattype	Constant	What sort of structure is it? RESOURCE_EXTRACTOR OIL_DRUM — Indicates an oil drum (barrel) Feature object... REARM_PAD OIL_RESOURCE — Indicates an oil resource Feature object... RESEARCH_LAB VTOL_FACTORY DEFENSE BUILDING — A Feature object representing a building... REPAIR_FACILITY LASSAT FACTORY COMMAND_CONTROL ARTIFACT — Indicates an artifact Feature object... CYBORG_FACTORY GATE SAT_UPLINK POWER_GEN WALL HQ	3.1
modules	Number, Null	The number of modules built on the structure, or `null` if not applicable. Warzone 3.1 Beta 2 and earlier: The property would not exist for structures that couldn't have modules.	3.1 beta 2 Improved in 3.1 beta 3
group	Number	The group that the structure is in, or `null` if it's not in a group.	3.2
cost	Number	What did the structure cost to build?	3.2
range	Number, Null	The maximum range of the structures' weapon, or `null` if not applicable. It's not clear whether range will be present for sensors.	3.2
isSensor	Boolean	Does this structure have a sensor on it? `true` - yes `false` - no	3.2
isCB	Boolean	Does this structure have a counter battery (CB) turret on it? `true` - yes `false` - no	3.2
isRadarDetector	Boolean	Does this structure have a radar detector on it? `true` - yes `false` - no	3.2
canHitAir	Boolean	Can this structure attack aircraft (VTOLs / transports)? `true` - yes `false` - no	3.2
canHitGround	Boolean	Can this structure attack ground units and other structures? `true` - yes `false` - no	3.2
hasIndirect	Boolean	Does this structure have an indirect fire weapon (such as artillery or archangel missiles)? `true` - yes `false` - no	3.2
weapons	Array of Weapon Status	An array containing basic information about the weapons attached to the droid. Each object in the array contains two properties: .name – the name of the weapon – use getWeaponInfo() if you want to get the associated Weapon Object. .lastFired – the gameTime at which the weapon was last fired	3.2

Availability 3.1 B1+

Introduced in:

Warzone 3.1 Beta 1 and above
Several updates to Base objects since then
Lots of new stuff planned for 3.2

Where to get them?

Lots of API features return structure objects, including...

Functions: enumArea(), enumRange(), enumStruct(), enumStructOffWorld(), label(), objFromId()

Events: eventAttacked(), eventAttackedUnthrottled(), eventDestroyed(), eventDroidBuilt(), eventObjectSeen(), eventObjectTransfer(), eventResearched(), eventStructureBuilt(), eventStructureReady()

Other: If specified when using queue() or setTimer(), the resultant function calls will be passed a structure object. If you bind() to a structure object, the function called when it is destroyed will be passed the structure object.

Working with Structures

Create them:

isStructureAvailable() – find out if a structure of a given type can be built
pickStructLocation() – find a place to build a structure
DORDER_BUILD, DORDER_HELPBUILD, DORDER_LINEBUILD – order a construction droid to build a structure
addStructure() – instantly add a structure to the map

Remove them:

removeStruct(), removeObject() – instantly remove a structure from the map
DORDER_DEMOLISH – tell a construction droid to demolish a structure

List them:

enumStruct(), enumStructOffWorld(), enumArea(), enumRange() – get a list of structures
objFromId() – get a structure object using it's ID

Tell them what to do:

buildDroid() – tell a factory to build a droid
pursueResearch() – tell a lab to research something
activateStructure() – tell a structure to perform its special task (fire laser satellite...)
setAssemblyPoint() – set rally point for factories and repair facilities

Find out what's happening to them:

eventStructureBuilt() – when they are built
eventStructureReady() – when they are ready to perform a special function
structureIdle() – manually check if a structure is idle
eventDroidBuilt() – when a factory finishes building a droid
eventResearched() – when a lab completes its research task
eventObjectSeen() – when a sensor detects something
eventAttacked() – when they are attacked
eventDestroyed() – when a structure is destroyed

Player Initialisation:

baseType – determines what map-placed structures are removed at start of game
enableStructure() – enable a structure to be built
setStructureLimits() – set limits on how many of each structure can be built

Javascript API

Structure object

Properties

Availability 3.1 B1+

Contents

Where to get them?

Working with Structures

See also