inArea: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
Lou Montana (talk | contribs) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | arma3 |Game name= | ||
|1.58| | |1.58|Game Version= (number surrounded by NO SPACES) | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 18: | Line 18: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s2= position '''inArea''' marker| | |s2= position '''inArea''' marker|SYNTAX2= | ||
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | | |||
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER21= | |||
|p22= marker: [[String]] - existing marker |PARAMETER2= | |p22= marker: [[String]] - existing marker |PARAMETER2= | ||
|r2= [[Boolean]] | | |r2= [[Boolean]] |RETURNVALUE2=____________________________________________________________________________________________ | ||
____________________________________________________________________________________________ | |||
|s3= position '''inArea''' location|SYNTAX= | |s3= position '''inArea''' location|SYNTAX= | ||
| Line 45: | Line 45: | ||
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|= | |x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|Example1= | ||
|x2= <code>_positionIsInside = _myPosition [[inArea]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]] ];</code>|= | |x2= <code>_positionIsInside = _myPosition [[inArea]] <nowiki>[</nowiki>[100, 100, 0], 20, 30, 45, [[false]] ];</code>|= | ||
|[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] |SEEALSO= | |[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] |SEEALSO= | ||
Revision as of 22:51, 3 September 2019
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:
- Uncategorised
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, a, b, angle, isRectangle, c]: Array
- 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.59.135137
- 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