inAreaArray

Description

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

Important

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

Syntax

Syntax 1

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

Returns: Array of Objects and/or Positions

Syntax 2

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: Position2D, PositionAGL, Arma 3 v2.14 Object or Group
• 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)
• usePosWorld: Boolean - (Optional, default false) set to true to treat all positions as PositionWorld (since Arma3 2.20)

Returns: Array of Objects and/or Positions

Syntax 3

since arma3 2.20

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)

Returns: 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];

See also

inAreaArrayIndexes · inArea · triggerArea

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