Difference between revisions of "BIS fnc taskPatrol"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= " to "{{Function|Comments= ")
m (Page format)
Line 12: Line 12:
  
 
| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
 
| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
 
+
{{Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}} |DESCRIPTION=
|=
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=
+
| [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]] |SYNTAX=
  
|p1= group - the [[group]] to which to assign the [[Waypoint|waypoints]] ([[Group]])|Parameter1=
+
|p1= group: [[Group]] - the [[group]] to patrol |PARAMETER1=
  
|p2= position - the [[position]] on which to base the patrol ([[Array]]) |=  
+
|p2= position: [[Position]] - the [[position]] on which to base the patrol |PARAMETER2=
  
|p3= distance - the maximum [[distance]] between waypoints ([[Number]]) |=  
+
|p3= distance: [[Number]] - maximum [[distance]] between waypoints in meters |PARAMETER3=
  
|p4= area blacklist - (optional) blacklist of areas ([[Array]]) |=  
+
|p4= blacklist: [[Array]] - (optional) blacklist of areas |PARAMETER4=
  
 +
| [[Boolean]] |RETURNVALUE=
  
| Success Flag ([[Boolean]]) |=  
+
|x1= <code>[<nowiki/>[[group]] _unit, [[getPos]] _unit, 1000] [[call]] [[BIS_fnc_taskPatrol]];</code>|EXAMPLE1=  
 +
____________________________________________________________________________________________
  
 
+
| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]] |SEEALSO=
|x1= <code>
 
[group this, getPos this, 1000] call bis_fnc_taskPatrol</code>|EXAMPLE1=
 
 
 
__________
 
 
 
| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]] |SEEALSO=  
 
 
 
|  |MPBEHAVIOUR=
 
____________________________________________________________________________________________
 
 
}}
 
}}
 
The easiest way to use this function is to create a group, then add the following code to the group leader's init field:
 
 
:<code>[group this, getPos this, ''number''] call BIS_fnc_taskPatrol;</code>
 
 
'''The more correct way is to:'''
 
 
'''1. Place function module on map'''
 
 
'''2.''' Make one waypoint for group and put this code in Waypoints  On.Act. field
 
 
:<code>nul=[group this, position this, ''number''] call BIS_fnc_taskPatrol;</code>
 
 
'''2.1''' You can use triggers for this function too, but your groups must be named
 
 
:<code>nul=[group GrpName2, position GrpName2, 70] call BIS_fnc_taskPatrol; nul=[group GrpName1, position GrpName1, 150] call BIS_fnc_taskPatrol</code>
 
 
 
  
  
Line 63: Line 37:
 
[[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}}]]

Revision as of 16: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
Groups:
Uncategorised

Notes

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


Bottom Section