inArea: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (see also) |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
| 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]]. | | 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. |= | <br><br>Alternatively, use [[inAreaArray]] to check multiple positions/objects within area. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| position '''inArea''' trigger|= | | position '''inArea''' trigger|SYNTAX= | ||
|p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= | |p1= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1= | ||
|p2= trigger: [[Object]] - existing trigger |= | |p2= trigger: [[Object]] - existing trigger |PARAMETER2= | ||
| [[Boolean]] |= | | [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s2= position '''inArea''' marker|= | |s2= position '''inArea''' marker|SYNTAX= | ||
|p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= | |p21= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1= | ||
|p22= marker: [[String]] - existing marker |= | |p22= marker: [[String]] - existing marker |PARAMETER2= | ||
|r2= [[Boolean]] |= | |r2= [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s3= position '''inArea''' location|= | |s3= position '''inArea''' location|SYNTAX= | ||
|p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= | |p41= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1= | ||
|p42= location: [[Location]] - existing location |= | |p42= location: [[Location]] - existing location |PARAMETER2= | ||
|r3= [[Boolean]] |= | |r3= [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s4= position '''inArea''' [center, a, b, angle, isRectangle, c]|= | |s4= position '''inArea''' [center, a, b, angle, isRectangle, c]|SYNTAX= | ||
|p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |= | |p61= position: [[Array]] or [[Object]] - position in format [[Position3D]], [[Position2D]] or [[Object]] |PARAMETER1= | ||
|p62= [center, a, b, angle, isRectangle, c]: [[Array]]|= | |p62= [center, a, b, angle, isRectangle, c]: [[Array]]|PARAMETER2= | ||
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |= | |p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |PARAMETER2= | ||
|p64= a: [[Number]] - x axis (x / 2)|= | |p64= a: [[Number]] - x axis (x / 2)|PARAMETER2= | ||
|p65= b: [[Number]] - y axis (y / 2) |= | |p65= b: [[Number]] - y axis (y / 2) |PARAMETER2= | ||
|p66= angle: [[Number]] - rotation angle |= | |p66= angle: [[Number]] - rotation angle |PARAMETER2= | ||
|p67= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|= | |p67= isRectangle: [[Boolean]] - [[true]] if rectangle, [[false]] if ellipse|PARAMETER2= | ||
|p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|= | |p68= c (Optional): [[Number]] - z axis (z / 2). Default: -1 (unlimited) ''since Arma 3 v1.59.135137''|PARAMETER2= | ||
|r4= [[Boolean]] |= | |r4= [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 47: | Line 47: | ||
|x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|= | |x1= <code>_playerIsInside = [[player]] [[inArea]] _myTrigger;</code>|= | ||
|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]] |= | |[[inAreaArray]], [[triggerArea]], [[in]], [[inPolygon]], [[drawEllipse]], [[drawRectangle]], [[createTrigger]], [[createMarker]], [[createLocation]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:41, 7 April 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
[[Category:Introduced with A3 version 1.58]][[ Category: A3: New Scripting Commands | INAREA]][[ Category: A3: Scripting Commands | INAREA]]