BIS fnc findOverwatch: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(40 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Positions


|1.00|= Game version
|descr= Selects a position that provides overwatch onto another position.
____________________________________________________________________________________________


| <pre>/*
|s1= [target, maxDistance, minDistance, minHeightAbove, searchCentre] call [[BIS_fnc_findOverwatch]]
File: fn_findOverwatch.sqf


Description:
|p1= target: [[Position#Introduction|Position3D]] - '''not''' an object
Function which selects a position that provides overwatch
onto another position.


Parameter(s):
|p2= maxDistance: [[Number]] - (Optional, default 500) maximum distance from target in meters
_this select 0: the target position (position)
_this select 1: maximum distance from target in meters (optional)
_this select 2: minimum distance from target in meters (optional)
_this select 3: minimum height in relation to target in meters (optional)
_this select 4: position to start looking from, if different from target pos (optional)
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_findOverwatch]]; --> |= Syntax
|p3= minDistance: [[Number]] - (Optional, default 100) minimum distance from target in meters


|p1= |= Parameter 1
|p4= minHeightAbove: [[Number]] - (Optional, default 50) minimum height in relation to target in meters


| |= Return value
|p5= searchCentre: [[Position#Introduction|Position3D]] - (Optional, default ''target'') position to start looking from, if different from target pos
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Position]] - ''target'' position if no result were found
____________________________________________________________________________________________


| |= See also
|x1= <sqf>[getPosATL enemyTank, 300, 75, 20, getPosATL player] call BIS_fnc_findOverwatch;</sqf>


|seealso= [[BIS_fnc_findSafePos]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Tankbuster
<!-- Note Section BEGIN -->
|timestamp= 20181019214000
|text= Note that this function returns a 2D position, that is, an array containing an x and a y value, but no z (no altitude).
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Tankbuster
 
|timestamp= 20200415135300
<h3 style="display:none">Bottom Section</h3>
|text= Further note that when this function fails to find an overwatch position and returns the ''target'', the x and y components will be exactly the same, but the z might not be.
[[Category:Function Group: Misc|{{uc:findOverwatch}}]]
}}
[[Category:Functions|{{uc:findOverwatch}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:findOverwatch}}]]

Latest revision as of 13:32, 13 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Selects a position that provides overwatch onto another position.
Execution:
call
Groups:
Positions

Syntax

Syntax:
[target, maxDistance, minDistance, minHeightAbove, searchCentre] call BIS_fnc_findOverwatch
Parameters:
target: Position3D - not an object
maxDistance: Number - (Optional, default 500) maximum distance from target in meters
minDistance: Number - (Optional, default 100) minimum distance from target in meters
minHeightAbove: Number - (Optional, default 50) minimum height in relation to target in meters
searchCentre: Position3D - (Optional, default target) position to start looking from, if different from target pos
Return Value:
Position - target position if no result were found

Examples

Example 1:
[getPosATL enemyTank, 300, 75, 20, getPosATL player] call BIS_fnc_findOverwatch;

Additional Information

See also:
BIS_fnc_findSafePos

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
Tankbuster - c
Posted on Oct 19, 2018 - 21:40 (UTC)
Note that this function returns a 2D position, that is, an array containing an x and a y value, but no z (no altitude).
Tankbuster - c
Posted on Apr 15, 2020 - 13:53 (UTC)
Further note that when this function fails to find an overwatch position and returns the target, the x and y components will be exactly the same, but the z might not be.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_findOverwatch&oldid=327931"