inAreaArray

1.66

Hover & click on the images for description

Description

Description:

Returns given list of Objects and/or Positions that are in the given area, area defined by a trigger, marker, location or array.

⚠

By default all positions given as Array or as objects are treated as PositionAGL. Since 2.20 there is an option to force them to PositionWorld format.

Groups:

TriggersMarkersLocationsPositions

Syntax 1

Syntax:

positions inAreaArray area

Parameters:

positions: Array of Objects and/or Positions

area: Object, Location or String - the defined area:

• Object - trigger
• Location - location
• String - marker name

Return Value:

Array of Objects and/or Positions

Syntax 2

Syntax:

positions inAreaArray [centre, a, b, angle, isRectangle, c, usePosWorld]

Parameters:

positions: Array of Objects and/or Positions - Places to check. Positions must be PositionAGL if area is checked in 3D (see note in description)

centre: 2.14 Object, Group or Position2D or PositionAGL

a: Number - x axis (x / 2)

b: Number - y axis (y / 2)

angle: Number - (Optional, default 0) rotation angle

isRectangle: Boolean - (Optional, default false) true if rectangle, false if ellipse

c: Number - (Optional, default -1: unlimited) z axis (z / 2)

since 2.20

usePosWorld: Boolean - (Optional, default false) set to true to treat all positions as PositionWorld

Return Value:

Array of Objects and/or Positions

2.20

Syntax 3

Syntax:

positions inAreaArray [pos1, pos2, pos3,...]

Parameters:

positions: Array of Objects and/or Positions - Places to check.

posN: Position - polygon vertices in 2d or 3d format (see inPolygon)

Return Value:

Array of Objects and/or Positions

Examples

Example 1:

vehicles inAreaArray myTrigger;

Example 2:

allUnits inAreaArray "myMarker";

Example 3:

allPlayers inAreaArray myLocation;

Example 4:

allDead inAreaArray [[100, 100, 0], 20, 30, 45, false, 10];

Additional Information

See also:

inAreaArrayIndexes inArea triggerArea

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note

Tankbuster - c

Posted on Jun 11, 2017 - 21:33 (UTC)

The array you send the command can be filtered. For example:

vehicles select { _x isKindOf "StaticWeapon" } inAreaArray "myMarker"

Will return only the statics inside the given marker.