inAreaArray: Difference between revisions

Latest revision as of 22:37, 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 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: Objects and/or Positions inside the trigger area

Syntax 2

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

2.20

Syntax 3

Syntax:: positions inAreaArray [pos1, pos2, pos3,...]
Parameters:: positions: Array - Objects and/or Positions to check.
: posN: Position - polygon vertices in 2d or 3d format (see inPolygon)
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 1: / Line 1: @@
 {{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.66
-|1.66
-|arg=
-|eff=
-|serverExec=
 |gr1= Triggers
@@ Line 19: / Line 12: @@
 |gr4= Positions
-| 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.
+|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.
-| positions '''inAreaArray''' area
+{{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
 |p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s
@@ Line 30: / Line 25: @@
 * [[String]] - marker name
-| [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area
+|r1= [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area
-|s2= positions '''inAreaArray''' [center, 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
+|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= center: [[Array]] - center of the area in format [[Position3D]], [[Position2D]]
+|p22= centre: [[Array]] format [[Position#Introduction|Position2D]] or [[Position#PositionAGL|PositionAGL]], {{GVI|arma3|2.14|size= 0.75}} [[Object]] or [[Group]]
 |p23= a: [[Number]] - x axis (x / 2)
@@ Line 47: / 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
-|x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code>
+|s3= positions [[inAreaArray]] [pos1, pos2, pos3,...]
+|s3since= Arma3 2.20
+|p41= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check.
+|p42 = posN: [[Position]] - polygon vertices in 2d or 3d format (see [[inPolygon]])
+|r3= [[Array]]: [[Object]]s and/or [[Position]]s inside the area
+|x1= <sqf>vehicles inAreaArray myTrigger;</sqf>
-|x2= <code>[[allUnits]] [[inAreaArray]] "myMarker";</code>
+|x2= <sqf>allUnits inAreaArray "myMarker";</sqf>
-|x3= <code>[[allPlayers]] [[inAreaArray]] myLocation;</code>
+|x3= <sqf>allPlayers inAreaArray myLocation;</sqf>
-|x4= <code>[[allDead]] [[inAreaArray]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>
+|x4= <sqf>allDead inAreaArray [[100, 100, 0], 20, 30, 45, false, 10];</sqf>
-| [[inArea]], [[triggerArea]]
+|seealso= [[inAreaArrayIndexes]] [[inArea]] [[triggerArea]]
 }}
+{{Note
-<dl class="command_description">
+|user= Tankbuster
-<dd class="notedate">Posted on June 11, 2017 - 21:33 (UTC)</dd>
+|timestamp= 20170611213300
-<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
+|text= The array you send the command can be filtered. For example:
-<dd class="note">
+<sqf>vehicles select { _x isKindOf "StaticWeapon" } inAreaArray "myMarker"</sqf>
-The array you send the command can be filtered. For example:
+Will return only the statics inside the given marker.
-<code>[[vehicles]] [[select]] { _x [[isKindOf]] "StaticWeapon" } [[inAreaArray]] "myMarker"</code>
+}}
-Will return only the statics inside the given marker
-</dd>
-</dl>