inArea: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
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= ")
m (Some wiki formatting)
Line 12: Line 12:
|gr4= Positions
|gr4= Positions


|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>
|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|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]].}}


|s1= 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 [[Position2D]] or [[Position3D]]


|p2= trigger: [[Object]] - existing trigger
|p2= area: [[Object]], [[String]], [[Location]]
* [[Object]] - trigger
* [[String]] - marker name
* [[Location]] - location


|r1= [[Boolean]]
|r1= [[Boolean]]


|s2= position [[inArea]] marker
|s2= position [[inArea]] [center, a, b, angle, isRectangle, c]


|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]]
|p21= position: [[Object]] or [[Array]] in format [[Position2D]] or [[Position3D]]


|p22= marker: [[String]] - existing marker
|p22= center: [[Array]] or [[Object]] - center of the area in format [[Position2D]], [[Position3D]], [[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]] - rotation angle


|p42= location: [[Location]] - existing location
|p26= isRectangle: [[Boolean]] - [[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]
|r2= [[Boolean]]
 
|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>
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>

Revision as of 13:07, 11 November 2021

Arma 3 logo black.png1.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.
ⓘ
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:
TriggersMarkersLocationsPositions

Syntax

Syntax:
position inArea area
Parameters:
position: Object or Array in format Position2D or Position3D
area: Object, String, Location
Return Value:
Boolean

Alternative Syntax

Syntax:
position inArea [center, a, b, angle, isRectangle, c]
Parameters:
position: Object or Array in format Position2D or Position3D
center: Array or Object - center of the area in format Position2D, Position3D, 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
since Arma 3 logo black.png1.60
c: Number - (Optional, default -1 (unlimited)) z axis (z / 2)
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
Retrieved from "https://community.bistudio.com/wiki?title=inArea&oldid=294057"