inArea: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|= |x2=" to "|Example1= |x2=") |
m (Text replacement - "v1\.59\.[0-9]{6}" to "v1.60") |
||
(17 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | | arma3 | ||
| | |1.58 | ||
|gr1= Triggers | |||
| | |gr2= Markers | ||
| | |gr3= Locations | ||
| | |gr4= Positions | ||
| | | 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. | |||
| | | position [[inArea]] trigger | ||
| | |p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | ||
| | |p2= trigger: [[Object]] - existing trigger | ||
| [[Boolean]] | |||
| | |s2= position [[inArea]] marker | ||
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | |||
|p22= marker: [[String]] - existing marker | |||
|r2= [[Boolean]] | |||
|s3= position [[inArea]] location | |||
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | |||
|p42= location: [[Location]] - existing location | |||
|r3= [[Boolean]] | |||
|s4= position [[inArea]] [center, a, b, angle, isRectangle, c] | |||
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] | |||
|p62= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] | |||
|p63= a: [[Number]] - x axis (x / 2) | |||
|p64= b: [[Number]] - y axis (y / 2) | |||
|p65= angle: [[Number]] - rotation angle | |||
|p66= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse | |||
|p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.60'' | |||
|r4= [[Boolean]] | |||
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code> | |||
< | |x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]]];</code> | ||
</ | |||
|seealso= [[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] | |||
[[ | }} | ||
[[ | |||
[[ |
Revision as of 11:21, 3 April 2021
Description
- Description:
- Description needed
- Groups:
- TriggersMarkersLocationsPositions
Syntax 1
- Syntax:
- Syntax needed
- Parameters:
- position: Array or Object - position in format Position3D, Position2D or Object
- trigger: Object - existing trigger
- Return Value:
- Return value needed
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