inArea

1.58

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.

⚠

By default all positions given as Array or as objects are treated as PositionAGL. Since 2.20 there is an option to force them to PositionWorld format.

ⓘ

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 (must be PositionAGL if area is checked in 3D)

area: Object, String, Location

• Object - trigger
• String - marker name
• Location - location

Return Value:

Boolean

Alternative Syntax

Syntax:

position inArea [center, a, b, angle, isRectangle, c, usePosWorld]

Parameters:

position: - Object and/or Position to check. Position must be PositionAGL if area is checked in 3D (see note in description)

center: Array or Object - center of the area in format Position2D, Position3D (must be PositionAGL if area is checked in 3D), Object or Group

a: Number - x axis (x / 2)

b: Number - y axis (y / 2)

angle: Number - (Optional since 2.20, Default: 0) rotation angle

isRectangle: Boolean - (Optional since 2.20, Default: false) true if rectangle, false if ellipse

since 1.60

c: Number - (Optional, default -1 (unlimited)) z axis (z / 2)

since 2.20

usePosWorld: Boolean - (Optional, default false) set to true to treat all positions as PositionWorld

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:

inAreaArray triggerArea in inPolygon drawEllipse drawRectangle createTrigger createMarker createLocation

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