inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *s([0-9]) *= ([^ ]+)? ?'''([a-zA-Z0-9_]+)''' ?([^ ]+)? " to " |s$1= $2 $3 $4 ")
m (Some wiki formatting)
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma3
|game1= arma3
 
|version1= 1.66
|1.66


|gr1= Triggers
|gr1= Triggers
Line 13: Line 12:
|gr4= Positions
|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
|s1= positions [[inAreaArray]] area


|p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s
|p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s
Line 24: Line 23:
* [[String]] - marker name
* [[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]]  [center, a, b, angle, isRectangle, c]


|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


|p22= center: [[Array]] - center of the area in format [[Position3D]], [[Position2D]]
|p22= center: [[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)
Line 44: Line 43:
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area


|x1= <code>[[vehicles]] [[inAreaArray]] myTrigger;</code>
|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>


|seealso= [[inArea]], [[triggerArea]]
|seealso= [[inAreaArrayIndexes]] [[inArea]] [[triggerArea]]
}}
}}


<dl class="command_description">
{{Note
 
|user= Tankbuster
<dt></dt>
|timestamp= 20170611213300
<dd class="notedate">Posted on June 11, 2017 - 21:33 (UTC)</dd>
|text= The array you send the command can be filtered. For example:
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<sqf>vehicles select { _x isKindOf "StaticWeapon" } inAreaArray "myMarker"</sqf>
<dd class="note">
Will return only the statics inside the given marker.
The array you send the command can be filtered. For example:
}}
<code>[[vehicles]] [[select]] { _x [[isKindOf]] "StaticWeapon" } [[inAreaArray]] "myMarker"</code>
Will return only the statics inside the given marker
</dd>
</dl>

Latest revision as of 23:54, 12 May 2023

Arma 3 logo black.png1.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.
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. Positions must be PositionAGL if area is checked in 3D
center: 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.
Retrieved from "https://community.bistudio.com/wiki?title=inAreaArray&oldid=340869"