Droid object

The current order (task) that the droid is doing:

• DORDER_ATTACK — Instruct a droid to attack something.
• DORDER_BUILD — Instruct a construction droid to build a Structure object at a specific location.
• DORDER_CIRCLE — Instruct a VTOL to circle around a specific location.
• DORDER_COMMANDERSUPPORT — Assign an attacker droid to a commander droid so that it will attack whatever the commander droid targets.
• DORDER_DEMOLISH — Instruct a construction droid to demolish one of your structures.
• DORDER_DESTRUCT — Instruct a droid to self-destruct!
• DORDER_DISEMBARK
• DORDER_DROIDREPAIR — Instruct a repair droid to repair a damaged Droid object.
• DORDER_EMBARK
• DORDER_FIRESUPPORT — Assign a attacker droid to a sensor droid so that it can attack whatever the sensor droid targets.
• DORDER_GUARD — Instruct a droid to guard a structure.
• DORDER_HELPBUILD — Instruct a construction droid to help with an existing structure building site.
• DORDER_HOLD — Instruct the droid to hold its current position until instructed otherwise.
• DORDER_LINEBUILD — Indicates that a construction droid is building a line of structures (eg. a long wall).
• DORDER_MOVE — Instruct a droid to move to a new location.
• DORDER_NONE — Indicates that a droid is currently idle.
• DORDER_OBSERVE — Instruct a sensor droid to observe (target) a Droid object, Structure object, or even a Feature object.
• DORDER_PATROL — Instruct a droid to patrol between it's current location and a specified location, attacking any enemies it detects along the way.
• DORDER_REARM — Instruct a VTOL to return to a rearming pad for repairs and rearming.
• DORDER_RECOVER — Order a droid to recover a collectible item such as an oil barrel or artefact (crate).
• DORDER_RECYCLE — Recycle a droid...
• DORDER_REPAIR — Instruct a construction droid to repair a damaged Structure object.
• DORDER_RETREAT — Instruct a droid to retreat to a pre-defined retreat point. Does not retreat to HQ! Read docs before using!
• DORDER_RTB — Instruct a droid to return to your base.
• DORDER_RTR — Instruct a land droid to go to a repair facility for repairs.
• DORDER_RTR_SPECIFIED — Instruct a land droid to go to a specific repair facility for repairs.
• DORDER_SCOUT — Instruct a droid to "scout" to a new location.
• DORDER_STOP — Instruct a droid to stop what it's doing.
• DORDER_TEMP_HOLD — Use DORDER_HOLD instead of DORDER_TEMP_HOLD.
• DORDER_UNUSED — As it's name suggests, this constant is not used.

... Constants were added over time so check each constant's doc page for version info.

3.1 ...

This is the action that the droid is taking to carry out it's current order, as defined in action.cpp.

The constants are not currently exposed to JS API, however you can see a full list here: .action.

Defines what sort of droid it is:

• DROID_ANY — Used to bypass droid type filtering in functions that list or count droids.
• DROID_COMMAND — A commander unit, to which other units can be assigned.
• DROID_CONSTRUCT — A construction truck or a cyborg engineer.
• DROID_CYBORG — A cyborg warrior capable of attacking the enemy.
• DROID_ECM — A droid that has an Electronic Counter Measures (radar jammer) turret.
• DROID_PERSON — A droid that uses "legs" propulsion, for example a civilian or a scavenger machinegunner.
• DROID_REPAIR — A droid that has a repair turret, capable of repairing other droids.
• DROID_SENSOR
• DROID_SUPERTRANSPORTER — A heavy transport unit, capable of airlifting any type of droid (including VTOLs) to some other location on the map...
• DROID_TRANSPORTER — A cyborg transporter (or possibly a super transporter in Warzone 3.1 Beta 4 and earlier), capable of airlifting droids to some other location on the map.
• DROID_WEAPON — A droid capable of attacking other droids.

Number

Null

<not defined> 

Defines what group the droid is in, or returns null if the droid isn't in a group.

