Difference between revisions of "inArea"

From Bohemia Interactive Community
Jump to navigation Jump to search
(missing c)
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| A3 |= Game
+
|game1= arma3
|1.58|= Game Version (number surrounded by NO SPACES)
+
|version1= 1.58
____________________________________________________________________________________________
 
  
| 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
+
|gr1= Triggers
____________________________________________________________________________________________
 
  
| position '''inArea''' trigger|= Syntax
+
|gr2= Markers
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
 
|p2= trigger: [[Object]] - existing trigger |= Parameter 2
 
  
| [[Boolean]] |= Return value
+
|gr3= Locations
____________________________________________________________________________________________
 
  
|s2= position '''inArea''' marker|= Syntax
+
|gr4= Positions
|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
+
|descr= 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.
  
|s3= position '''inArea''' location|= Syntax
+
|s1= position [[inArea]] trigger
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
 
|p42= location: [[Location]] - existing location |= Parameter 2
 
  
|r3= [[Boolean]] |= Return value
+
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
____________________________________________________________________________________________
 
  
|s4= position '''inArea''' [center, a, b, angle, isRectangle, c]|= Syntax
+
|p2= trigger: [[Object]] - existing trigger
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= Parameter 1
 
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|= Parameter 2
 
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |= Parameter 2
 
|p64= a: [[Number]] - x axis (x / 2)|= Parameter 2
 
|p65= b: [[Number]] - y axis (y / 2) |= Parameter 2
 
|p66= angle: [[Number]] - rotation angle  |= Parameter 2
 
|p67= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|= Parameter 2
 
|p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|= Parameter 2
 
|r4= [[Boolean]] |= Return value
 
____________________________________________________________________________________________
 
  
 +
|r1= [[Boolean]]
  
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|=
+
|s2= position [[inArea]] marker
|x2= <code>_positionIsInside = _myPosition [[inArea]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]] ];</code>|=
 
|[[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]  |= See also
 
  
}}
+
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
 +
 
 +
|p22= marker: [[String]] - existing marker
 +
 
 +
|r2= [[Boolean]]
 +
 
 +
|s3= position [[inArea]] location
 +
 
 +
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
 +
 
 +
|p42= location: [[Location]] - existing location
 +
 
 +
|r3= [[Boolean]]
 +
 
 +
|s4= position [[inArea]] [center, a, b, angle, isRectangle, c]
 +
 
 +
|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]]
 +
 
 +
|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>
  
<h3 style="display:none">Notes</h3>
+
|x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]]];</code>
<dl class="command_description">
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
|seealso= [[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
+
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 23:14, 19 June 2021

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.

Alternatively, use inAreaArray to check multiple positions/objects within area.
Groups:
TriggersMarkersLocationsPositions

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: 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.60
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

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