BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) * \|p1=" to " |s1=$1 |p1=")
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 17: Line 17:
|arg=
|arg=


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


|s1=[group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]]
|descr= Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
{{Feature|informative|In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}
 
|s1= [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]]


|p1= group: [[Group]] - the [[group]] to patrol
|p1= group: [[Group]] - the [[group]] to patrol
Line 32: Line 34:
|r1= [[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>


|seealso= [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
|seealso= [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
}}
}}
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]]

Latest revision as of 21:41, 16 May 2024

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