Module Escort

Functional -- Taking the lead of AI escorting your flight.


#ESCORT class

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.

RADIO MENUs that can be created:

Find a summary below of the current available commands:

Navigation ...:

Escort group navigation functions:

  • "Join-Up and Follow at x meters": The escort group fill follow you at about x 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.

Hold position ...:

Escort group navigation functions:

  • "At current location": Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
  • "At client location": Stops the escort group and they will hover 30 meters above the ground at the position they stopped.

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.

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.

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.

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.

ROE ...:

Sets the Rules of Engagement (ROE) 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.

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.

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.

ESCORT construction methods.

Create a new SPAWN object with the ESCORT.New method:

ESCORT initialization methods.

The following menus are created within the RADIO MENU (F10) of an active unit hosted by a player:

Usage:

-- Declare a new EscortPlanes object as follows:

-- First find the GROUP object and the CLIENT object.
local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.

-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )


Global(s)

ESCORT
_Resume(EscortGroup)

Type ESCORT

ESCORT.CT1
ESCORT.ClassName
ESCORT.Detection
ESCORT.EscortBriefing
ESCORT.EscortClient
ESCORT.EscortGroup
ESCORT.EscortMenu
ESCORT.EscortMenuAttackNearbyTargets
ESCORT.EscortMenuEvasion
ESCORT.EscortMenuEvasionEvadeFire
ESCORT.EscortMenuEvasionNoReaction
ESCORT.EscortMenuEvasionPassiveDefense
ESCORT.EscortMenuFlare
ESCORT.EscortMenuFlareGreen
ESCORT.EscortMenuFlareRed
ESCORT.EscortMenuFlareWhite
ESCORT.EscortMenuFlareYellow
ESCORT.EscortMenuHold
ESCORT.EscortMenuHoldAtLeaderPosition
ESCORT.EscortMenuHoldPosition
ESCORT.EscortMenuJoinUpAndFollow
ESCORT.EscortMenuOptionEvasionVertical
ESCORT.EscortMenuROE
ESCORT.EscortMenuROEHoldFire
ESCORT.EscortMenuROEOpenFire
ESCORT.EscortMenuROEReturnFire
ESCORT.EscortMenuROEWeaponFree
ESCORT.EscortMenuReportNavigation
ESCORT.EscortMenuReportNearbyTargets
ESCORT.EscortMenuReportNearbyTargetsNow
ESCORT.EscortMenuReportNearbyTargetsOff
ESCORT.EscortMenuReportNearbyTargetsOn
ESCORT.EscortMenuResumeMission
ESCORT.EscortMenuScan
ESCORT.EscortMenuScanForTargets
ESCORT.EscortMenuSmoke
ESCORT.EscortMenuSmokeBlue
ESCORT.EscortMenuSmokeGreen
ESCORT.EscortMenuSmokeOrange
ESCORT.EscortMenuSmokeRed
ESCORT.EscortMenuSmokeWhite
ESCORT.EscortMenuTargetAssistance
ESCORT.EscortMode

The mode the escort is in.

ESCORT.EscortName
ESCORT.EscortSetGroup
ESCORT.FollowDistance

The current follow distance.

ESCORT.FollowScheduler

The instance of the SCHEDULER class.

ESCORT.FunctionalMENU_GROUPDETECTION_BASE

Detection

ESCORT.GT1
ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)

JoinsUp and Follows a CLIENT.

ESCORT.MODE
ESCORT:MenuAssistedAttack()

Defines a menu slot to let the escort attack its detected targets using assisted attack from another escort joined also with the client.

ESCORT:MenuEvasion(MenuTextFormat)

Defines a menu to let the escort set its evasion when under threat.

ESCORT:MenuFlare(MenuTextFormat)

Defines a menu slot to let the escort disperse a flare in a certain color.

ESCORT:MenuFollowAt(Distance)

Defines a menu slot to let the escort Join and Follow you at a certain distance.

ESCORT:MenuHoldAtEscortPosition(Height, Seconds, MenuTextFormat)

Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds.

ESCORT:MenuHoldAtLeaderPosition(Height, Seconds, MenuTextFormat)

Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds.