If the droid isn't in a group then the group property will return null.

Warzone 3.1 and earlier:

If the droid isn't in a group then the group property won't exist!

3.1

Improved in 3.2

A number representing the droid's experience.

This number can optionally be set using the setDroidExperience() function.

Number

Null 

Defines the weapon capability remaining, as a percentage, for VTOLs.

Warzone 3.2.0:

If the droid isn't a VTOL, the property returns null.

So, 100 = fully armed, 0 = no shots left (the VTOL needs to go to a reaming pad before it can make more attacks).

Warzone 3.1 and earlier:

• If the droid isn't a VTOL this property won't exist!
• The armed property for machinegun and cannon VTOLS was broken in 3.1 branch, but fixed in the 3.2 branch.

3.1→3.2.0

Improved in 3.2

Deprecated in 3.2

Tells you if the droid is a VTOL or not:

• true – yes
• false – no

Does the droid have a radar detector turret?

• true – yes
• false – no

Number

Null

The maximum range of the droids weapon, or null if not applicable.

It's not clear whether range will be present for sensors.

Does the droid have a counter battery (CB) turret?

• true – yes
• false – no

Does the droid have a sensor turret?

• true – yes
• false – no

Can the droid attack aircraft (VTOLS / transports)?

• true – yes
• false – no

Can the droid attack stuff on the ground (tanks, structures, features, etc)?

• true – yes
• false – no

Does this droid have indirect fire capability (eg. artillery)?

• true – yes
• false – no

The ID of the body that the droid is using. Some of the more common bodies are listed below:

• "Body1REC" – Viper
• "Body5REC" – Cobra
• "Body11ABT" – Python
• "Body4ABT" – Bug
• "Body8MBT" – Scorpion
• "Body12SUP" – Mantis
• "Body2SUP" – Leopard
• "Body6SUPP" – Panther
• "Body9REC" – Tiger
• "Body3MBT" – Retaliation
• "Body7ABT" – Retribution
• "Body10MBT" – Vengeance
• "Body13SUP" – Wyvern
• "Body14SUP" – Dragon
• "TransporterBody" – Cyborg Transport
• "SuperTransportBody" – Super Transporter

The ID of the propulsion that the droid is using.

For a list of propulsion types, see: propulsion.txt

The amount of cargoCapacity the droid will consume if loaded in to a transport.

In campaign mode:

• 1 – for all droids, regardless of body size

In other game modes, the cargo size is based on bodySize:

• 1 – LIGHT bodies
• 2 – MEDIUM bodies
• 3 – HEAVY bodies

Number

<not defied>

For transports only, this defines the total capacity of the cargo hold.

For non-transport droids, the property will be undefined, so you should either check the property exists or that the droid is a transport before attempting to read the value.

Number

<not defined>

For transports only, the amount of cargo space remaining.

For non-transport droids, the property will be undefined, so you should either check the property exists or that the droid is a transport before attempting to read the value.

Number

<not defined>

For transports only, this defines the number of droids in the cargo hold.

For non-transport droids, the property will be undefined, so you should either check the property exists or that the droid is a transport before attempting to read the value.

The size of the droid's body, which can be used to determine the number of factory modules required before you can build it:

• LIGHT – All cyborgs, super-cyborgs, scavenger units, Viper, Bug, Leopard, Retaliation
• MEDIUM – Cyborg transport, Cobra, Scorpion, Panther, Retribution
• HEAVY – Super transporter, Python, Mantis, Tiger, Vengeance, Wyvern, Dragon

For more information, see: Working with Factories.

An array containing basic information about the weapons attached to the droid. Each object in the array contains two properties:

• .id – (not sure if this is implemented yet)
• .name – the name of the weapon – use getWeaponInfo() if you want to get the associated Weapon Object.
• .armed – the percentage (0 ≤ armed ≤ 100) of total shots remaining before the weapon needs to re-load or re-arm.
• .lastFired – the gameTime at which the weapon was last fired