Difference between revisions of "inArea"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|r2= Boolean |RETURNVALUE= " to "|r2= Boolean |RETURNVALUE2=")
m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>")
Line 46: Line 46:
  
 
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|Example1=
 
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|Example1=
|x2= <code>_positionIsInside = _myPosition [[inArea]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]] ];</code>|=
+
|x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]] ];</code>|=
 
|[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]  |SEEALSO=
 
|[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]  |SEEALSO=
  

Revision as of 13:56, 19 March 2020

Introduced with Arma 3 version 1.581.58
Hover & click on the images for descriptions

Description

Description:
Checks whether given position is inside given area. The area is usually a rectangle or an ellipse defined similar to triggerArea format. Hence argument for this command could be a trigger, a marker, a location or an array in format [center, a, b, angle, isRectangle, c]. 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.

Alternatively, use inAreaArray to check multiple positions/objects within area.

Syntax

Syntax:
position inArea trigger
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
trigger: Object - existing trigger
Return Value:
Boolean

Alternative Syntax

Syntax:
position inArea marker
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
marker: String - existing marker
Return Value:
Boolean

Alternative Syntax 2

Syntax:
position inArea location
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
location: Location - existing location
Return Value:
Boolean

Alternative Syntax 3

Syntax:
position inArea [center, a, b, angle, isRectangle, c]
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
[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: Number - rotation angle
isRectangle: Boolean - true if rectangle, false if ellipse
c (Optional): Number - z axis (z / 2). Default: -1 (unlimited) since Arma 3 v1.59.135137
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
Groups:
Uncategorised

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section