inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add AGL/ASL note)
m (Fix)
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.
|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]], positions are [[Position#PositionAGL|PositionAGL]].}}
{{Feature|important|Unlike [[inAreaArrayIndexes]], ''area'' position is [[Position#PositionAGL|PositionAGL]].}}


|s1= positions [[inAreaArray]] area
|s1= positions [[inAreaArray]] area
Line 31: Line 31:
|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


|p22= centr: [[Array]] format [[Position#Introduction|Position2D]] or [[Position#PositionAGL|PositionAGL]], {{GVI|arma3|2.14|size= 0.75}} [[Object]] or [[Group]]
|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)
|p23= a: [[Number]] - x axis (x / 2)

Revision as of 12:59, 14 May 2024

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.
Unlike inAreaArrayIndexes, area position is PositionAGL.
Groups:
TriggersMarkersLocationsPositions

Syntax

Syntax:
positions inAreaArray area
Parameters:
positions: Array of Objects and/or Positions
area: Object, Location or String - the defined area:
Return Value:
Array: Objects and/or Positions inside the trigger area

Alternative Syntax

Syntax:
positions inAreaArray [centre, a, b, angle, isRectangle, c]
Parameters:
positions: Array - Objects and/or Positions to check. Positions must be PositionAGL if area is checked in 3D
centre: Array format Position2D or PositionAGL, Arma 3 logo black.png2.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)
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.