BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50


|gr1= Tasks
|gr1= Tasks


|arg= |MPARGUMENTS=  
|arg=


|eff= |MPEFFECTS=  
|eff=


| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
|descr= Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
{{Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}
{{Feature | Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}


| [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]]
|s1= [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]]


|p1= group: [[Group]] - the [[group]] to patrol
|p1= group: [[Group]] - the [[group]] to patrol
Line 24: Line 32:
|p4= blacklist: [[Array]] - (optional) blacklist of areas
|p4= blacklist: [[Array]] - (optional) blacklist of areas


| [[Boolean]]
|r1= [[Boolean]]


|x1= <code>[<nowiki/>[[group]] _unit, [[getPos]] _unit, 1000] [[call]] [[BIS_fnc_taskPatrol]];</code>
|x1= <sqf>[group _unit, getPos _unit, 1000] call BIS_fnc_taskPatrol;</sqf>


| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
|seealso= [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
}}
}}
<h3 style='display:none'>Bottom Section</h3>
[[Category:Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]]

Latest revision as of 18:00, 13 July 2022

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:
Tasks

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