BIS fnc taskPatrol: Difference between revisions

Revision as of 13:21, 3 September 2019

1.00

Hover & click on the images for description

Description

Description:: Create a random patrol of several waypoints around a given position.
Execution:: call
Groups:: Uncategorised

Syntax

Syntax:: [group,position,distance,area blacklist] call BIS_fnc_taskPatrol
Parameters:: group - the group to which to assign the waypoints (Group)
: position - the position on which to base the patrol (Array)
: distance - the maximum distance between waypoints (Number)
: area blacklist - (optional) blacklist of areas (Array)
Return Value:: Success Flag (Boolean)

Examples

Example 1:: [group this, getPos this, 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

The easiest way to use this function is to create a group, then add the following code to the group leader's init field:

[group this, getPos this, number] call BIS_fnc_taskPatrol;

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

nul=[group this, position this, number] call BIS_fnc_taskPatrol;

2.1 You can use triggers for this function too, but your groups must be named

nul=[group GrpName2, position GrpName2, 70] call BIS_fnc_taskPatrol; nul=[group GrpName1, position GrpName1, 150] call BIS_fnc_taskPatrol

@@ Line 1: / Line 1: @@
+{{Function|Comments=
+____________________________________________________________________________________________
-{{Function|= Comments
+| arma2 |Game name=
+|1.00|Game version=
+|arg= |MPARGUMENTS=
+|eff= |MPEFFECTS=
 ____________________________________________________________________________________________
-| arma2 |= Game name
+| Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]].
-|1.00|= Game version
+|=
 ____________________________________________________________________________________________
-| <pre>
+| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=
-/*
-	File: taskPatrol.sqf
+|p1= group - the [[group]] to which to assign the [[Waypoint|waypoints]] ([[Group]])|Parameter1=
+|p2= position - the [[position]] on which to base the patrol ([[Array]]) |=
-	Description:
+|p3= distance - the maximum [[distance]] between waypoints ([[Number]]) |=
-	Create a random patrol of several waypoints around a given position.
-	Parameter(s):
+|p4= area blacklist - (optional) blacklist of areas ([[Array]]) |=
-	_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
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+| Success Flag ([[Boolean]]) |=
+|x1= <code>
+[group this, getPos this, 1000] call bis_fnc_taskPatrol</code>|EXAMPLE1=
+__________
+| [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]] |SEEALSO=
+|  |MPBEHAVIOUR=
 ____________________________________________________________________________________________
+}}
-| <!-- [] call [[BIS_fnc_taskPatrol]]; --> |= Syntax
+The easiest way to use this function is to create a group, then add the following code to the group leader's init field:
-|p1= |= Parameter 1
+:<code>[group this, getPos this, ''number''] call BIS_fnc_taskPatrol;</code>
-| |= Return value
+'''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>
-|x1= <code></code> |=
+'''2.1''' You can use triggers for this function too, but your groups must be named
-____________________________________________________________________________________________
-| |= See also
+:<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">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+<h3 style='display:none'>Bottom Section</h3>
 [[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
 [[Category:Functions|{{uc:taskPatrol}}]]