BIS fnc inTrigger: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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.|= | | 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= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [area, position, returnDistance, includeFloorCeiling] call [[BIS_fnc_inTrigger]] |= | | [area, position, returnDistance, includeFloorCeiling] call [[BIS_fnc_inTrigger]] |SYNTAX= | ||
|p1= area: [[Object]] - trigger, [[String]] - marker, [[Location]] - location or [[Array]] - 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]] - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]]|= | ||
| Line 20: | Line 20: | ||
<br> | <br> | ||
'''or''' | '''or''' | ||
<br>[[Number]] - (when ''returnDistance'' is [[true]]) - distance from closest border: negative distance - from inside, positive distance - from outside |= | <br>[[Number]] - (when ''returnDistance'' is [[true]]) - distance from closest border: negative distance - from inside, positive distance - from outside |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 28: | Line 28: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[createTrigger]], [[createMarker]], [[setTriggerArea]], [[setMarkerSize]], [[triggerArea]], [[markerSize]], [[inArea]], [[inAreaArray]], [[BIS_fnc_getArea]] |= | | [[createTrigger]], [[createMarker]], [[setTriggerArea]], [[setMarkerSize]], [[triggerArea]], [[markerSize]], [[inArea]], [[inAreaArray]], [[BIS_fnc_getArea]] |SEEALSO= | ||
}} | }} | ||
Revision as of 12:29, 7 April 2019
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
- Syntax:
- [area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger
- Parameters:
- area: Object - trigger, String - marker, Location - location or 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 (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
Examples
- Example 1:
_trigger = createTrigger ["EmptyDetector", getPosATL player]; _trigger setTriggerArea [10, 10, 0, false]; _inTrigger = [_trigger, player] call BIS_fnc_inTrigger; //_inTrigger = true
Additional Information
- See also:
- createTriggercreateMarkersetTriggerAreasetMarkerSizetriggerAreamarkerSizeinAreainAreaArrayBIS_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
Notes
Bottom Section
- 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:22 (UTC)
- Larrow
-
Also works with [ pos, radius ]
[ [position, radius], player ] call BIS_fnc_inTrigger