inArea

-wrong parameter ("A3") defined!-[[:Category:Introduced with A3 version 1.58|1.58]]

Hover & click on the images for description

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

Groups:

Uncategorised

Syntax 1

Syntax:

position inArea trigger

Parameters:

position: Array or Object - position in format Position3D, Position2D or Object

trigger: Object - existing trigger

Return Value:

Boolean

Syntax 2

Syntax:

position inArea marker

Parameters:

position: Array or Object - position in format Position3D, Position2D or Object

marker: String - existing marker

Return Value:

Boolean

Syntax 3

Syntax:

position inArea location

Parameters:

position: Array or Object - position in format Position3D, Position2D or Object

location: Location - existing location

Return Value:

Boolean

Syntax 4

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:

ininPolygondrawEllipsedrawRectanglecreateTriggercreateMarkercreateLocation

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

[[Category:Introduced with A3 version 1.58]][[ Category: A3: New Scripting Commands | INAREA]][[ Category: A3: Scripting Commands | INAREA]]