Difference between revisions of "inAreaArray"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatted parameters)
(alt syntax)
Line 13: Line 13:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Filters given [[Array]] of [[Object]]s or [[Position]]s by given trigger area. |= Description
+
| Filters given list of [[Object]]s and/or [[Position]]s in relation to the given area, defined by a trigger, marker, location or array. Returns array of [[Object]]s and/or [[Position]]s from the list that are inside the area |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|[input] '''inAreaArray''' trigger |= Syntax
+
|positions '''inAreaArray''' trigger |= Syntax
  
|p1= input: [[Array]] of  [[Object]]s or [[Position]]s|= Parameter 1
+
|p1= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= Parameter 1
  
|p2= trigger: Trigger  |= Parameter 2
+
|p2= trigger: [[Object]] - trigger with given area |= Parameter 2
  
 +
| [[Array]]: [[Object]]s and/or [[Position]]s inside the trigger area|= Return Value
  
| [[Array]]: Array with objects or positions inside the trigger area |= Return Value
+
|s2=positions '''inAreaArray''' marker |= Syntax
  
 +
|p21= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= Parameter 1
  
 +
|p22= marker: [[String]] - marker with given area |= Parameter 2
 +
 +
|r2= [[Array]]: [[Object]]s and/or [[Position]]s inside the marker area|= Return Value
 +
 +
|s3=positions '''inAreaArray''' location |= Syntax
 +
 +
|p41= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= Parameter 1
 +
 +
|p42= location: [[Location]] - location with given area |= Parameter 2
 +
 +
|r3= [[Array]]: [[Object]]s and/or [[Position]]s inside the location area|= Return Value
 +
 +
|s4= positions '''inAreaArray''' [center, a, b, angle, isRectangle, c]|= Syntax
 +
|p61= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= Parameter 1
 +
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|= Parameter 2
 +
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |= Parameter 2
 +
|p64= a: [[Number]] - x axis (x / 2) |= Parameter 2
 +
|p65= b: [[Number]] - y axis (y / 2) |= Parameter 2
 +
|p66= angle (Optional): [[Number]] - rotation angle. Default: 0  |= Parameter 2
 +
|p67= isRectangle (Optional): [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse. Default: [[false]]|= Parameter 2
 +
|p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited)|= Parameter 2
 +
|r4= [[Array]]: [[Object]]s and/or [[Position]]s inside the area |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= [ [[vehicles]] ] '''inAreaArray''' trigger_1 |= Example 1
+
|x1= <code>[[vehicles]] [[inAreaArray]] trigger_1;</code> |= Example 1
 +
|x2= <code>[[allUnits]] [[inAreaArray]] marker_1;</code> |= Example 2
 +
|x3= <code>[[allPlayers]] [[inAreaArray]] location_1;</code> |= Example 3
 +
|x4= <code>[[allDead]] [[inAreaArray]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]], 10];</code>|=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
 
|mp= - |= Multiplayer Behaviour
 
|mp= - |= Multiplayer Behaviour
  
| |= See Also
+
| [[inArea]], [[triggerArea]] |= See Also
  
 
}}
 
}}
Line 39: Line 66:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- BEGIN Note Section -->
 
<!-- 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 -->
 
<!-- END Note Section -->
 
</dl>
 
</dl>

Revision as of 21:47, 31 October 2016

Introduced with Arma 3 Development Branch version 1.65
  

Click on the images for descriptions

Introduced in

Game:
Arma 3 Development Branch
Version:
1.65

Description

Description:
Filters given list of Objects and/or Positions in relation to the given area, defined by a trigger, marker, location or array. Returns array of Objects and/or Positions from the list that are inside the area

Syntax

Syntax:
positions inAreaArray trigger
Parameters:
positions: Array - Objects and/or Positions to check
trigger: Object - trigger with given area
Return Value:
Array: Objects and/or Positions inside the trigger area

Alternative Syntax

Syntax:
positions inAreaArray marker
Parameters:
positions: Array - Objects and/or Positions to check
marker: String - marker with given area
Return Value:
Array: Objects and/or Positions inside the marker area

Alternative Syntax 2

Syntax:
positions inAreaArray location
Parameters:
positions: Array - Objects and/or Positions to check
location: Location - location with given area
Return Value:
Array: Objects and/or Positions inside the location area

Alternative Syntax 3

Syntax:
positions inAreaArray [center, a, b, angle, isRectangle, c]
Parameters:
positions: Array - Objects and/or Positions to check
[center, a, b, angle, isRectangle, c]: Array
center: Array or Object - center of the area in format Position3D, Position2D, Object or Group
a: Number - x axis (x / 2)
b: Number - y axis (y / 2)
angle (Optional): Number - rotation angle. Default: 0
isRectangle (Optional): Boolean - true if rectangle, false if ellipse. Default: false
c (Optional): Number - z axis (z / 2). Default: -1 (unlimited)
Return Value:
Array: Objects and/or Positions inside the area

Examples

Example 1:
vehicles inAreaArray trigger_1;
Example 2:
allUnits inAreaArray marker_1;
Example 3:
allPlayers inAreaArray location_1;
Example 4:
allDead inAreaArray [[100, 100, 0], 20, 30, 45, false, 10];

Additional Information

Multiplayer:
-
See also:
inAreatriggerArea

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Bottom Section