BIS fnc taskPatrol: Difference between revisions
Jump to navigation
Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki) |
Lou Montana (talk | contribs) m (Page format) |
||
(18 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
{{Function|Comments= | |||
____________________________________________________________________________________________ | |||
| arma2 |Game name= | |||
|1.00|Game version= | |||
| | |arg= |MPARGUMENTS= | ||
| | |eff= |MPEFFECTS= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Create a random patrol of several [[Waypoint|waypoints]] around a given [[position]]. | ||
{{Informative | In {{arma2}}, the [[Functions Library|Functions Module]] is required.}} |DESCRIPTION= | |||
____________________________________________________________________________________________ | |||
| [group, position, distance, blacklist] call [[BIS_fnc_taskPatrol]] |SYNTAX= | |||
|p1= group: [[Group]] - the [[group]] to patrol |PARAMETER1= | |||
|p2= position: [[Position]] - the [[position]] on which to base the patrol |PARAMETER2= | |||
| | |p3= distance: [[Number]] - maximum [[distance]] between waypoints in meters |PARAMETER3= | ||
| | |p4= blacklist: [[Array]] - (optional) blacklist of areas |PARAMETER4= | ||
| |= | | [[Boolean]] |RETURNVALUE= | ||
|x1= <code></code> |= | |x1= <code>[<nowiki/>[[group]] _unit, [[getPos]] _unit, 1000] [[call]] [[BIS_fnc_taskPatrol]];</code>|EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |= | | [[Functions Library]] [[BIS_fnc_taskAttack]] [[BIS_fnc_taskDefend]] |SEEALSO= | ||
}} | }} | ||
<h3 style= | <h3 style='display:none'>Bottom Section</h3> | ||
[[Category:Function Group: Spawning|{{uc:taskPatrol}}]] | [[Category:Function Group: Spawning|{{uc:taskPatrol}}]] | ||
[[Category:Functions|{{uc:taskPatrol}}]] | [[Category:Functions|{{uc:taskPatrol}}]] | ||
[[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]] | [[Category:{{Name|arma2oa}}: Functions|{{uc:taskPatrol}}]] | ||
[[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]] | [[Category:{{Name|tkoh}}: Functions|{{uc:taskPatrol}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]] | [[Category:{{Name|arma3}}: Functions|{{uc:taskPatrol}}]] |
Revision as of 17:29, 18 April 2020
Description
- Description:
- Create a random patrol of several waypoints around a given position.
- Execution:
- call
- Groups:
- Uncategorised
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
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