inArea: Difference between revisions
Jump to navigation
Jump to search
m (format) |
mNo edit summary |
||
(48 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |game1= arma3 | ||
|1.58 | |version1= 1.58 | ||
| | |gr1= Triggers | ||
| | |gr2= Markers | ||
| | |gr3= Locations | ||
| | |gr4= Positions | ||
| | |descr= Checks whether given position or object is inside given area. 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]] area | ||
| | |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= area: [[Object]], [[String]], [[Location]] | ||
* [[Object]] - trigger | |||
* [[String]] - marker name | |||
* [[Location]] - location | |||
|r1= [[Boolean]] | |||
| | |s2= position [[inArea]] [center, a, b, angle, isRectangle, c] | ||
|p21= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (must be [[Position#PositionAGL|PositionAGL]] if area is checked in 3D) | |||
|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]] | |||
|p23= a: [[Number]] - x axis (x / 2) | |||
|p24= b: [[Number]] - y axis (y / 2) | |||
|p25= angle: [[Number]] - rotation angle | |||
|p26= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse | |||
|p27= c: [[Number]] - (Optional, default -1 (unlimited)) z axis (z / 2) | |||
|p27since= arma3 1.60 | |||
|r2= [[Boolean]] | |||
|x1= <sqf>_playerIsInside = player inArea _myTrigger;</sqf> | |||
|x2= <sqf>_positionIsInside = _myPosition inArea [[100, 100, 0], 20, 30, 45, false];</sqf> | |||
</ | |||
|seealso= [[inAreaArray]] [[triggerArea]] [[in]] [[inPolygon]] [[drawEllipse]] [[drawRectangle]] [[createTrigger]] [[createMarker]] [[createLocation]] | |||
[[ | }} | ||
[[ | |||
[[ |
Latest revision as of 20:41, 20 August 2022
Description
- Description:
- Checks whether given position or object is inside given area. Use inAreaArray to check multiple positions/objects within area.
- Groups:
- TriggersMarkersLocationsPositions
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
- Return Value:
- Boolean
Alternative Syntax
- Syntax:
- position inArea [center, a, b, angle, isRectangle, c]
- Parameters:
- position: Object or Array in format Position2D or Position3D (must be PositionAGL if area is checked in 3D)
- 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 - rotation angle
- isRectangle: Boolean - true if rectangle, false if ellipse
- since
1.60
- c: Number - (Optional, default -1 (unlimited)) z axis (z / 2)
- Return Value:
- Boolean
Examples
- Example 1:
- Example 2:
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