inArea: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.58 | |1.58 | ||
|gr1= Triggers | |gr1= Triggers | ||
|gr2= Markers | |gr2= Markers | ||
|gr3= Locations | |gr3= Locations | ||
|gr4= Positions | |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> | | 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. | Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. | ||
| position [[inArea]] trigger | | 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]] | ||
|p2= trigger: [[Object]] - existing trigger | |p2= trigger: [[Object]] - existing trigger | ||
| [[Boolean]] | | [[Boolean]] | ||
|s2= position [[inArea]] marker | |s2= position [[inArea]] marker | ||
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER21= | |p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER21= | ||
| Line 30: | Line 30: | ||
|p22= marker: [[String]] - existing marker |PARAMETER22= | |p22= marker: [[String]] - existing marker |PARAMETER22= | ||
|r2= [[Boolean]] | |r2= [[Boolean]] | ||
|s3= position [[inArea]] location | |s3= position [[inArea]] location | ||
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER41= | |p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER41= | ||
| Line 38: | Line 38: | ||
|p42= location: [[Location]] - existing location |PARAMETER42= | |p42= location: [[Location]] - existing location |PARAMETER42= | ||
|r3= [[Boolean]] | |r3= [[Boolean]] | ||
|s4= position [[inArea]] [center, a, b, angle, isRectangle, c] | |s4= position [[inArea]] [center, a, b, angle, isRectangle, c] | ||
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER61= | |p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER61= | ||
| Line 56: | Line 56: | ||
|p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|PARAMETER67= | |p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|PARAMETER67= | ||
|r4= [[Boolean]] | |r4= [[Boolean]] | ||
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code> | |x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code> | ||
|x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]]];</code> | |x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]]];</code> | ||
|[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] | |[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] | ||
}} | }} | ||
Revision as of 00:41, 18 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