BIS fnc taskPatrol: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Function|= " to "{{Function|Comments= ")
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|=
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |=
| arma2 |Game name=


|1.00|=
|1.00|Game version=


|arg= |= MPARGUMENTS
|arg= |MPARGUMENTS=  


|eff= |= MPEFFECTS
|eff= |MPEFFECTS=  
____________________________________________________________________________________________
____________________________________________________________________________________________


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 [[Waypoint|waypoints]] ([[Group]])|=
|p1= group - the [[group]] to which to assign the [[Waypoint|waypoints]] ([[Group]])|Parameter1=


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


|x1= <code>
|x1= <code>
waituntil {!isnil "bis_fnc_init"}; // First, you need to check if Functions were already initialized
[group this, getPos this, 1000] call bis_fnc_taskPatrol</code>|EXAMPLE1=  
[group this, getPos this, 1000] call bis_fnc_taskPatrol</code>|= EXAMPLE1


__________
__________


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


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}
Line 62: Line 61:


<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]]
[[Category:ArmA 2: Functions|TASKPATROL}}]]
[[Category:Functions|{{uc:taskPatrol}}]]
[[Category:Function Group: Spawning|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}}]]

Revision as of 13:21, 3 September 2019

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



Bottom Section