inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= ([^' ]+)'''([^' ]+)'''([^ ]*) " to "|s$1= $2$3$4 ")
m (Text replacement - "Position3D" to "Position3D")
Line 29: Line 29:
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check


|p22= center: [[Array]] - center of the area in format [[Position3D]], [[Position2D]]
|p22= center: [[Array]] - center of the area in format [[Position#Introduction|Position3D]], [[Position2D]]


|p23= a: [[Number]] - x axis (x / 2)
|p23= a: [[Number]] - x axis (x / 2)

Revision as of 17:55, 5 January 2022

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.
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 [center, a, b, angle, isRectangle, c]
Parameters:
positions: Array - Objects and/or Positions to check
center: Array - center of the area in format Position3D, Position2D
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:
inAreatriggerArea

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
Posted on June 11, 2017 - 21:33 (UTC)
Tankbuster
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