BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Added links and fixed category)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|=
|=
Line 18: Line 18:
| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=
| [group,position,distance,area blacklist] call '''BIS_fnc_taskPatrol'''  |=


|p1= group - the group to which to assign the waypoints (Group)|=
|p1= group - the [[group]] to which to assign the [[Waypoint|waypoints]] ([[Group]])|=


|p2= position - the position on which to base the patrol (Array) |=  
|p2= position - the [[position]] on which to base the patrol ([[Array]]) |=  


|p3= distance - the maximum distance between waypoints (Number) |=  
|p3= distance - the maximum [[distance]] between waypoints ([[Number]]) |=  


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




| Success Flag (Boolean) |=  
| Success Flag ([[Boolean]]) |=  




Line 61: Line 61:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:ArmA 2: Functions|BIS_FNC_PATROL}}]]
[[Category:ArmA 2: Functions|BIS_FNC_TASKPATROL}}]]

Revision as of 21:10, 11 January 2010

Hover & click on the images for description

Description

Description:
Create a random patrol of several waypoints around a given position.
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

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



Bottom Section