ESCORT:MenuROE(MenuTextFormat)

Defines a menu to let the escort set its rules of engagement.

ESCORT:MenuReportTargets(Seconds)

Defines a menu slot to let the escort report their current detected targets with a specified time interval in seconds.

ESCORT:MenuResumeMission()

Defines a menu to let the escort resume its mission from a waypoint on its route.

ESCORT:MenuScanForTargets(Height, Seconds, MenuTextFormat)

Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.

ESCORT:MenuSmoke(MenuTextFormat)

Defines a menu slot to let the escort disperse a smoke in a certain color.

ESCORT:Menus()

Defines the default menus

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:SetDetection(Detection)

Set a Detection method for the EscortClient to be reported upon.

ESCORT.SmokeDirectionVector
ESCORT.Targets
ESCORT.TaskPoints
ESCORT:TestSmokeDirectionVector(SmokeDirection)

This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to.

ESCORT._AssistTarget(DetectedItem, self, EscortGroupAttack)
  • @param #ESCORT self
ESCORT:_AttackTarget(DetectedItem)
ESCORT._Flare(MenuParam, self, Color, Message)
ESCORT:_FollowScheduler()
ESCORT._HoldPosition(MenuParam, self, OrbitGroup, OrbitHeight, OrbitSeconds)
ESCORT._JoinUpAndFollow(MenuParam, self, Distance)
ESCORT._ROE(MenuParam, self, EscortROEFunction, EscortROEMessage)
ESCORT._ROT(MenuParam, self, EscortROTFunction, EscortROTMessage)
ESCORT._ReportNearbyTargetsNow(MenuParam, self)
ESCORT:_ReportTargetsScheduler()

Report Targets Scheduler.

ESCORT._ResumeMission(MenuParam, self, WayPoint)
ESCORT._ScanTargets(MenuParam, self, ScanDuration)
ESCORT._Smoke(MenuParam, self, Color, Message)
ESCORT:_SwitchReportNearbyTargets(ReportTargets)

Type ESCORT.MODE

ESCORT.MODE.FOLLOW
ESCORT.MODE.MISSION

Type MENUPARAM

MENUPARAM.Distance
MENUPARAM.ParamDistance
MENUPARAM.ParamFunction
MENUPARAM.ParamMessage
MENUPARAM.ParamSelf

Global(s)

#ESCORT ESCORT
_Resume(EscortGroup)

Parameter

Type Escort

Type Distance

Type ESCORT

Extends Core.Base#BASE

ESCORT class

Field(s)

#number ESCORT.CT1
#string ESCORT.ClassName
ESCORT.Detection
ESCORT.EscortBriefing
Wrapper.Client#CLIENT ESCORT.EscortClient
Wrapper.Group#GROUP ESCORT.EscortGroup
ESCORT.EscortMenu
ESCORT.EscortMenuAttackNearbyTargets

Attack Targets

ESCORT.EscortMenuEvasion

Reaction to Threats

ESCORT.EscortMenuEvasionEvadeFire
ESCORT.EscortMenuEvasionNoReaction
ESCORT.EscortMenuEvasionPassiveDefense
ESCORT.EscortMenuFlare
ESCORT.EscortMenuFlareGreen
ESCORT.EscortMenuFlareRed
ESCORT.EscortMenuFlareWhite
ESCORT.EscortMenuFlareYellow
ESCORT.EscortMenuHold
#table ESCORT.EscortMenuHoldAtLeaderPosition
#table ESCORT.EscortMenuHoldPosition
#table ESCORT.EscortMenuJoinUpAndFollow
ESCORT.EscortMenuOptionEvasionVertical
ESCORT.EscortMenuROE

Rules of Engagement

ESCORT.EscortMenuROEHoldFire
ESCORT.EscortMenuROEOpenFire
ESCORT.EscortMenuROEReturnFire
ESCORT.EscortMenuROEWeaponFree
ESCORT.EscortMenuReportNavigation
ESCORT.EscortMenuReportNearbyTargets
ESCORT.EscortMenuReportNearbyTargetsNow

Report Targets

