inArea: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3dev |= Game name |1.57|= Game version ______________...") |
mNo edit summary |
||
(17 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | arma3 |Game name= | ||
|1. | |1.58|Game Version (number surrounded by NO SPACES)= | ||
|gr1= Triggers |GROUP1= | |||
|gr2= Markers |GROUP2= | |||
|gr3= Locations |GROUP3= | |||
|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]. 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]] | | 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= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| position | | position [[inArea]] trigger |SYNTAX= | ||
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= | |||
|p2= trigger: [[Object]] - existing trigger |= | |p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1= | ||
|p2= trigger: [[Object]] - existing trigger |PARAMETER2= | |||
| [[Boolean]] |= | | [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s2= position | |s2= position [[inArea]] marker |SYNTAX2= | ||
|r2= [[Boolean]] |= | |p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER21= | ||
|p22= marker: [[String]] - existing marker |PARAMETER22= | |||
|r2= [[Boolean]] |RETURNVALUE2= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s3= position | |s3= position [[inArea]] location|SYNTAX3= | ||
|r3= [[Boolean]] |= | |p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER41= | ||
|p42= location: [[Location]] - existing location |PARAMETER42= | |||
|r3= [[Boolean]] |RETURNVALUE3= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s4= position | |s4= position [[inArea]] [center, a, b, angle, isRectangle, c]|SYNTAX4= | ||
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= | |||
|p62 | |p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER61= | ||
| | |p62= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |PARAMETER62= | ||
| | |||
| | |p63= a: [[Number]] - x axis (x / 2)|PARAMETER63= | ||
| | |||
|r4= [[Boolean]] |= | |p64= b: [[Number]] - y axis (y / 2) |PARAMETER64= | ||
|p65= angle: [[Number]] - rotation angle |PARAMETER65= | |||
|p66= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|PARAMETER66= | |||
|p67= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|PARAMETER67= | |||
|r4= [[Boolean]] |RETURNVALUE4= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|= | |x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|Example1= | ||
|x2= <code>_positionIsInside = _myPosition [[inArea]] <nowiki | |||
|x2= <code>_positionIsInside = _myPosition [[inArea]] [<nowiki/>[100, 100, 0], 20, 30, 45, [[false]]];</code>|Example2= | |||
|[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] |SEEALSO= | |||
}} | }} | ||
Line 54: | Line 78: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
Revision as of 15:36, 21 September 2020
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