inArea: Difference between revisions

Latest revision as of 18:18, 4 November 2024

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:: Triggers Markers Locations Positions

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.58
-|1.58
 |gr1= Triggers
@@ Line 13: / Line 12: @@
 |gr4= Positions
-| 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]]. <br><br>
+|descr= Checks whether given position or object is inside given area. Use [[inAreaArray]] to check multiple positions/objects within area.
-Alternatively, use [[inAreaArray]] to check multiple positions/objects within area.
+{{Feature|important| By default all positions given as [[Array]] or as objects are treated as [[PositionAGL]]. Since {{GVI|arma3|2.20|size= 0.75}} there is an option to force them to [[PositionWorld]] format.}}
+{{Feature|informative|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]].}}
-| position [[inArea]] trigger
+|s1= position [[inArea]] area
-|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
+|p1= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D)
-|p2= trigger: [[Object]] - existing trigger
+|p2= area: [[Object]], [[String]], [[Location]]
+* [[Object]] - trigger
+* [[String]] - marker name
+* [[Location]] - location
 |r1= [[Boolean]]
-|s2= position [[inArea]] marker
+|s2= position [[inArea]] [center, a, b, angle, isRectangle, c, usePosWorld]
-|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
+|p21= position: - [[Object]] and/or [[Position]] to check. [[Position]] must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D (see note in description)
-|p22= marker: [[String]] - existing marker
+|p22= center: [[Array]] or [[Object]] - center of the area in format [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]] (must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D), [[Object]] or [[Group]]
-|r2= [[Boolean]]
+|p23= a: [[Number]] - x axis (x / 2)
-|s3= position [[inArea]] location
+|p24= b: [[Number]] - y axis (y / 2)
-|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
+|p25= angle: [[Number]] - (Optional since 2.20, Default: 0) rotation angle
-|p42= location: [[Location]] - existing location
+|p26= isRectangle: [[Boolean]] - (Optional since 2.20, Default: false) [[true]] if rectangle, [[false]] if ellipse
-|r3= [[Boolean]]
+|p27= c: [[Number]] - (Optional, default -1 (unlimited)) z axis (z / 2)
+|p27since= arma3 1.60
-|s4= position [[inArea]] [center, a, b, angle, isRectangle, c]
+|p28= usePosWorld: [[Boolean]] - (Optional, default [[false]]) set to [[true]] to treat all positions as [[PositionWorld]]
+|p28since= Arma3 2.20
-|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
+|r2= [[Boolean]]
-|p62= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]]
-|p63= a: [[Number]] - x axis (x / 2)
-|p64= b: [[Number]] - y axis (y / 2)
-|p65= angle: [[Number]] - rotation angle
-|p66= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse
-|p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.60''
-|r4= [[Boolean]]
-|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>
+|x1= <sqf>_playerIsInside = player inArea _myTrigger;</sqf>
-|x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]]];</code>
+|x2= <sqf>_positionIsInside = _myPosition inArea [[100, 100, 0], 20, 30, 45, false];</sqf>
-|seealso= [[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]
+|seealso= [[inAreaArray]] [[triggerArea]] [[in]] [[inPolygon]] [[drawEllipse]] [[drawRectangle]] [[createTrigger]] [[createMarker]] [[createLocation]]
 }}