findCover: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
mNo edit summary
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


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


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


|gr1= Broken Commands |GROUP1=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional.<br><br>
|game4= tkoh
{{Important | Not implemented in Arma 2 or Arma 3, always returns [[objNull]]}}
|version4= 1.00
|DESCRIPTION=
____________________________________________________________________________________________


| object '''findCover''' [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject] |SYNTAX=
|game5= arma3
|version5= 0.50


|p1= object: [[Object]] |PARAMETER1=
|gr1= Broken Commands
|p2= [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]: [[Array]] |PARAMETER2=
|p3= position: [[Array]] - format [[Position]] |=Paramater 3
|p4= hidePosition: [[Array]] - format [[getHideFrom]]. Position of that which the unit should hide from |PARAMETER4=
|p5= maxDist: [[Number]] |PARAMETER5=
|p6= minDist: [[Number]] (Optional)|PARAMETER6=
|p7= visibilityPosition: [[Array]] - format [[Position]] (Optional) used to select cover that unit can see in that direction from|PARAMETER7=
|p8= ignoreObject: [[Object]] (Optional) Ignore this object in visibility check|PARAMETER8=
| [[Object]] - always [[objNull]]|RETURNVALUE=
____________________________________________________________________________________________
|x1= - |EXAMPLE1=
____________________________________________________________________________________________
| [[getHideFrom]], [[setHideBehind]], [[isHidden]] |SEEALSO=


}}
|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


<h3 style="display:none">Notes</h3>
|p7= ignoreObject: [[Object]] - (Optional) ignore this object in visibility check
<dl class="command_description">
<!-- CONTINUE Notes -->


<dd class="notedate">Posted on July 4, 2015 - 22:01 (UTC)
|r1= [[Object]] - always [[objNull]]
<dt class="note">[[User:SnowSky|SnowSky]]
<dd class="note">An alternative function in Arma 3 might be [[BIS_fnc_findSafePos]]


<!-- DISCONTINUE Notes -->
|x1= <sqf>unit1 findCover [ASLToATL aimPos unit2, 30];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[getHideFrom]] [[setHideBehind]] [[isHidden]]
[[Category:Scripting Commands|FINDCOVER]]
}}
{{GameCategory|arma1|Scripting Commands}}
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{Note
{{GameCategory|arma3|Scripting Commands}}
|user= SnowSky
{{GameCategory|tkoh|Scripting Commands}}
|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"