inAreaArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(stable cannot be an odd number)
(syntax wrong type)
Line 43: Line 43:
|p61= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= Parameter 1
|p61= positions: [[Array]] - [[Object]]s and/or [[Position]]s to check|= Parameter 1
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|= Parameter 2
|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
|p63= center: [[Array]] - in format [[Position3D]], [[Position2D]] |= Parameter 2
|p64= a: [[Number]] - x axis (x / 2) |= Parameter 2
|p64= a: [[Number]] - x axis (x / 2) |= Parameter 2
|p65= b: [[Number]] - y axis (y / 2) |= Parameter 2
|p65= b: [[Number]] - y axis (y / 2) |= Parameter 2

Revision as of 20:42, 30 January 2017

Hover & click on the images for description

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
Multiplayer:
-
Groups:
Uncategorised

Syntax 1

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

Syntax 2

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

Syntax 3

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

Syntax 4

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 - in format Position3D, Position2D
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

See also:
inAreatriggerArea

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

Bottom Section