BIS fnc inTrigger: Difference between revisions

Revision as of 01:50, 10 February 2017

Hover & click on the images for description

Description:: Detects whether position is within area (Since Arma 3 v1.57 an engine solution is available inArea) or calculates distance to the nearest edge of trigger area by using optional params.
Execution:: call
Groups:: Uncategorised

Syntax:: [area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger
Parameters:: area: Object - trigger, String - marker, Location - location or Array - Trigger or area 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 (Optional): Boolean - true to return distance to nearest edge of trigger area. Default: false
: includeFloorCeiling (Optional): Boolean - true to include trigger area floor and ceiling in calculation when calculating distance to nearest edge. Default: false
Return Value:: Boolean - true when position is in area, false if not
or
Number - (when returnDistance is true) - distance from closest border: negative distance - from inside, positive distance - from outside

Example 1:: _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

: 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

Posted on May 6, 2015 - 19:34 (UTC)
Killzone Kid: Works with markers too: inMarker = ["markername", _position] call BIS_fnc_inTrigger;

Posted on October 4, 2015 - 11:14 (UTC)
Larrow: As of ["Arma 3","Arma3",152,132676,"Stable",true] this command is still broken if checking against markers that have axisB larger axisA. To get around this if needed you can create your marker with the largest radius in axisA and rotate your marker by 90degrees.

Posted on October 4, 2015 - 11:22 (UTC)
Larrow: Also works with [ pos, radius ] [ [position, radius], player ] call BIS_fnc_inTrigger

@@ Line 8: / Line 8: @@
 ____________________________________________________________________________________________
-| Detects whether position is within trigger area (Since Arma 3 v1.57 an engine solution is available [[inArea]]) '''or''' calculates distance to the nearest edge of trigger area by using optional params.|= Description
+| Detects whether position is within area (Since Arma 3 v1.57 an engine solution is available [[inArea]]) '''or''' calculates distance to the nearest edge of trigger area by using optional params.|= Description
 ____________________________________________________________________________________________
-| [trigger, position, returnDistance, includeFloorCeiling] call [[BIS_fnc_inTrigger]] |= Syntax
+| [area, position, returnDistance, includeFloorCeiling] call [[BIS_fnc_inTrigger]] |= Syntax
-|p1= trigger: [[Object]] or [[Array]] - [[Triggers|Trigger]] or area in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]|=
+|p1= area: [[Object]] - trigger, [[String]] - marker, [[Location]] - location or [[Array]] - [[Triggers|Trigger]] or area in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]|=
 |p2= position: [[Object]] or [[Array]] - Position to check (e.g. player) or [[Position]] |=
 |p3= returnDistance (Optional): [[Boolean]] - [[true]] to return distance to nearest edge of trigger area. Default: [[false]] |=