BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
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...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Tasks |GROUP1=
|gr1= Tasks


|arg= |MPARGUMENTS=  
|arg= |MPARGUMENTS=  
Line 12: Line 12:


| Create a random patrol of several [[Waypoint|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=
{{Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}}


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


|p1= group: [[Group]] - the [[group]] to patrol |PARAMETER1=
|p1= group: [[Group]] - the [[group]] to patrol


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


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


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


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]


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


| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]] |SEEALSO=
| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]]
}}
}}



Revision as of 23:45, 17 January 2021

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


Bottom Section