Difference between revisions of "BIS fnc taskPatrol"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
Line 1: Line 1:
 +
{{Command|=
 +
____________________________________________________________________________________________
 +
 +
| arma2 |=
 +
 +
|1.00|=
 +
 +
|arg= |= MPARGUMENTS
  
{{Function|= Comments
+
|eff= |= MPEFFECTS
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma2 |= Game name
+
| Create a random patrol of several waypoints around a given position.
  
|1.00|= Game version
+
|=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>
+
| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=
/*
+
 
File: taskPatrol.sqf
+
|p1= group - the group to which to assign the waypoints (Group)|=
 +
 
 +
|p2= position - the position on which to base the patrol (Array) |=
 +
 
 +
|p3= distance - the maximum distance between waypoints (Number) |=
  
Description:
+
|p4= area blacklist - (optional) blacklist of areas (Array) |=
Create a random patrol of several waypoints around a given position.
 
  
Parameter(s):
 
_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
+
| Success Flag (Boolean) |=  
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+
 
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_taskPatrol]]; --> |= Syntax
+
|x1= <code>[group this, getPos this, 1000] call bis_fnc_taskPatrol</code>|= EXAMPLE1
  
|p1= |= Parameter 1
+
| Success Flag (Boolean) |=  
  
| |= Return value
 
____________________________________________________________________________________________
 
  
|x1= <code></code> |=  
+
|x1= <code>[group this, getPos this] call bis_fnc_taskDefend</code>|= EXAMPLE1
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[Functions Library]] |= SEEALSO
  
 +
|  |= MPBEHAVIOUR
 +
____________________________________________________________________________________________
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
+
The easiest way to use this function is to create a group, then add the following code to the group leader's init field:
<dl class="command_description">
+
 
<!-- Note Section BEGIN -->
+
:<code>[group this, getPos this] call BIS_fnc_taskDefend;</code>
  
<!-- Note Section END -->
+
<h3 style='display:none'>Bottom Section</h3>
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
[[Category:ArmA 2: Functions|BIS_FNC_TASKDEFEND}}]]
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
 
[[Category:Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|arma2}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]]
 

Revision as of 13:11, 20 December 2009

Introduced with Arma 2 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 2
Version:
1.00

Description

Description:
Create a random patrol of several waypoints around a given position.

Syntax

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

Examples

Example 1:
[group this, getPos this] call bis_fnc_taskDefend

Additional Information

Multiplayer:
-
See also:
Success Flag (Boolean)

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

The easiest way to use this function is to create a group, then add the following code to the group leader's init field:

[group this, getPos this] call BIS_fnc_taskDefend;

Bottom Section