findCover: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example)
mNo edit summary
 
(69 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional. |= Description
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| HiddenNearObject <nowiki>=</nowiki> unit '''findCover''' [ [[Position]],hidePos,maxDist,minDist,visPos ,ignoreObject ] |= Syntax
|game4= tkoh
|version4= 1.00


|p1= HiddenNearObject : [[Object]] |= Parameter 1
|game5= arma3
|p2= unit: [[Object]] |= Parameter 2
|version5= 0.50
|p3= [[Position]]: ([[Array]])|=Paramater 3
|p4= hidePos: [[Position]] |= Parameter 4
|p5= maxDist: [[Number]] |= Parameter 5
|p6= minDist: [[Number]](Optional)|= Parameter 6
|p7= visPos :[[Position]](Optional)used to select cover that unit can see in that direction|= Parameter 7
|p8= ignoreObject:[[Object]](Optional) Ignore this object in visibility check|= Parameter 8
| [[Object]] |= Return value
____________________________________________________________________________________________
|x1= <pre>temp = hider findCover [getPos hider, getPos player,50] </pre> |= Example 1
____________________________________________________________________________________________
|  |= See also


}}
|gr1= Broken Commands
 
|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]]).}}
 
|s1= object [[findCover]] [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]
 
|p1= object: [[Object]]
 
|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]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>unit1 findCover [ASLToATL aimPos unit2, 30];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[getHideFrom]] [[setHideBehind]] [[isHidden]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|FINDCOVER]]
|user= SnowSky
[[Category:Scripting Commands ArmA|FINDCOVER]]
|timestamp= 20150704220100
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
|text= An alternative function in Arma 3 might be [[BIS_fnc_findSafePos]].
}}

Latest revision as of 21:21, 28 September 2023

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.