{"name":"BIS_fnc_inTrigger","title":"BIS fnc inTrigger","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_inTrigger","revid":369527,"updated":"2024-09-15T18:22:20Z","groups":["Object Manipulation"],"status":"ok","games":{"arma2":"1.00","arma2oa":"1.50","tkoh":"1.00","arma3":"0.50"},"since":"arma2 1.00","arma3_since":"0.50","description":"Detects whether position is within area **or** calculates distance to the nearest edge of trigger area by using optional params.\n\n> [!NOTE]\n> **Arma 3:** Since Arma 3 v1.58 inArea is available for an area check.","syntaxes":[{"syntax":"[area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger","params":[{"name":"area","type":"Object, String, Location or Array","description":"Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]","type_expr":"Object | String | Location | Array","text":"area: Object, String, Location or Array\n\n- Object - trigger\n- String - marker\n- Location - location\n- Array - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]"},{"name":"position","type":"Object or Array","description":"position to check (e.g. player) or Position","type_expr":"Object | Array"},{"name":"returnDistance","type":"Boolean","optional":true,"default":"false","description":"true to return distance to nearest edge of trigger area","type_expr":"Boolean","text":"returnDistance: Boolean - (Optional, default false) true to return distance to nearest edge of trigger area"},{"name":"includeFloorCeiling","type":"Boolean","optional":true,"default":"false","description":"to include trigger area floor and ceiling in calculation when calculating distance to nearest edge","type_expr":"Boolean","text":"includeFloorCeiling: Boolean - (Optional, default false) to include trigger area floor and ceiling in calculation when calculating distance to nearest edge"}],"returns":{"types":["Boolean"],"type_expr":"Boolean | Number","description":"- 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","text":"- Boolean - true when position is in area, false if not\n- Number - (when *returnDistance* is true) - distance from closest border: negative distance - from inside, positive distance - from outside"}}],"examples":[{"code":["private _trigger = createTrigger [\"EmptyDetector\", getPosATL player];\n_trigger setTriggerArea [10, 10, 0, false];\n_inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true"]}],"see_also":["createTrigger","createMarker","setTriggerArea","setMarkerSize","triggerArea","markerSize","inArea","inAreaArray","BIS_fnc_getArea"]}