BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Page format)
(17 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Command|=
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |=
| arma2 |Game name=


|1.00|=
|1.00|Game version=


|arg= |= MPARGUMENTS
|arg= |MPARGUMENTS=  


|eff= |= MPEFFECTS
|eff= |MPEFFECTS=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| Create a random patrol of several 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 waypoints (Group)|=
 
|p2= position - the position on which to base the patrol (Array) |=
 
|p3= distance - the maximum distance between waypoints (Number) |=
 
|p4= area blacklist - (optional) blacklist of areas (Array) |=  
 


| Success Flag (Boolean) |=  
|p1= group: [[Group]] - the [[group]] to patrol |PARAMETER1=


|p2= position: [[Position]] - the [[position]] on which to base the patrol |PARAMETER2=


|x1= <code>[group this, getPos this, 1000] call bis_fnc_taskPatrol</code>|= EXAMPLE1
|p3= distance: [[Number]] - maximum [[distance]] between waypoints in meters |PARAMETER3=


| Success Flag (Boolean) |=  
|p4= blacklist: [[Array]] - (optional) blacklist of areas |PARAMETER4=


| [[Boolean]] |RETURNVALUE=


|x1= <code>[group this, getPos this] call bis_fnc_taskDefend</code>|= EXAMPLE1
|x1= <code>[<nowiki/>[[group]] _unit, [[getPos]] _unit, 1000] [[call]] [[BIS_fnc_taskPatrol]];</code>|EXAMPLE1=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Functions Library]] |= SEEALSO  
| [[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] call BIS_fnc_taskDefend;</code>


<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
[[Category:ArmA 2: Functions|BIS_FNC_TASKDEFEND}}]]
[[Category:Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]]

Revision as of 17:29, 18 April 2020

Hover & click on the images for description

Description

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

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

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


Bottom Section