MIST groupToPoint

From DCS World Wiki - Hoggitworld.com


mist.groupToPoint

Added with: Mist 2.0
Description
unction will set the task of the specified group to go a the point defined by a zones location. group can be either a group name or a group table. point can be a zoneTable or zoneName. form is the default formation name in as defined by the scripting engine. See mist.ground.buildWP or the Scripting Engine wiki for details. Heading is the final heading the group will be oriented in once it reaches its destination. speed is the speed in kilometers per hour that the group will travel at to reach its destination. useRoads defines if the group will use a road to get to the point.
Syntax
nothing mist.groupToPoint(table/string group/groupName ,table/string zoneTable/zoneName , string form ,number heading ,number speed ,boolean useRoads )
Valid Input Values:
group = 'myGroup'

or group = Group.getByName('myGroup')

table = 'myZone' table = zoneTable

form =

 "Off Road" - moving off-road in Column formation 
 "On Road" - moving on road in Column formation 
 "Rank" - moving off road in Row formation 
 "Cone" - moving in Wedge formation 
 "Vee" - moving in Vee formation 
 "Diamond" - moving in Diamond formation 
 "EchelonL" - moving in Echelon Left formation 
 "EchelonR" - moving in Echelon Right formation  

heading = -360 to 360

speed = any positive number. (Group limited by lowest max speed of vehicles in the group)

useRoads = boolean (any value)

Return value:
nothing
Return example:
nothing
Usage Examples:

do

 mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)
 mist.groupToPoint('myGroup2', 'myZone', 'cone', nil, nil, true)

end

Notes:
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