Difference between revisions of "inArea"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "Position2D" to "Position2D")
Line 18: Line 18:
 
|s1= position [[inArea]] area
 
|s1= position [[inArea]] area
  
|p1= position: [[Object]] or [[Array]] in format [[Position2D]] or [[Position3D]]
+
|p1= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position3D]]
  
 
|p2= area: [[Object]], [[String]], [[Location]]
 
|p2= area: [[Object]], [[String]], [[Location]]
Line 29: Line 29:
 
|s2= position [[inArea]] [center, a, b, angle, isRectangle, c]
 
|s2= position [[inArea]] [center, a, b, angle, isRectangle, c]
  
|p21= position: [[Object]] or [[Array]] in format [[Position2D]] or [[Position3D]]
+
|p21= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position3D]]
  
|p22= center: [[Array]] or [[Object]] - center of the area in format [[Position2D]], [[Position3D]], [[Object]] or [[Group]]
+
|p22= center: [[Array]] or [[Object]] - center of the area in format [[Position#Introduction|Position2D]], [[Position3D]], [[Object]] or [[Group]]
  
 
|p23= a: [[Number]] - x axis (x / 2)
 
|p23= a: [[Number]] - x axis (x / 2)

Revision as of 17:54, 5 January 2022

Hover & click on the images for description

Description

Description:
Checks whether given position or object is inside given area. Use inAreaArray to check multiple positions/objects within area.
This command also supports hexagon area which can be created from ellipse when both a and b are negative. Hexagon ellipses are also supported by both marker creation and drawEllipse.
Groups:
TriggersMarkersLocationsPositions

Syntax

Syntax:
position inArea area
Parameters:
position: Object or Array in format Position2D or Position3D
area: Object, String, Location
Return Value:
Boolean

Alternative Syntax

Syntax:
position inArea [center, a, b, angle, isRectangle, c]
Parameters:
position: Object or Array in format Position2D or Position3D
center: Array or Object - center of the area in format Position2D, Position3D, Object or Group
a: Number - x axis (x / 2)
b: Number - y axis (y / 2)
angle: Number - rotation angle
isRectangle: Boolean - true if rectangle, false if ellipse
since 25.2px1.60
c: Number - (Optional, default -1 (unlimited)) z axis (z / 2)
Return Value:
Boolean

Examples

Example 1:
_playerIsInside = player inArea _myTrigger;
Example 2:
_positionIsInside = _myPosition inArea [[100, 100, 0], 20, 30, 45, false];

Additional Information

See also:
inAreaArraytriggerAreaininPolygondrawEllipsedrawRectanglecreateTriggercreateMarkercreateLocation

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