findCover: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \{\{GameCategory\|[a-z]+[0-9]?\|Scripting Commands\}\}" to "")
mNo edit summary
 
(5 intermediate revisions by one other user not shown)
Line 18: Line 18:
|gr1= Broken Commands
|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 Arma 2 or Arma 3, always returns [[objNull]]}}
|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]
|s1= object [[findCover]] [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]


|p1= object: [[Object]]
|p1= object: [[Object]]
|p2= [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]: [[Array]]
 
|p3= position: [[Array]] - format [[Position]] |=Paramater 3
|p2= position: [[Array]] format [[Position]]
|p4= hidePosition: [[Array]] - format [[getHideFrom]]. Position of that which the unit should hide from
 
|p5= maxDist: [[Number]]
|p3= hidePosition: [[Array]] format [[Position#PositionATL]] - [[getHideFrom]]-like position from which the unit should hide
|p6= minDist: [[Number]] (Optional)
 
|p7= visibilityPosition: [[Array]] - format [[Position]] (Optional) used to select cover that unit can see in that direction from
|p4= maxDist: [[Number]]
|p8= ignoreObject: [[Object]] (Optional) Ignore this object in visibility check
 
|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]]
|r1= [[Object]] - always [[objNull]]


|x1= -
|x1= <sqf>unit1 findCover [ASLToATL aimPos unit2, 30];</sqf>
|seealso= [[getHideFrom]], [[setHideBehind]], [[isHidden]]
 
|seealso= [[getHideFrom]] [[setHideBehind]] [[isHidden]]
}}
}}


<dl class="command_description">
{{Note
 
|user= SnowSky
<dt><dt>
|timestamp= 20150704220100
<dd class="notedate">Posted on July 4, 2015 - 22:01 (UTC)</dd>
|text= An alternative function in Arma 3 might be [[BIS_fnc_findSafePos]].
<dt class="note">[[User:SnowSky|SnowSky]]</dt>
}}
<dd class="note">An alternative function in Arma 3 might be [[BIS_fnc_findSafePos]]
 
</dl>

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"