Module `Escort`

Taking the lead of AI escorting your flight.

The ESCORT class allows you to interact with escorting AI on your flight and take the lead. Each escorting group can be commanded with a whole set of radio commands (radio menu in your flight, and then F10).

The radio commands will vary according the category of the group. The richest set of commands are with Helicopters and AirPlanes. Ships and Ground troops will have a more limited set, but they can provide support through the bombing of targets designated by the other escorts.

Find a summary below of the current available commands:

1. Navigation ...: Escort group navigation functions:

"Hold Position and Stay Low": Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
"Join-Up and Hold Position NearBy": The escort group will stop nearby you, and then the group will hover.
"Join-Up and Follow at 100": The escort group fill follow you at about 100 meters, and they will follow you.
"Join-Up and Follow at 200": The escort group fill follow you at about 200 meters, and they will follow you.
"Join-Up and Follow at 400": The escort group fill follow you at about 400 meters, and they will follow you.
"Join-Up and Follow at 800": The escort group fill follow you at about 800 meters, and they will follow you.
"Flare": Provides menu commands to let the escort group shoot a flare in the air in a color.
"Smoke": Provides menu commands to let the escort group smoke the air in a color. Note that smoking is only available for ground and naval troops.

2. Report targets ...: Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below).

"Report now": Will report the current detected targets.
"Report targets on": Will make the escort group to report detected targets and will fill the "Attack nearby targets" menu list.
"Report targets off": Will stop detecting targets.

3. Scan targets ...: Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.

"Scan targets 30 seconds": Scan 30 seconds for targets.
"Scan targets 60 seconds": Scan 60 seconds for targets.

4. Attack targets ...: This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed.

5. Request assistance from ...: This menu item will list all detected targets within a 15km range, as with the menu item Attack Targets. This menu item allows to request attack support from other escorts supporting the current client group. eg. the function allows a player to request support from the Ship escort to attack a target identified by the Plane escort with its Tomahawk missiles. eg. the function allows a player to request support from other Planes escorting to bomb the unit with illumination missiles or bombs, so that the main plane escort can attack the area.

6. ROE ...: Defines the Rules of Engagement of the escort group when in flight.

"Hold Fire": The escort group will hold fire.
"Return Fire": The escort group will return fire.
"Open Fire": The escort group will open fire on designated targets.
"Weapon Free": The escort group will engage with any target.

7. Evasion ...: Will define the evasion techniques that the escort group will perform during flight or combat.

"Fight until death": The escort group will have no reaction to threats.
"Use flares, chaff and jammers": The escort group will use passive defense using flares and jammers. No evasive manoeuvres are executed.
"Evade enemy fire": The rescort group will evade enemy fire before firing.
"Go below radar and evade fire": The escort group will perform evasive vertical manoeuvres.

8. Resume Mission ...: Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint. Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission.

9. Abort Current Task: Cancel the current task and rejoin formation.

ESCORT object construction methods.

Create a new SPAWN object with the ESCORT.New method:
ESCORT.New: Creates a new ESCORT object from a Group#GROUP for a Client#CLIENT, with an optional briefing text.
ESCORT object initialization methods.

None.

Global(s)

ESCORT

Type `ESCORT`

ESCORT.ClassName
ESCORT.EscortClient
ESCORT.EscortGroup
ESCORT.EscortMenuResumeMission
ESCORT.EscortName
ESCORT.FollowScheduler	The id of the _FollowScheduler function.
ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)	JoinsUp and Follows a CLIENT.
ESCORT:New(EscortClient, EscortGroup, EscortName, EscortBriefing)	ESCORT class constructor for an AI group
ESCORT.OptionROE
ESCORT.OptionReactionOnThreat	Which REACTIONONTHREAT is set to the EscortGroup.
ESCORT:RegisterRoute()	Registers the waypoints
ESCORT.ReportTargets	If true, nearby targets are reported.
ESCORT.ReportTargetsScheduler
ESCORT.Targets
ESCORT.TaskPoints
ESCORT._AssistTarget(MenuParam)
ESCORT._AttackTarget(MenuParam)
ESCORT._Flare(MenuParam)
ESCORT:_FollowScheduler(FollowDistance)
ESCORT._HoldPosition(MenuParam)
ESCORT._HoldPositionNearBy(MenuParam)
ESCORT._JoinUpAndFollow(MenuParam)
ESCORT._ROE(MenuParam)
ESCORT._ROT(MenuParam)
ESCORT._ReportNearbyTargetsNow(MenuParam)
ESCORT:_ReportTargetsScheduler()	Report Targets Scheduler.
ESCORT._ResumeMission(MenuParam)
ESCORT._ScanTargets(MenuParam)
ESCORT._Smoke(MenuParam)
ESCORT._SwitchReportNearbyTargets(MenuParam)