From Bohemia Interactive Community
Hover & click on the images for description
Description
- Description:
- Detects whether position is within area or calculates distance to the nearest edge of trigger area by using optional params.
Since Arma 3 v1.58
inArea is available for an area check.
- Execution:
- call
- Groups:
- Object Manipulation
Syntax
- Syntax:
- [area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger
- Parameters:
- area: Object, String, Location or Array
- Object - trigger
- String - marker
- Location - location
- Array - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]
- position: Object or Array - position to check (e.g. player) or Position
- returnDistance: Boolean - (Optional, default false) true to return distance to nearest edge of trigger area
- includeFloorCeiling: Boolean - (Optional, default false) to include trigger area floor and ceiling in calculation when calculating distance to nearest edge
- Return Value:
-
- Boolean - true when position is in area, false if not
- Number - (when returnDistance is true) - distance from closest border: negative distance - from inside, positive distance - from outside
Examples
- Example 1:
Additional Information
- See also:
- createTrigger createMarker setTriggerArea setMarkerSize triggerArea markerSize inArea inAreaArray BIS_fnc_getArea
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
Since Arma 3 v1.58 inArea is available for an area check.