BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (BIS fnc patrol moved to BIS fnc taskpatrol: Function name is actually taskpatrol, not just patrol.)
m (Text replacement - "{{Feature | Informative | " to "{{Feature|informative|")
 
(41 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|=
{{RV|type=function
____________________________________________________________________________________________


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


|1.00|=
|game2= arma2oa
|version2= 1.50


|arg= |= MPARGUMENTS
|game3= tkoh
|version3= 1.00


|eff= |= MPEFFECTS
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
|gr1= Tasks


|=
|arg=
____________________________________________________________________________________________


| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=
|eff=


|p1= group - the [[group]] to which to assign the [[Waypoint|waypoints]] ([[Group]])|=
|descr= Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
{{Feature|informative|In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}


|p2= position - the [[position]] on which to base the patrol ([[Array]]) |=
|s1= [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]]


|p3= distance - the maximum [[distance]] between waypoints ([[Number]]) |=
|p1= group: [[Group]] - the [[group]] to patrol


|p4= area blacklist - (optional) blacklist of areas ([[Array]]) |=
|p2= position: [[Position]] - the [[position]] on which to base the patrol


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


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


|r1= [[Boolean]]


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


__________
|seealso= [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
 
| [[Functions Library]] |= 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:ArmA 2: Functions|BIS_FNC_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"