Difference between revisions of "inArea"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
m (Text replacement - " *\| *PARAMETER[0-9]{1,3} *= * " to " ")
Line 26: Line 26:
 
|s2= position [[inArea]] marker
 
|s2= position [[inArea]] marker
  
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER21=
+
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
  
|p22= marker: [[String]] - existing marker |PARAMETER22=
+
|p22= marker: [[String]] - existing marker
  
 
|r2= [[Boolean]]
 
|r2= [[Boolean]]
Line 34: Line 34:
 
|s3= position [[inArea]] location
 
|s3= position [[inArea]] location
  
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER41=
+
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
  
|p42= location: [[Location]] - existing location |PARAMETER42=
+
|p42= location: [[Location]] - existing location
  
 
|r3= [[Boolean]]
 
|r3= [[Boolean]]
Line 42: Line 42:
 
|s4= position [[inArea]] [center, a, b, angle, isRectangle, c]
 
|s4= position [[inArea]] [center, a, b, angle, isRectangle, c]
  
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER61=
+
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
  
|p62= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |PARAMETER62=
+
|p62= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]]
  
|p63= a: [[Number]] - x axis (x / 2)|PARAMETER63=
+
|p63= a: [[Number]] - x axis (x / 2)
  
|p64= b: [[Number]] - y axis (y / 2) |PARAMETER64=
+
|p64= b: [[Number]] - y axis (y / 2)
  
|p65= angle: [[Number]] - rotation angle |PARAMETER65=
+
|p65= angle: [[Number]] - rotation angle
  
|p66= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|PARAMETER66=
+
|p66= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse
  
|p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|PARAMETER67=
+
|p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''
  
 
|r4= [[Boolean]]
 
|r4= [[Boolean]]

Revision as of 19:10, 29 January 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
TriggersMarkersLocationsPositions

Syntax 1

Syntax:
Syntax needed
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
trigger: Object - existing trigger
Return Value:
Return value needed

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: 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:
See also needed

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