MIST groupToPoint - Revision history

Loophole 62ndFF at 02:20, 22 January 2023

2023-01-22T02:20:24Z

Loophole 62ndFF at 02:07, 22 January 2023

2023-01-22T02:07:49Z

Loophole 62ndFF at 02:00, 22 January 2023

2023-01-22T02:00:30Z

Grimes at 23:52, 24 February 2021

2021-02-24T23:52:07Z

Grimes at 23:03, 13 April 2018

2018-04-13T23:03:31Z

New page

{{Mission Scripting

|fName= mist.groupToPoint

|vNum = Mist 2.0

|desc= 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.

|rtnType= nothing

|reqType1= table/string

|reqName1= group/groupName

|reqType2= table/string

|reqName2= zoneTable/zoneName

|reqType3=

|optType1= string

|optName1= form

|optType2= number

|optName2= heading

|optType3= number

|optName3= speed

|optType4= boolean

|optName4= useRoads

|varExamples= 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)

|rtnExamples= nothing

|example= <code>
do
mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)

mist.groupToPoint('myGroup2', 'myZone', 'cone', nil, nil, true)
end
</code>

|notes=

|funcs= {{listOfMistGroupOrders}}

}}
[[Category: MIST|groupToPoint]]

@@ Line 5: / Line 5: @@
 |vNum = Mist 2.0
-|desc= This function 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. dontUseRoads defines if the group will use a road to get to the point.
+|desc= This function 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. The destination point can be either a zoneTable structure or a zoneName. 'form' is the default formation name 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. 'ignoreRoads' controls whether the group will try to use roads to get to the point.
 |rtnType= nothing
@@ Line 33: / Line 33: @@
 |optType4= boolean
-|optName4= useRoads
+|optName4= ignoreRoads
 |varExamples= group = 'myGroup'
@@ Line 56: / Line 56: @@
 speed = any positive number. (Group limited by lowest max speed of vehicles in the group)
-dontUseRoads = boolean (any value)  True if you don't want to force the group not use a road. Otherwise if the destination is further than 1.3* the radius of the destination zone the group will automatically seek out a road to go to the destination.
+ignoreRoads = boolean (any value)  True if you don't want the group to use roads. Otherwise if the destination is further than 1.3* the radius of the destination zone the group will automatically seek out a road to go to the destination.
 |rtnExamples= nothing

@@ Line 5: / Line 5: @@
 |vNum = Mist 2.0
-|desc= 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. dontUseRoads defines if the group will use a road to get to the point.
+|desc= This function 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. dontUseRoads defines if the group will use a road to get to the point.
 |rtnType= nothing

@@ Line 61: / Line 61: @@
 |example= <code>
    mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)
    mist.groupToPoint('myGroup2', 'myZone', 'cone', nil, nil, true)
@@ Line 67: / Line 66: @@
 |notes=
 |funcs= {{listOfMistGroupOrders}}