Difference between revisions of "inArea"

From Bohemia Interactive Community
Jump to navigation Jump to search
(missing c)
m (Text replacement - "|r2= Boolean |RETURNVALUE= " to "|r2= Boolean |RETURNVALUE2=")
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| A3 |= Game
+
| arma3 |Game name=
|1.58|= Game Version (number surrounded by NO SPACES)
+
|1.58|Game Version= (number surrounded by NO SPACES)
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| 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]] |= 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]].
 +
 
 +
<br><br>Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. |DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| position '''inArea''' trigger|= Syntax
+
| position '''inArea''' trigger|SYNTAX=
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
+
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1=
|p2= trigger: [[Object]] - existing trigger |= Parameter 2
+
|p2= trigger: [[Object]] - existing trigger |PARAMETER2=
  
| [[Boolean]] |= Return value
+
| [[Boolean]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|s2= position '''inArea''' marker|= Syntax
+
|s2= position '''inArea''' marker|SYNTAX2=
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
 
|p22= marker: [[String]] - existing marker |= Parameter 2
 
  
|r2= [[Boolean]] |= Return value
+
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER21=
____________________________________________________________________________________________
+
|p22= marker: [[String]] - existing marker |PARAMETER2=
 +
 
 +
|r2= [[Boolean]] |RETURNVALUE2=____________________________________________________________________________________________
  
|s3= position '''inArea''' location|= Syntax
+
|s3= position '''inArea''' location|SYNTAX=
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
+
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1=
|p42= location: [[Location]] - existing location |= Parameter 2
+
|p42= location: [[Location]] - existing location |PARAMETER2=
  
|r3= [[Boolean]] |= Return value
+
|r3= [[Boolean]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|s4= position '''inArea''' [center, a, b, angle, isRectangle, c]|= Syntax
+
|s4= position '''inArea''' [center, a, b, angle, isRectangle, c]|SYNTAX=
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
+
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1=
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|= Parameter 2
+
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|PARAMETER2=
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |= Parameter 2
+
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |PARAMETER2=
|p64= a: [[Number]] - x axis (x / 2)|= Parameter 2
+
|p64= a: [[Number]] - x axis (x / 2)|PARAMETER2=
|p65= b: [[Number]] - y axis (y / 2) |= Parameter 2
+
|p65= b: [[Number]] - y axis (y / 2) |PARAMETER2=
|p66= angle: [[Number]] - rotation angle  |= Parameter 2
+
|p66= angle: [[Number]] - rotation angle  |PARAMETER2=
|p67= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|= Parameter 2
+
|p67= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|PARAMETER2=
|p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|= Parameter 2
+
|p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|PARAMETER2=
|r4= [[Boolean]] |= Return value
+
|r4= [[Boolean]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
  
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|=
+
|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>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]] ];</code>|=
|[[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]  |= See also
+
|[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]  |SEEALSO=
  
 
}}
 
}}

Latest revision as of 21:51, 3 September 2019

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

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Bottom Section