DCS task groundEscort

From DCS World Wiki - Hoggitworld.com

Task: Ground Escort Added with: 2.7.7
Hierarchy: Scripting Root > Tasks > Main task > Ground Escort
Tasking Type: Main task
For: Helicopters
Available Under: CAS, Escort, Ground Attack
Description: The assigned helicopter group will orbit above the assigned ground group at a low altitude. Any valid detected targets will be engaged. If multiple helicopters are in the group then the aircraft will be distributed throughout the orbit. The orbit pattern is roughly just flying back and forth.
Format: This task needs to be in the following format.
 Escort = {
  id = 'GroundEscort',
  params = {
    groupId = Group.ID,
    engagementDistMax, Distance,
    lastWptIndexFlag = boolean,
    lastWptIndex = number,
    targetTypes = array of AttributeName,
    lastWptIndexFlagChangedManually = boolean,

Required parameters:

groupId: unique groupId.

engagementDistMax: With his task it does not appear to actually define the range AI are allowed to attack at, rather it defines the size length of the orbit. The helicopters will fly up to this set distance before returning to the escorted group.

targetTypes: Is an array of object attributes which the AI will engage

Optional Parameters:

lastWptIndexFlag : (Default: True) if true the AI will follow the group until it reaches a specified waypoint.

lastWptIndex : (Default: -1) Identifies the waypoint at which the following group will stop its task. Must be set if lastWPIndexFlag is not changed to false. Otherwise the AI will immediately abandon the task.

lastWptIndexFlagChangedManually : I have no idea what this is, but the value in the task with the mission editor is set to true, so it might be required.

Enumerators: N/A
Notes: See article Mission Editor: AI Tasking for more information on how AI tasking is handled within DCS.
Task List: Main Tasks: mission, AttackGroup, AttackUnit, Bombing, CarpetBombing, AttackMapObject, BombingRunway, orbit, refueling, land, follow, followBigFormation, escort, Embarking, fireAtPoint, hold, FAC_AttackGroup, EmbarkToTransport, DisembarkFromTransport, CargoTransportation, goToWaypoint, groundEscort, RecoveryTanker

En-route Tasks: engageTargets, engageTargetsInZone, engageGroup, engageUnit, awacs, tanker, ewr, FAC_engageGroup, FAC

Commands: script, setCallsign, setFrequency, switchWaypoint, stopRoute, switchAction, setInvisible, setImmortal, activateBeacon, deactivateBeacon, activateICLS, deactivateICLS, eplrs, start, transmitMessage, stopTransmission, smoke_on_off, ActivateLink4, deactivateLink4, activateACLS, deactivateACLS, LoadingShip

Options: ROE, Reaction To Threat, Radar Using, Flare Using, Formation, RTB On Bingo, silence, Disperse on Attack, Alarm State, RTB on Out of Ammo, ECM Using, Prohibit AA, Prohibit Jettison, Prohibit Afterburner, Prohibit AG, Missile Attack Range, Prohibit WP Pass Report, Engage Air Weapons, Option Radio Usage Contact, Option Radio Usage Engage, Option Radio Usage Kill, AC Engagement Range Restriction, jett tanks if empty, forced attack, Altitude Restriction for AAA Min, restrict targets, Altitude Restriction for AAA Max