Difference between revisions of "inArea"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3dev |= Game name |1.57|= Game version ______________...")
 
m
Line 35: Line 35:
 
|p62= [center, a, b, angle, isRectangle]: [[Array]]|= Parameter 2
 
|p62= [center, a, b, angle, isRectangle]: [[Array]]|= Parameter 2
 
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |= Parameter 2
 
|p63= center: [[Array]] or [[Object]] - center of the area in format [[Position3D]], [[Position2D]], [[Object]] or [[Group]] |= Parameter 2
|p64= a: [[Number]] - horisontal axis (width / 2)|= Parameter 2
+
|p64= a: [[Number]] - horizontal axis (width / 2)|= Parameter 2
 
|p65= b: [[Number]] - vertical axis (height / 2) |= Parameter 2
 
|p65= b: [[Number]] - vertical axis (height / 2) |= Parameter 2
 
|p66= angle: [[Number]] - rotation angle  |= Parameter 2
 
|p66= angle: [[Number]] - rotation angle  |= Parameter 2

Revision as of 02:42, 7 March 2016

Introduced with Arma 3 Development Branch version 1.571.57
Hover & click on the images for descriptions

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]. 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

Syntax

Syntax:
position inArea trigger
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
trigger: Object - existing trigger
Return Value:
Boolean

Alternative Syntax

Syntax:
position inArea marker
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
marker: String - existing marker
Return Value:
Boolean

Alternative Syntax 2

Syntax:
position inArea location
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
location: Location - existing location
Return Value:
Boolean

Alternative Syntax 3

Syntax:
position inArea [center, a, b, angle, isRectangle]
Parameters:
position: Array or Object - position in format Position3D, Position2D or Object
[center, a, b, angle, isRectangle]: Array
center: Array or Object - center of the area in format Position3D, Position2D, Object or Group
a: Number - horizontal axis (width / 2)
b: Number - vertical axis (height / 2)
angle: Number - rotation angle
isRectangle: Boolean - true if rectangle, false if ellipse
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:
ininPolygondrawEllipsedrawRectanglecreateTriggercreateMarkercreateLocation

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Bottom Section