BIS fnc inTrigger: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "code>_([a-zA-Z0-9_]+) = " to "code>private _$1 = ")
m (Some wiki formatting)
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.57 [[inArea]] is available for an area check.}}
{{Feature|arma3|Since {{arma3}} v1.57 [[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]]


|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]], [[String]], [[Location]] or [[Array]]
* [[Object]] - trigger
* [[String]] - marker
* [[Location]] - location
* [[Array]] - 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]]
|p2= position: [[Object]] or [[Array]] - Position to check (e.g. [[player]]) or [[Position]]


|p3= returnDistance (Optional): - (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


|p4= includeFloorCeiling: [[Boolean]] - (Optional, default [[false]]) to include trigger area floor and ceiling in calculation when calculating distance to nearest edge
|p4= includeFloorCeiling: [[Boolean]] - (Optional, default [[false]]) to include trigger area floor and ceiling in calculation when calculating distance to nearest edge
Line 32: Line 36:
* [[Number]] - (when ''returnDistance'' is [[true]]) - distance from closest border: negative distance - from inside, positive distance - from outside
* [[Number]] - (when ''returnDistance'' is [[true]]) - distance from closest border: negative distance - from inside, positive distance - from outside


|x1= <code>[[private]] _trigger = [[createTrigger]] ["EmptyDetector", [[getPosATL]] [[player]]];
|x1= <sqf>
_trigger [[setTriggerArea]] [10, 10, 0, false];
private _trigger = createTrigger ["EmptyDetector", getPosATL player];
_inTrigger = [_trigger, [[player]]] [[call]] [[BIS_fnc_inTrigger]]; {{cc|_inTrigger = true}}</code>
_trigger setTriggerArea [10, 10, 0, false];
_inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true
</sqf>


|seealso= [[createTrigger]] [[createMarker]], [[setTriggerArea]], [[setMarkerSize]], [[triggerArea]], [[markerSize]], [[inArea]], [[inAreaArray]], [[BIS_fnc_getArea]]
|seealso= [[createTrigger]] [[createMarker]], [[setTriggerArea]], [[setMarkerSize]], [[triggerArea]], [[markerSize]], [[inArea]], [[inAreaArray]], [[BIS_fnc_getArea]]
}}
}}
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on May 6, 2015 - 19:34 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
Works with markers too:
<code>inMarker = ["markername", _position] [[call]] [[BIS_fnc_inTrigger]];</code>
</dd>
<dt><dt>
<dd class="notedate">Posted on October 4, 2015 - 11:22 (UTC)</dd>
<dt class="note">[[User:Larrow|Larrow]]</dt>
<dd class="note">
Also works with [pos, radius]
<code>[<nowiki/>[position, radius], player] [[call]] [[BIS_fnc_inTrigger]];</code>
</dd>
</dl>

Revision as of 16:51, 30 June 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Detects whether position is within area or calculates distance to the nearest edge of trigger area by using optional params.
Arma 3
Since Arma 3 v1.57 inArea is available for an area check.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[area, position, returnDistance, includeFloorCeiling] call BIS_fnc_inTrigger
Parameters:
area: Object, String, Location or Array
  • Object - trigger
  • String - marker
  • Location - location
  • 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: 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:
  • 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

Examples

Example 1:
Copy
private _trigger = createTrigger ["EmptyDetector", getPosATL player]; _trigger setTriggerArea [10, 10, 0, false]; _inTrigger = [_trigger, player] call BIS_fnc_inTrigger; // _inTrigger = true

Additional Information

See also:
createTrigger createMarkersetTriggerAreasetMarkerSizetriggerAreamarkerSizeinAreainAreaArrayBIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_inTrigger&oldid=323139"