BIS fnc inTrigger: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|seealso= ([^ ]+)(\]\]|\}\}), *(\[\[|\{\{)" to "|seealso= $1$2 $3") |
Lou Montana (talk | contribs) m (Text replacement - "Since {{arma3}} v1.57" to "Since {{arma3}} v1.58") |
||
(6 intermediate revisions by the same user not shown) | |||
Line 16: | Line 16: | ||
|descr= Detects whether position is within area '''or''' calculates distance to the nearest edge of trigger area by using optional params. | |descr= Detects whether position is within area '''or''' calculates distance to the nearest edge of trigger area by using optional params. | ||
{{Feature|arma3|Since {{arma3}} v1. | {{Feature|arma3|Since {{arma3}} v1.58 [[inArea]] is available for an area check.}} | ||
|s1= [area, position, returnDistance, includeFloorCeiling] call [[BIS_fnc_inTrigger]] | |s1= [area, position, returnDistance, includeFloorCeiling] call [[BIS_fnc_inTrigger]] | ||
Line 26: | Line 26: | ||
* [[Array]] - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]] | * [[Array]] - in format [center, distance] or [center, [a, b, angle, rect]] or [center, [a, b, angle, rect, height]] | ||
|p2= position: [[Object]] or [[Array]] - | |p2= position: [[Object]] or [[Array]] - position to check (e.g. [[player]]) or [[Position]] | ||
|p3= returnDistance: [[Boolean]] - (Optional, default [[false]]) [[true]] to return distance to nearest edge of trigger area | |p3= returnDistance: [[Boolean]] - (Optional, default [[false]]) [[true]] to return distance to nearest edge of trigger area | ||
Line 42: | Line 42: | ||
</sqf> | </sqf> | ||
|seealso= [[createTrigger]] [[createMarker]] [[setTriggerArea]] [[setMarkerSize]] | |seealso= [[createTrigger]] [[createMarker]] [[setTriggerArea]] [[setMarkerSize]] [[triggerArea]] [[markerSize]] [[inArea]] [[inAreaArray]] [[BIS_fnc_getArea]] | ||
}} | }} |
Latest revision as of 19:22, 15 September 2024
Description
- Description:
- Detects whether position is within area or calculates distance to the nearest edge of trigger area by using optional params.
- Execution:
- call
- Groups:
- Object Manipulation
Syntax
- Syntax:
- [area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger
- Parameters:
- area: Object, String, Location or Array
- 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
- Return Value:
Examples
- Example 1:
Additional Information
- See also:
- createTrigger createMarker setTriggerArea setMarkerSize triggerArea markerSize inArea inAreaArray BIS_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