orderDroidStatsLoc()

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

orderDroidStatsLoc()

Early implementation of orderDroidBuild()...

 

Syntax

Deprecated, use orderDroidBuild() instead.

orderDroidStatsLoc(droid, order, structureID, x, y);

Parameters

Parameter

Type

Mandatory

Notes

Game Version

droid

Droid object

The droid that will build the structure(s).

3.1 Alpha ONLY

order

Constant

Indicate the construction mode:

  • DORDER_BUILD – the droid should build a single new structure.

  • DORDER_LINEBUILD – the droid should build a row of structures from it's current location to the target location.

Note: Once construction has started, other droids can help with the building process by issuing DORDER_HELPBUILD via the orderDroidObj() function.

3.1 Alpha ONLY

structureID

String

The ID of the structure you want built. You can find a list of structure ID's in structures.txt or structures.ini (depending on game version).

Note: You cannot use structure type constants, you have to specify the specific structure id.

3.1 Alpha ONLY

x

Number

The x co-ordinate of the top-left corner of the construction site.

Note: Always find suitable co-ordinates by using pickStructLocation() first.

3.1 Alpha ONLY

y

Number

The y co-ordinate of the top-left corner of the construction site.

Note: Always find suitable co-ordinates by using pickStructLocation() first.

3.1 Alpha ONLY

Return values

Value

Type

Notes

Game Version

true

Boolean

The order was successful and the droid will build the structure.

3.1 Alpha ONLY

false

Boolean

There was a problem and the structure will not be built.

3.1 Alpha ONLY

<error>

Error

An error occurred, for example invalid parameters.

3.1 Alpha ONLY

Example

See orderDroidBuild() for examples. The orderDroidStatsLoc() function takes the same parameters (with the exception of the direction parameter) and works the same way as orderDroidBuild().