Difference between revisions of "findCover"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added info from ofpec's comref)
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
 
(32 intermediate revisions by 17 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma |= Game name
+
| arma |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional. |= Description
+
| Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional.<br><br>
 +
{{Important | Not implemented in Arma 2 or Arma 3, always returns [[objNull]]}}
 +
|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| HiddenNearObject <nowiki>=</nowiki> unit '''findCover''' [ [[Position]], hidePosition, maxDist,minDist,visibilityPosition ,ignoreObject ] |= Syntax
+
| object '''findCover''' [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject] |SYNTAX=
  
|p1= HiddenNearObject : [[Object]] |= Parameter 1
+
|p1= object: [[Object]] |PARAMETER1=
|p2= unit: [[Object]] |= Parameter 2
+
|p2= [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]: [[Array]] |PARAMETER2=
|p3= [[Position]]: ([[Array]])|=Paramater 3
+
|p3= position: [[Array]] - format [[Position]] |=Paramater 3
|p4= hidePosition: [[Position]] |= Parameter 4
+
|p4= hidePosition: [[Array]] - format [[getHideFrom]]. Position of that which the unit should hide from |PARAMETER4=
|p5= maxDist: [[Number]] |= Parameter 5
+
|p5= maxDist: [[Number]] |PARAMETER5=
|p6= minDist: [[Number]](Optional)|= Parameter 6
+
|p6= minDist: [[Number]] (Optional)|PARAMETER6=
|p7= visibilityPosition:[[Position]](Optional)used to select cover that unit can see in that direction|= Parameter 7
+
|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|= Parameter 8
+
|p8= ignoreObject: [[Object]] (Optional) Ignore this object in visibility check|PARAMETER8=
| [[Object]] |= Return value
+
| [[Object]] - always [[objNull]]|RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
+
|x1= - |EXAMPLE1=
| |= See also
+
____________________________________________________________________________________________
 +
| [[getHideFrom]], [[setHideBehind]], [[isHidden]] |SEEALSO=
  
 
}}
 
}}
Line 29: Line 32:
 
<h3 style="display:none">Notes</h3>
 
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
+
<!-- CONTINUE Notes -->
 +
 
 +
<dd class="notedate">Posted on July 4, 2015 - 22:01 (UTC)
 +
<dt class="note">[[User:SnowSky|SnowSky]]
 +
<dd class="note">An alternative function in Arma 3 might be [[BIS_fnc_findSafePos]]
  
<!-- Note Section END -->
+
<!-- DISCONTINUE Notes -->
 
</dl>
 
</dl>
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|FINDCOVER]]
 
[[Category:Scripting Commands|FINDCOVER]]
[[Category:Scripting Commands ArmA|FINDCOVER]]
+
[[Category:Scripting Commands Armed Assault|FINDCOVER]]
 
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Broken Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 20:12, 3 June 2020

Introduced with Armed Assault version 1.001.00
Hover & click on the images for descriptions

Description

Description:
Returns the object around where the unit finds cover. The minDist, visibilityPosition and ignoreObject parameters are optional.

Not implemented in Arma 2 or Arma 3, always returns objNull

Syntax

Syntax:
object findCover [position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]
Parameters:
object: Object
[position, hidePosition, maxDist, minDist, visibilityPosition, ignoreObject]: Array
position: Array - format Position
hidePosition: Array - format getHideFrom. Position of that which the unit should hide from
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:
-

Additional Information

See also:
getHideFromsetHideBehindisHidden

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Posted on July 4, 2015 - 22:01 (UTC)
SnowSky
An alternative function in Arma 3 might be BIS_fnc_findSafePos

Bottom Section