Grimes at 01:30, 12 October 2024

2024-10-12T01:30:19Z

Grimes at 23:02, 13 April 2018

2018-04-13T23:02:02Z

New page

{{Mission Scripting

|fName= mist.ground.patrolRoute

|vNum = Mist 3.2

|desc= This function will re-assign a route for groupName once the group reaches the end if its route.

|rtnType= nothing

|reqType1= table

|reqName1= vars

|reqType2=

|reqName2=

|reqType3=

|reqName3=

|reqType4=

|reqName4=

|reqType5=

|reqName5=

|optType1=

|optName1=

|optType2=

|optName2=

|optType3=

|optName3=

|optType4=

|optName4=

|optType5=

|optName5=

|varExamples= {{varsTable

|r1T= string/table
|r1N= groupName/groupTable

|r2T=
|r2N=

|r3T=
|r3N=

|r4T=
|r4N=

|r5T=
|r5N=

|r6T=
|r6N=

|o1T= string/table
|o1N= useGroupRoute/route

|o2T= number
|o2N= speed

|o3T= string
|o3N= offRoadForm

|o4T= string
|o4N= onRoadForm

|o5T= string
|o5N= patrolType

|o6N=

|r1D= is a Group class table of the group (Group.getByName('myGroup')) or a string of the groups name.
|r2D=
|r3D=
|r4D=
|r5D=
|r6D=

|o1D= Is an optional variable to define which route is to be used.
If neither value is given the route used will be the default route defined by the mission editor for the group set to patrol

useGroupRoute is the name of the group from which the patrol route will be used.

route is a table of route data that overrides the useGroupRoute variable to define the route used.
|o2D= is the speed in meters per second that the group will travel at. If not provided the speed of each waypoint as defined in the editor is used. If speed is invalid the default value of 6 meters per second is used.
|o3D= specifies the formation used while off road enroute to the waypoint. Offroad formations default to the formation "cone" as defined in mist.ground.buildWP.
|o4D= specifies the formation used for waypoints specified as "on road".
|o5D= specifies the type of patrol used.
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, ...

}}

|rtnExamples= nothing

|example= <code>
do
local vars = {}
vars.gpData = 'myGroup',
vars.useGroupRoute = 'dummyPatrolRoute'
vars.offRoadForm = 'diamond'
vars.pType = 'doubleBack'
mist.ground.patrolRoute(vars)
end

do
mist.group.patrolRoute({gpData = 'myGroup', pType = 'doubleBack', offRoadForm = 'diamond'})

end
</code>

|notes=

|funcs= {{listOfMistGroupOrders}}

}}
[[Category: MIST|groundPatrolRoute]]

@@ Line 122: / Line 122: @@
 do
-   mist.group.patrolRoute({gpData = 'myGroup', pType = 'doubleBack', offRoadForm = 'diamond'})
+   mist.ground.patrolRoute({gpData = 'myGroup', pType = 'doubleBack', offRoadForm = 'diamond'})
 end

MIST groundPatrolRoute - Revision history

Grimes at 01:30, 12 October 2024

Grimes at 23:02, 13 April 2018