inArea: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 13: | Line 12: | ||
|gr4= Positions |GROUP4= | |gr4= Positions |GROUP4= | ||
| 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> | | 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> | ||
Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. |DESCRIPTION= | Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. |DESCRIPTION= | ||
| position [[inArea]] trigger |SYNTAX= | | position [[inArea]] trigger |SYNTAX= | ||
| Line 26: | Line 23: | ||
| [[Boolean]] |RETURNVALUE= | | [[Boolean]] |RETURNVALUE= | ||
|s2= position [[inArea]] marker |SYNTAX2= | |s2= position [[inArea]] marker |SYNTAX2= | ||
| Line 35: | Line 31: | ||
|r2= [[Boolean]] |RETURNVALUE2= | |r2= [[Boolean]] |RETURNVALUE2= | ||
|s3= position [[inArea]] location|SYNTAX3= | |s3= position [[inArea]] location|SYNTAX3= | ||
| Line 44: | Line 39: | ||
|r3= [[Boolean]] |RETURNVALUE3= | |r3= [[Boolean]] |RETURNVALUE3= | ||
|s4= position [[inArea]] [center, a, b, angle, isRectangle, c]|SYNTAX4= | |s4= position [[inArea]] [center, a, b, angle, isRectangle, c]|SYNTAX4= | ||
| Line 63: | Line 57: | ||
|r4= [[Boolean]] |RETURNVALUE4= | |r4= [[Boolean]] |RETURNVALUE4= | ||
Revision as of 01:38, 17 January 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.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