BIS_fnc_inTrigger

Description

Detects whether position is within area or calculates distance to the nearest edge of trigger area by using optional params.

Note

Arma 3: Since Arma 3 v1.58 inArea is available for an area check.

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

Returns: - 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

private _trigger = createTrigger ["EmptyDetector", getPosATL player];
_trigger setTriggerArea [10, 10, 0, false];
_inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true

See also

createTrigger · createMarker · setTriggerArea · setMarkerSize · triggerArea · markerSize · inArea · inAreaArray · BIS_fnc_getArea