BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(47 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*
|version4= 0.50
File: taskPatrol.sqf


Description:
|gr1= Tasks
Create a random patrol of several waypoints around a given position.


Parameter(s):
|arg=
_this select 0: the group to which to assign the waypoints (Group)
_this select 1: the position on which to base the patrol (Array)
_this select 2: the maximum distance between waypoints (Number)
_this select 3: (optional) blacklist of areas (Array)
Returns:
Boolean - success flag
*/


//Validate parameter count
|eff=
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskPatrol]]; --> |= Syntax
|descr= Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
{{Feature|informative|In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}


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


| |= Return value
|p1= group: [[Group]] - the [[group]] to patrol
____________________________________________________________________________________________


|x1= <code></code> |=
|p2= position: [[Position]] - the [[position]] on which to base the patrol
____________________________________________________________________________________________


| |= See also
|p3= distance: [[Number]] - maximum [[distance]] between waypoints in meters


}}
|p4= blacklist: [[Array]] - (optional) blacklist of areas


<h3 style="display:none">Notes</h3>
|r1= [[Boolean]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>[group _unit, getPos _unit, 1000] call BIS_fnc_taskPatrol;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
}}
[[Category:Functions|{{uc:taskPatrol}}]]
[[Category:{{Name|arma2}}: 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 21:41, 16 May 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskPatrol&oldid=364486"