Other great resources: Official JS API docs, Scripting Forum
DORDER_CIRCLE
Overview
Instruct a VTOL to circle around a specific location.
Availability
Requires backport.dorder.js.
This isn't a standard feature of the JS API, however it's a constant used by the game engine so it's recognised by Warzone from at least 3.1 Beta 1 onwards.
Example
Attack an enemy object
// circle droid around specific x,y co-ordinates
if (isVTOL(droid)) orderDroidLoc(droid,DORDER_CIRCLE,x,y);
// circle myVTOL around specific gameObject
if (isVTOL(droid)) orderDroidObj(myVTOL,DORDER_CIRCLE,gameObject);Notes
The droid's current order can be determined from it's .order property. For more infomration see Droid object.
This order currently only works with VTOLs so use isVTOL() to check that you've got the right sort of droid.
Your VTOL will fly to the specified location and then start circling it. While moving to the specified location, and then whilst circling it, the VTOL will attack any enemy object it sees.
The circle radius is 12 tiles, and VTOLs will target enemy droids and structures both within that radius and also about 8-12 tiles outside of it. This means that from the centre of the circle, your VTOLs attack radius is about 20 tiles in every direction! When DORDER_CIRCLE is applied to lots of VTOLs at the same time (50+ is most effective), extreme pain will be delivered to the enemy!
See also
DORDER_MOVE – move to a specific location, avoiding conflicts with the enemy
DORDER_PATROL – patrol between two points, works with any droid
DORDER_SCOUT – similar to DORDER_MOVE, but will engage enemies along the way
Droids – quick reference of API features relating to droids
isVTOL() – determine if a droid is a VTOL or not
orderDroidLoc() – order a droid to do something at a specific location
orderDroidObj() – order a droid to do something with a specific object