ESCORT.EscortMenuReportNearbyTargetsOff
ESCORT.EscortMenuReportNearbyTargetsOn
ESCORT.EscortMenuResumeMission

Mission Resume Menu Root

ESCORT.EscortMenuScan
#table ESCORT.EscortMenuScanForTargets
ESCORT.EscortMenuSmoke
ESCORT.EscortMenuSmokeBlue
ESCORT.EscortMenuSmokeGreen
ESCORT.EscortMenuSmokeOrange
ESCORT.EscortMenuSmokeRed
ESCORT.EscortMenuSmokeWhite
ESCORT.EscortMenuTargetAssistance

Request assistance from other escorts. This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...

#ESCORT.MODE ESCORT.EscortMode

The mode the escort is in.

#string ESCORT.EscortName
ESCORT.EscortSetGroup
#number ESCORT.FollowDistance

The current follow distance.

Core.Scheduler#SCHEDULER ESCORT.FollowScheduler

The instance of the SCHEDULER class.

ESCORT.FunctionalMENU_GROUPDETECTION_BASE

Detection

#number ESCORT.GT1
ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)

JoinsUp and Follows a CLIENT.

Parameters

#table ESCORT.MODE
ESCORT:MenuAssistedAttack()

Defines a menu slot to let the escort attack its detected targets using assisted attack from another escort joined also with the client.

This menu will appear under Request assistance from. Note that this method needs to be preceded with the method MenuReportTargets.

Return value

#ESCORT:

ESCORT:MenuEvasion(MenuTextFormat)

Defines a menu to let the escort set its evasion when under threat.

All rules of engagement will appear under the menu Evasion.

Parameter

  • MenuTextFormat :

Return value

#ESCORT:

ESCORT:MenuFlare(MenuTextFormat)

Defines a menu slot to let the escort disperse a flare in a certain color.

This menu will appear under Navigation. The flare will be fired from the first unit in the group.

Parameter

  • #string MenuTextFormat : Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.

Return value

#ESCORT:

ESCORT:MenuFollowAt(Distance)

Defines a menu slot to let the escort Join and Follow you at a certain distance.

This menu will appear under Navigation.

Parameter

Return value

#ESCORT:

ESCORT:MenuHoldAtEscortPosition(Height, Seconds, MenuTextFormat)

Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds.

This menu will appear under Hold position.

Parameters

  • Dcs.DCSTypes#Distance Height : Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.

  • Dcs.DCSTypes#Time Seconds : Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.

  • #string MenuTextFormat : Optional parameter that shows the menu option text. The text string is formatted, and should contain two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.

Return value

#ESCORT: TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.

ESCORT:MenuHoldAtLeaderPosition(Height, Seconds, MenuTextFormat)

Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds.

This menu will appear under Navigation.

Parameters

  • Dcs.DCSTypes#Distance Height : Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.

  • Dcs.DCSTypes#Time Seconds : Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.

  • #string MenuTextFormat : Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.

Return value

#ESCORT: TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.

ESCORT:MenuROE(MenuTextFormat)

Defines a menu to let the escort set its rules of engagement.

All rules of engagement will appear under the menu ROE.

Parameter

  • MenuTextFormat :

Return value

#ESCORT:

ESCORT:MenuReportTargets(Seconds)

Defines a menu slot to let the escort report their current detected targets with a specified time interval in seconds.

This menu will appear under Report targets. Note that if a report targets menu is not specified, no targets will be detected by the escort, and the attack and assisted attack menus will not be displayed.

Parameter

  • Dcs.DCSTypes#Time Seconds : Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.

Return value

#ESCORT:

ESCORT:MenuResumeMission()

Defines a menu to let the escort resume its mission from a waypoint on its route.

All rules of engagement will appear under the menu Resume mission from.

Return value

#ESCORT:

ESCORT:MenuScanForTargets(Height, Seconds, MenuTextFormat)

Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.

This menu will appear under Scan targets.

Parameters

  • Dcs.DCSTypes#Distance Height : Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.

  • Dcs.DCSTypes#Time Seconds : Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.

  • #string MenuTextFormat : Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.

Return value

#ESCORT:

