inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <dl class="command_description"> <!-- BEGIN Note Section --> <!-- END Note Section --> </dl>" to "")
m (Text replacement - " *\| *PARAMETER[0-9]{1,3} *= * " to " ")
Line 34: Line 34:
|s2= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c]
|s2= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c]


|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check |PARAMETER21=
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check


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


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


|p24= b: [[Number]] - y axis (y / 2) |PARAMETER24=
|p24= b: [[Number]] - y axis (y / 2)


|p25= angle: [[Number]] - (Optional, default 0) rotation angle |PARAMETER25=
|p25= angle: [[Number]] - (Optional, default 0) rotation angle


|p26= isRectangle: [[Boolean]] - (Optional, default [[false]]) [[true]] if rectangle, [[false]] if ellipse |PARAMETER26=
|p26= isRectangle: [[Boolean]] - (Optional, default [[false]]) [[true]] if rectangle, [[false]] if ellipse


|p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2) |PARAMETER27=
|p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2)


|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area

Revision as of 19:13, 29 January 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
TriggersMarkersLocationsPositions

Syntax

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

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:
See also needed

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