inArea

Description

Checks whether given position or object is inside given area. Use inAreaArray to check multiple positions/objects within area.

Important

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

Note

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.

Syntax

Syntax 1

position inArea area

Parameters:

• position: Object or Position2D or Position3D (must be PositionAGL if area is checked in 3D)

• area: Object, String, Location

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

Returns: Boolean

Syntax 2

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
• c: Number - (Optional, default -1 (unlimited)) z axis (z / 2) (since arma3 1.60)
• usePosWorld: Boolean - (Optional, default false) set to true to treat all positions as PositionWorld (since Arma3 2.20)

Returns: Boolean

Examples

Example 1

_playerIsInside = player inArea _myTrigger;

Example 2

_positionIsInside = _myPosition inArea [[100, 100, 0], 20, 30, 45, false];

See also

inAreaArray · triggerArea · in · inPolygon · drawEllipse · drawRectangle · createTrigger · createMarker · createLocation