Difference between revisions of "BIS fnc taskPatrol"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|([0-9]{1}.[0-9]{2})\|\= " to "|$1|Game version= ")
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ :\\\-\/|()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|=
+
{{RV|type=function
____________________________________________________________________________________________
 
  
| arma2 |Game name=
+
| arma2
  
|1.00|Game version=
+
|1.00
  
|arg= |MPARGUMENTS=  
+
|gr1= Tasks
  
|eff= |MPEFFECTS=
+
|arg=|eff=| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
____________________________________________________________________________________________
+
{{Feature | Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}
  
| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
+
| [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]]
  
|=
+
|p1= group: [[Group]] - the [[group]] to patrol
____________________________________________________________________________________________
 
  
| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=
+
|p2= position: [[Position]] - the [[position]] on which to base the patrol
  
|p1= group - the [[group]] to which to assign the [[Waypoint|waypoints]] ([[Group]])|Parameter1=
+
|p3= distance: [[Number]] - maximum [[distance]] between waypoints in meters
  
|p2= position - the [[position]] on which to base the patrol ([[Array]]) |=
+
|p4= blacklist: [[Array]] - (optional) blacklist of areas
  
|p3= distance - the maximum [[distance]] between waypoints ([[Number]]) |=
+
| [[Boolean]]
  
|p4= area blacklist - (optional) blacklist of areas ([[Array]]) |=
+
|x1= <code>[<nowiki/>[[group]] _unit, [[getPos]] _unit, 1000] [[call]] [[BIS_fnc_taskPatrol]];</code>
  
 
+
|seealso= [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
| Success Flag ([[Boolean]]) |=  
 
 
 
 
 
|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>
 
 
  
  
  
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Function Group: Spawning|{{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 01:35, 17 February 2021

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.
Execution:
call

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

See also:
Functions Library BIS_fnc_taskAttack BIS_fnc_taskDefend
Groups:
Tasks

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