Difference between revisions of "BIS fnc taskPatrol"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Page format)
 
(18 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
{{Function|Comments=
 +
____________________________________________________________________________________________
 +
 +
| arma2 |Game name=
  
{{Function|= Comments
+
|1.00|Game version=
____________________________________________________________________________________________
 
  
| arma2 |= Game name
+
|arg= |MPARGUMENTS=  
  
|1.00|= Game version
+
|eff= |MPEFFECTS=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>
+
| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
/*
+
{{Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}} |DESCRIPTION=
File: taskPatrol.sqf
+
____________________________________________________________________________________________
  
Description:
+
| [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]] |SYNTAX=
Create a random patrol of several waypoints around a given position.
 
  
Parameter(s):
+
|p1= group: [[Group]] - the [[group]] to patrol |PARAMETER1=
_this select 0: the group to which to assign the waypoints (Group)
 
_this select 1: the position on which to base the patrol (Array)
 
_this select 2: the maximum distance between waypoints (Number)
 
_this select 3: (optional) blacklist of areas (Array)
 
 
Returns:
 
Boolean - success flag
 
*/
 
  
//Validate parameter count
+
|p2= position: [[Position]] - the [[position]] on which to base the patrol |PARAMETER2=
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_taskPatrol]]; --> |= Syntax
+
|p3= distance: [[Number]] - maximum [[distance]] between waypoints in meters |PARAMETER3=
  
|p1= |= Parameter 1
+
|p4= blacklist: [[Array]] - (optional) blacklist of areas |PARAMETER4=
  
| |= Return value
+
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
 
  
|x1= <code></code> |=  
+
|x1= <code>[<nowiki/>[[group]] _unit, [[getPos]] _unit, 1000] [[call]] [[BIS_fnc_taskPatrol]];</code>|EXAMPLE1=  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]] |SEEALSO=
 
 
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
 
<!-- Note Section END -->
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
 
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
 
[[Category:Functions|{{uc:taskPatrol}}]]
 
[[Category:Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:taskPatrol}}]]
 
 
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]]

Latest revision as of 17:29, 18 April 2020

Introduced with Arma 2 version 1.001.00
Hover & click on the images for descriptions

Description

Description:
Create a random patrol of several waypoints around a given position.
In Arma 2, the Functions Module is required.

Syntax

Syntax:
[group, position, distance, blacklist] call BIS_fnc_taskPatrol
Parameters:
group: Group - the group to patrol
position: Position - the position on which to base the patrol
distance: Number - maximum distance between waypoints in meters
blacklist: Array - (optional) blacklist of areas
Return Value:
Boolean

Examples

Example 1:
[group _unit, getPos _unit, 1000] call BIS_fnc_taskPatrol;

Additional Information

Execution:
call
See also:
Functions Library BIS_fnc_taskAttack BIS_fnc_taskDefend

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.


Bottom Section