findCover: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
 
mNo edit summary
 
(77 intermediate revisions by 16 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|FINDCOVER]]
{{RV|type=command
[[Category:Scripting Commands ArmA|FINDCOVER]]


<h2 style="color:#000066">''object '' ''' findCover  '' [position, hidePosition, maxDist]'''''</h2>
|game1= arma1
|version1= 1.00


|game2= arma2
|version2= 1.00


'''Operand types:'''
|game3= arma2oa
|version3= 1.50


'''object''': [[Object]]
|game4= tkoh
   
|version4= 1.00
'''[position, hidePosition, maxDist]''': [[Array]]


'''Type of returned value:'''
|game5= arma3
|version5= 0.50


[[Object]]
|gr1= Broken Commands


'''Compatibility:'''
|descr= Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional.
{{Feature|important|Not implemented in {{arma2}} and later titles (always returns [[objNull]]).}}


Version 2.92 required.
|s1= object [[findCover]] [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]


'''Description:'''
|p1= object: [[Object]]


Returns the object where the object should search for cover.
|p2= position: [[Array]] format [[Position]]
 
|p3= hidePosition: [[Array]] format [[Position#PositionATL]] - [[getHideFrom]]-like position from which the unit should hide
 
|p4= maxDist: [[Number]]
 
|p5= minDist: [[Number]] - (Optional)
 
|p6= visibilityPosition: [[Array]] format [[Position]] - (Optional) used to select cover that unit can see in that direction from
 
|p7= ignoreObject: [[Object]] - (Optional) ignore this object in visibility check
 
|r1= [[Object]] - always [[objNull]]
 
|x1= <sqf>unit1 findCover [ASLToATL aimPos unit2, 30];</sqf>
 
|seealso= [[getHideFrom]] [[setHideBehind]] [[isHidden]]
}}
 
{{Note
|user= SnowSky
|timestamp= 20150704220100
|text= An alternative function in Arma 3 might be [[BIS_fnc_findSafePos]].
}}

Latest revision as of 21:21, 28 September 2023

Logo A1 black.png1.00Logo 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:
Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional.
⚠
Not implemented in Arma 2 and later titles (always returns objNull).
Groups:
Broken Commands

Syntax

Syntax:
object findCover [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]
Parameters:
object: Object
position: Array format Position
hidePosition: Array format Position#PositionATL - getHideFrom-like position from which the unit should hide
maxDist: Number
minDist: Number - (Optional)
visibilityPosition: Array format Position - (Optional) used to select cover that unit can see in that direction from
ignoreObject: Object - (Optional) ignore this object in visibility check
Return Value:
Object - always objNull

Examples

Example 1:
unit1 findCover [ASLToATL aimPos unit2, 30];

Additional Information

See also:
getHideFrom setHideBehind isHidden

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
SnowSky - c
Posted on Jul 04, 2015 - 22:01 (UTC)
An alternative function in Arma 3 might be BIS_fnc_findSafePos.
Retrieved from "https://community.bistudio.com/wiki?title=findCover&oldid=347600"