Module `Escort`

Taking the lead of AI escorting your flight.

The ESCORT class allows you to interact with escoring AI on your flight and take the lead.

Global(s)

Type `ESCORT`

ESCORT.ClassName
ESCORT.EscortClient
ESCORT.EscortGroup
ESCORT.EscortName
ESCORT.FollowScheduler	The id of the _FollowScheduler function.
ESCORT:New(EscortClient, EscortGroup, EscortName)	ESCORT class constructor for an AI group
ESCORT.OptionROE
ESCORT.OptionReactionOnThreat	Which REACTIONONTHREAT is set to the EscortGroup.
ESCORT:RegisterRoute()
ESCORT.ReportTargets	If true, nearby targets are reported.
ESCORT.Targets
ESCORT._AttackTarget(MenuParam)
ESCORT:_FollowScheduler(FollowDistance)
ESCORT._HoldPosition(MenuParam)
ESCORT._HoldPositionNearBy(MenuParam)
ESCORT._JoinUpAndFollow(MenuParam)
ESCORT._OptionROTEvadeFire(MenuParam)
ESCORT._OptionROTNoReaction(MenuParam)
ESCORT._OptionROTPassiveDefense(MenuParam)
ESCORT._OptionROTVertical(MenuParam)
ESCORT._ROEHoldFire(MenuParam)
ESCORT._ROEOpenFire(MenuParam)
ESCORT._ROEReturnFire(MenuParam)
ESCORT._ROEWeaponFree(MenuParam)
ESCORT._ReportNearbyTargets(MenuParam)
ESCORT:_ReportTargetsScheduler()
ESCORT._ResumeMission(MenuParam)
ESCORT._ScanTargets30Seconds(MenuParam)
ESCORT._ScanTargets60Seconds(MenuParam)

Type `MENUPARAM`

MENUPARAM.ParamDistance
MENUPARAM.ParamSelf

Global(s)

#ESCORT ESCORT

Type `Escort`

Type `Distance`

Type `ESCORT`

ESCORT class

Field(s)

#string ESCORT.ClassName

Client#CLIENT ESCORT.EscortClient

Group#GROUP ESCORT.EscortGroup

#string ESCORT.EscortName

#number ESCORT.FollowScheduler: The id of the _FollowScheduler function.

ESCORT:New(EscortClient, EscortGroup, EscortName)

ESCORT class constructor for an AI group

Parameters

Client#CLIENT EscortClient : The client escorted by the EscortGroup.
Group#GROUP EscortGroup : The group AI escorting the EscortClient.
#string EscortName : Name of the escort.

Return value

#ESCORT: self

ESCORT.OptionROE

DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT ESCORT.OptionReactionOnThreat: Which REACTIONONTHREAT is set to the EscortGroup.

ESCORT:RegisterRoute()

#boolean ESCORT.ReportTargets: If true, nearby targets are reported.

ESCORT.Targets

ESCORT._AttackTarget(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT:_FollowScheduler(FollowDistance)

Parameter

FollowDistance :

ESCORT._HoldPosition(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._HoldPositionNearBy(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._JoinUpAndFollow(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._OptionROTEvadeFire(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._OptionROTNoReaction(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._OptionROTPassiveDefense(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._OptionROTVertical(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ROEHoldFire(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ROEOpenFire(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ROEReturnFire(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ROEWeaponFree(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ReportNearbyTargets(MenuParam)

Parameter

MenuParam :

ESCORT:_ReportTargetsScheduler()

ESCORT._ResumeMission(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ScanTargets30Seconds(MenuParam)

Parameter

#MENUPARAM MenuParam :

ESCORT._ScanTargets60Seconds(MenuParam)

Parameter

#MENUPARAM MenuParam :

Type `MENUPARAM`

MENUPARAM type

Field(s)

#Distance MENUPARAM.ParamDistance

#ESCORT MENUPARAM.ParamSelf