ESCORT:MenuSmoke(MenuTextFormat)

Defines a menu slot to let the escort disperse a smoke in a certain color.

This menu will appear under Navigation. Note that smoke menu options will only be displayed for ships and ground units. Not for air units. The smoke will be fired from the first unit in the group.

Parameter

  • #string MenuTextFormat : Optional parameter that shows the menu option text. If no text is given, the default text will be displayed.

Return value

#ESCORT:

ESCORT:Menus()

Defines the default menus

Return value

#ESCORT:

ESCORT:New(EscortClient, EscortGroup, EscortName, EscortBriefing)

ESCORT class constructor for an AI group

Parameters

  • Wrapper.Client#CLIENT EscortClient : The client escorted by the EscortGroup.

  • Wrapper.Group#GROUP EscortGroup : The group AI escorting the EscortClient.

  • #string EscortName : Name of the escort.

  • #string EscortBriefing : A text showing the ESCORT briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.

Return value

#ESCORT: self

Usage:

-- Declare a new EscortPlanes object as follows:

-- First find the GROUP object and the CLIENT object.
local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.

-- Now use these 2 objects to construct the new EscortPlanes object.
EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
ESCORT.OptionROE
Dcs.DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT ESCORT.OptionReactionOnThreat

Which REACTIONONTHREAT is set to the EscortGroup.

ESCORT:RegisterRoute()

Registers the waypoints

Return value

#table:

#boolean ESCORT.ReportTargets

If true, nearby targets are reported.

ESCORT.ReportTargetsScheduler
ESCORT:SetDetection(Detection)

Set a Detection method for the EscortClient to be reported upon.

Detection methods are based on the derived classes from DETECTION_BASE.

Parameter

ESCORT.SmokeDirectionVector
#table ESCORT.Targets
#table ESCORT.TaskPoints
ESCORT:TestSmokeDirectionVector(SmokeDirection)

This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to.

This allows to visualize where the escort is flying to.

Parameter

  • #boolean SmokeDirection : If true, then the direction vector will be smoked.

ESCORT._AssistTarget(DetectedItem, self, EscortGroupAttack)
  • @param #ESCORT self

Parameters

ESCORT:_AttackTarget(DetectedItem)

Parameter

ESCORT._Flare(MenuParam, self, Color, Message)

Parameters

ESCORT:_FollowScheduler()
ESCORT._HoldPosition(MenuParam, self, OrbitGroup, OrbitHeight, OrbitSeconds)

Parameters

  • #MENUPARAM MenuParam :

  • self :

  • OrbitGroup :

  • OrbitHeight :

  • OrbitSeconds :

ESCORT._JoinUpAndFollow(MenuParam, self, Distance)

Parameters

ESCORT._ROE(MenuParam, self, EscortROEFunction, EscortROEMessage)

Parameters

  • #MENUPARAM MenuParam :

  • self :

  • EscortROEFunction :

  • EscortROEMessage :

ESCORT._ROT(MenuParam, self, EscortROTFunction, EscortROTMessage)

Parameters

  • #MENUPARAM MenuParam :

  • self :

  • EscortROTFunction :

  • EscortROTMessage :

ESCORT._ReportNearbyTargetsNow(MenuParam, self)

Parameters

ESCORT:_ReportTargetsScheduler()

Report Targets Scheduler.

ESCORT._ResumeMission(MenuParam, self, WayPoint)

Parameters

ESCORT._ScanTargets(MenuParam, self, ScanDuration)

Parameters

ESCORT._Smoke(MenuParam, self, Color, Message)

Parameters

ESCORT:_SwitchReportNearbyTargets(ReportTargets)

Parameter

  • ReportTargets :

Type ESCORT.MODE

ESCORT.Mode class

Field(s)

#number ESCORT.MODE.FOLLOW
#number ESCORT.MODE.MISSION

Type MENUPARAM

MENUPARAM type

Field(s)

MENUPARAM.Distance
#Distance MENUPARAM.ParamDistance
#function MENUPARAM.ParamFunction
#string MENUPARAM.ParamMessage
#ESCORT MENUPARAM.ParamSelf