{"name":"BIS_fnc_inTrigger","operator":null,"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","replaced_by":[],"games":[{"game":"arma2","name":"Arma 2","version":"1.00"},{"game":"arma2oa","name":"Arma 2: Operation Arrowhead","version":"1.50"},{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"arma2","name":"Arma 2","version":"1.00"},"arma3_since":"0.50","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"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","since":null,"effect":null,"exec":null,"params":[{"name":"area","type":"Object, String, Location or Array","optional":false,"default":null,"description":"Object, String, Location or Array\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]]","types":["Object","String","Location","Array"],"since":null,"text":"area: Object, String, Location or Array\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","optional":false,"default":null,"description":"position to check (e.g. player) or Position","types":["Object","Array"],"since":null,"text":"position: Object or Array - position to check (e.g. player) or Position"},{"name":"returnDistance","type":"Boolean","optional":true,"default":"false","description":"true to return distance to nearest edge of trigger area","types":["Boolean"],"since":null,"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","types":["Boolean"],"since":null,"text":"includeFloorCeiling: Boolean - (Optional, default false) to include trigger area floor and ceiling in calculation when calculating distance to nearest edge"}],"returns":{"type":"- Boolean","types":["Boolean"],"description":"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":[{"text":"```sqf\nprivate _trigger = createTrigger [\"EmptyDetector\", getPosATL player];\n_trigger setTriggerArea [10, 10, 0, false];\n_inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true\n```","code":["private _trigger = createTrigger [\"EmptyDetector\", getPosATL player];\n_trigger setTriggerArea [10, 10, 0, false];\n_inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["createTrigger","createMarker","setTriggerArea","setMarkerSize","triggerArea","markerSize","inArea","inAreaArray","BIS_fnc_getArea"],"notes":[],"categories":["Arma 2: Functions","Arma 2: New Functions","Arma 2: Operation Arrowhead: Functions","Arma 3: Functions","Function Group: Object Manipulation","Functions","Introduced with Arma 2 version 1.00","Take On Helicopters: Functions"],"docblock":null,"filled_from_docblock":[]}