Overview
| Excerpt |
|---|
Add |
...
most objects within an area of the map to a group. |
...
. |
...
Also, some specific types of droid won't be added to the group:
...
This is really useful because it means you can find the location of a commander/transporter then calculate an area around them, grab all droids in that area and assign them to a commander or embark them on a transport, etc.
Availability
Warzone 3.1 Beta 1 and above.
. |
...
| |||||
groupAddArea(group, x1, y1, x2, y2); |
Parameters
| Parameter | Type | Mandatory | Description | Game version |
|---|---|---|---|---|
| group | Number |  | The unique ID of the group. The ID is the return value of the newGroup() function called when creating the group. | 3.1 Beta 1 |
| x1 | Number | | The x co-ordinate of the top-left corner | 3.1 Beta 1 |
| y1 | Number | | The y co-ordinate of the top-left corner | 3.1 Beta 1 |
| x2 | Number | | The x co-ordinate of the bottom-right corner | 3.1 Beta 1 |
| y2 | Number | | The y co-ordinate of the bottom-right corner | 3.1 Beta 1 |
Return value
| Value | Type | Description | Game version |
|---|---|---|---|
undefined | Undefined | The droids, if any, were added to the group | 3.1 Beta 1 |
| <error> | Error | Either the group doesn't exist, you don't own the group, or you don't own the droid. | 3.1 Beta 1 |
Notes
This function will only add droids owned by the player your script is associated with ('me') to the group. (not sure if this is still true on WZ 3.2)
There are some types of droid which will not be added:
This means that you can locate a commander or transport, and then grab all droids around it and assign them to the commander or embark them on a transport.
Example
| Code Block | |
|---|---|
|
...
...
...
...
...
See Also
...