inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>")
Line 49: Line 49:
|x3= <code>allPlayers inAreaArray myLocation;</code>
|x3= <code>allPlayers inAreaArray myLocation;</code>


|x4= <code>allDead inAreaArray [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>
|x4= <code>allDead inAreaArray [<nowiki/>[100, 100, 0], 20, 30, 45, false, 10];</code>


|seealso= [[inArea]] [[triggerArea]]
|seealso= [[inArea]] [[triggerArea]]
Line 61: Line 61:
<dd class="note">
<dd class="note">
The array you send the command can be filtered. For example:
The array you send the command can be filtered. For example:
<code>vehicles select { _x [[isKindOf]] "StaticWeapon" } [[inAreaArray]] "myMarker"</code>
<code>vehicles select { _x isKindOf "StaticWeapon" } [[inAreaArray]] "myMarker"</code>
Will return only the statics inside the given marker
Will return only the statics inside the given marker
</dd>
</dd>


</dl>
</dl>

Revision as of 11:10, 12 May 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:
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
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