MIST groundBuildWP

mist.ground.buildWP

Added with: Mist 2.0

Description

Returns a table of a valid waypoint entry that is defined by the vec2 or vec3 coordinate of point. The optional varibale string formation defines the type of formation used with the waypoint, if no formation is given the formation will default to "cone". The optional variable speed takes a numerical value in meters per second and assigns it to the waypoint. If speed is not defined the mission editor default of 20 kilometers per hour will be used.

Syntax

table mist.ground.buildWP(table vec2/vec3 , string formation ,number speed )

Valid Input Values:

vec2/vec3 = valid vec2/vec3 table

formation = groundFormations speed = any number for the speed in meters per second

Return value:

table

Return example:

exampleWaypoint

Usage Examples:


 do
 local path = {} 
 path[#path + 1] = mist.ground.buildWP(startPoint, 'Diamond', 5) 
 path[#path + 1] = mist.ground.buildWP(endPoint, 'Diamond', 5) 
 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