inAreaArray: Difference between revisions

Revision as of 21:18, 1 November 2024

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:: Triggers Markers Locations Positions

Syntax

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: Objects and/or Positions inside the trigger area

Alternative Syntax

Syntax:: positions inAreaArray [centre, a, b, angle, isRectangle, c, usePosWorld]
Parameters:: positions: Array - Objects and/or Positions to check. Positions must be PositionAGL if area is checked in 3D (see note in description)
: centre: Array format Position2D or PositionAGL, 2.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)
since 2.20: usePosWorld: Boolean - (Optional, default false) set to true to treat all positions as PositionWorld
Return Value:: Array: Objects and/or Positions inside the area

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 or on the Forums.
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.

@@ Line 14: / Line 14: @@
 |descr= Returns given list of [[Object]]s and/or [[Position]]s that are in the given area, area defined by a trigger, marker, location or array.
-{{Feature|important|Unlike [[inAreaArrayIndexes]], ''area'' position is [[Position#PositionAGL|PositionAGL]].}}
+{{Feature|important| By default all positions given as [[Array]] or as objects are treated as [[PositionAGL]]. Since {{GVI|arma3|2.20|size= 0.75}} there is an option to force them to [[PositionWorld]] format.}}
 |s1= positions [[inAreaArray]] area
@@ Line 27: / Line 27: @@
 |r1= [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area
-|s2= positions [[inAreaArray]] [centre, a, b, angle, isRectangle, c]
+|s2= positions [[inAreaArray]] [centre, a, b, angle, isRectangle, c, usePosWorld]
-|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check. [[Position]]s must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D
+|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check. [[Position]]s must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D (see note in description)
 |p22= centre: [[Array]] format [[Position#Introduction|Position2D]] or [[Position#PositionAGL|PositionAGL]], {{GVI|arma3|2.14|size= 0.75}} [[Object]] or [[Group]]
@@ Line 42: / Line 42: @@
 |p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2)
+|p28= usePosWorld: [[Boolean]] - (Optional, default [[false]]) set to [[true]] to treat all positions as [[PositionWorld]]
+|p28since= Arma3 2.20
 |r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area