inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= ____________________________________________________________________________________________ | arma3dev |= Game |1.65|= Game Version (number surrounded by NO SPA...")
 
m (Some wiki formatting)
 
(66 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|=
{{RV|type=command
____________________________________________________________________________________________


| arma3dev |= Game
|game1= arma3
|version1= 1.66


|1.65|= Game Version (number surrounded by NO SPACES)
|gr1= Triggers


|arg= |= Multiplayer Arguments ("local" or "global")
|gr2= Markers


|eff= |= Multiplayer Effects ("local" or "global")
|gr3= Locations


|exec= |= Multiplayer Execution ("server" or empty)
|gr4= Positions
____________________________________________________________________________________________


| Filters given [[Array]] of [[Object]]s or [[Position]]s by given trigger area. |= Description
|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.
____________________________________________________________________________________________


|[input] '''inAreaArray''' trigger |= Syntax
|s1= positions [[inAreaArray]] area


|p1= [[Array]] of [[Object]]s or [[Position]]s - input|= Parameter 1
|p1= positions: [[Array]] of [[Object]]s and/or [[Position]]s


|p2= Trigger  |= Parameter 2
|p2= area: [[Object]], [[Location]] or [[String]] - the defined area:
* [[Object]] - trigger
* [[Location]] - location
* [[String]] - marker name


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


| [[Array]]: Array with objects or positions inside the trigger area |= Return Value
|s2= positions [[inAreaArray]] [center, a, b, angle, isRectangle, c]


|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]] format [[Position#Introduction|Position2D]] or [[Position#PositionAGL|PositionAGL]], {{GVI|arma3|2.14|size= 0.75}} [[Object]] or [[Group]]


|x1= [ [[vehicles]] ] '''inAreaArray''' trigger_1  |= Example 1
|p23= a: [[Number]] - x axis (x / 2)
____________________________________________________________________________________________


|mp= - |= Multiplayer Behaviour
|p24= b: [[Number]] - y axis (y / 2)


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


}}
|p26= isRectangle: [[Boolean]] - (Optional, default [[false]]) [[true]] if rectangle, [[false]] if ellipse
 
|p27= c: [[Number]] - (Optional, default -1: unlimited) z axis (z / 2)
 
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the area
 
|x1= <sqf>vehicles inAreaArray myTrigger;</sqf>
 
|x2= <sqf>allUnits inAreaArray "myMarker";</sqf>
 
|x3= <sqf>allPlayers inAreaArray myLocation;</sqf>


<dl class="command_description">
|x4= <sqf>allDead inAreaArray [[100, 100, 0], 20, 30, 45, false, 10];</sqf>
<!-- BEGIN Note Section -->
<!-- For example:
<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
<dt class="note">'''[[User:User Name|User Name]]'''</dt>
<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
-->
<!-- END Note Section -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[inAreaArrayIndexes]] [[inArea]] [[triggerArea]]
<!-- Appropriate categories go here -->
}}


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= Tankbuster
|timestamp= 20170611213300
|text= The array you send the command can be filtered. For example:
<sqf>vehicles select { _x isKindOf "StaticWeapon" } inAreaArray "myMarker"</sqf>
Will return only the statics inside the given marker.
}}

Latest revision as of 23:54, 12 May 2023

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.