This task needs to be in the following format.
Mission = {
id = 'Mission',
params = {
airborne = boolean,
route = {
points = {
[1] = {
type = enum AI.Task.WaypointType,
airdromeId = Airbase.ID,
timeReFuAr = number,
helipadId = Airbase.ID,
action = enum AI.Task.TurnMethod,
x = Distance,
y = Distance,
alt = Distance,
alt_type = enum AI.Task.AltitudeType,
speed = Distance,
speed_locked = boolean,
ETA = Time,
ETA_locked = boolean,
name = string,
task = Task,
},
[2] = {
...
},
...
[N]= {
...
}
}
},
}
}
}
Each waypoint has a number of parameters that define how the group will handle the route.
Required parameters:
x: Vec2 x coordinate waypoint will be placed at.
y: Vec2 y coordinate waypoint will be placed at. If converted from Vec3 this is the z coordinate.
type: Waypoint type. See AI enumerator page for more details.
speed: Speed in meters per second the group will attempt to travel at. Note each unit has its own maximum achievable speed
action: Waypoint action type. See AI enumerator page for more details.
alt: Altitude of waypoint. If converted from Vec3 this is the y coordinate. This item is required for Aircraft, but is optional for ground vehicles. As of 2.5.6 this value can be set to negative numbers. Specifically this will submerge submarines.
Optional Parameters:
speed_locked: boolean value that will determine if units will attempt to travel at the specified speed
eta: Time-On-Target of the waypoint. Has effect only if ETA_locked is true. AI will adjust speed to reach TOT accordingly.
eta_locked: Boolean value that will determine if AI will attempt to reach the waypoint at a specified time.
alt_type: Altitude type; Radio or Barometric. Defaults to barometric. If specified the altitude of the waypoint can be defined as AGL or MSL. Only applies to aircraft.
task: All tasks, enroute tasks, commands, and options are defined here.
Waypoint Type Specific Parameters
helipadId: Used only for "Land" waypoint type. Specifies the helipadId the helicopter group will attempt to land at. AI will only land if helipad is friendly. If not provided the AI will land at the nearest valid base to the coordinates.
airdromeId: Used only for "Land" waypoint type. Specifies the airbaseId the aircraft group will attempt to land at. AI will only land if airbase is friendly. If not provided the AI will land at the nearest valid base to the coordinates.
timeReFuAr: If the waypoint type is a landReFuAr this value determines how long in minutes the unit will be stationary for.
|