Difference between revisions of "MIST groundPatrol"

From DCS World Wiki - Hoggitworld.com
 
(No difference)

Latest revision as of 23:01, 13 April 2018


mist.ground.patrol

Added with: Mist 3.2
Description
This function will re-assign the route of the specified groupName as defined in the mission editor when the group reaches the end of their route effectively creating a patrol.
Syntax
nothing mist.ground.patrol(table/string group/groupName , string patrolType ,string formation ,number speed )
Valid Input Values:
groupTable = Group.getByName('myGroup')

groupName = string of an existing group

patrolType = string of patrol types.

doubleBack  - Group follows the route in the order of 1, 2, 3, 2, 1, 2, 3, 2, ...
nil or anything - Group follows route, when route is finish group travels back to WP 1: 1, 2, 3, 1, 2, 3, 1, ...

formation = string of valid formation types

speed = positive number in meters per second

Return value:
nothing
Return example:
Usage Examples:

do

 mist.ground.patrol('myGroup', nil, 'diamond', 10)
 mist.ground.patrol('myGroup', 'doubleBack')

end

Notes:
Utilizes mist.ground.patrolRoute.
Related Functions
General goRoute
Ground groupToPoint, groupToRandomZone, groupRandomDistSelf, groupToRandomPoint, buildWP(ground), patrol, patrolRoute
Fixed Wing buildWP(fixedWing)
Helicopter buildWP(helicopter)

Scripting Engine

MIST Root Page