inArea: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *arma3 * * *\| *([0-2]\.[0-9]{2}) * " to "|game1= arma3 |version1= $1 ") |
Lou Montana (talk | contribs) 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= ") |
||
| Line 15: | Line 15: | ||
Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. | Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. | ||
|s1= | |s1= position [[inArea]] trigger | ||
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | |p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | ||
Revision as of 23:14, 19 June 2021
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