inArea: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 18: | Line 18: | ||
|s1= position [[inArea]] area | |s1= position [[inArea]] area | ||
|p1= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] (must be [[Position#PositionAGL|PositionAGL]] if is checked in 3D) | |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]] | |p2= area: [[Object]], [[String]], [[Location]] | ||
Line 31: | Line 31: | ||
|p21= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] | |p21= position: [[Object]] or [[Array]] in format [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] | ||
|p22= center: [[Array]] or [[Object]] - center of the area in format [[Position#Introduction|Position2D]], [[Position#Introduction|Position3D]], [[Object]] or [[Group]] | |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) | |p23= a: [[Number]] - x axis (x / 2) |
Revision as of 19: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
- 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