Close ×

AI.AI_A2A_Cap

AI - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_Gci

AI - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI - Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system with reconnaissance units, coordinating SEAD, BAI and CAS operations.
AI.AI_A2G_SEAD

AI - Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Dispatcher

AI - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air_Engage

AI - Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
AI.AI_BAI

AI - Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_CAP

AI - Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_CAS

AI - Perform Close Air Support (CAS) near friendlies.
AI.AI_Cargo

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI - Models the intelligent transportation of cargo using ground vehicles.
AI.AI_Cargo_Airplane

AI - Models the intelligent transportation of cargo using airplanes.
AI.AI_Cargo_Dispatcher

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Dispatcher_Ship

AI - Models the intelligent transportation of infantry and other cargo using Ships.
AI.AI_Cargo_Helicopter

AI - Models the intelligent transportation of cargo using helicopters.
AI.AI_Cargo_Ship

AI - Models the intelligent transportation of infantry and other cargo.
AI.AI_Escort

AI - Taking the lead of AI escorting your flight or of other AI.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Escort_Dispatcher_Request

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort_Request

AI - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Formation

AI - Build large airborne formations of aircraft.
AI.AI_Patrol

AI - Perform Air Patrolling for airplanes.
Actions.Act_Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occurring on UNITs.
Actions.Act_Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Act_Assist

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Actions.Act_Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Cargo.Cargo

Cargo - Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo - Management of single cargo crates, which are based on a STATIC object.
Cargo.CargoGroup

Cargo - Management of grouped cargo logistics, which are based on a GROUP object.
Cargo.CargoSlingload

Cargo - Management of single cargo crates, which are based on a STATIC object.
Cargo.CargoUnit

Cargo - Management of single cargo logistics, which are based on a UNIT object.
Core.Astar

Core - A* Pathfinding.
Core.Base

Core - The base class within the framework.
Core.Beacon

Core - TACAN and other beacons.
Core.Condition

Core - Define any or all conditions to be evaluated.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.MarkerOps_Base

Core - Tap into markers added to the F10 map by users.
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Pathline

Core - Path from A to B.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core - SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
Core.Settings

Core - Manages various settings for missions, providing a menu for players to tweak settings in running missions.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn statics.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.TextAndSound

Core - A Moose GetText system.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
Core.Zone_Detection

Core - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
DCS

DCS API Prototypes.
Functional.ATC_Ground

Functional - Monitor airbase traffic and regulate speed while taxiing.
Functional.Artillery

Functional - Control artillery units.
Functional.CleanUp

Functional - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.Designate

Functional - Management of target Designation.
Functional.Detection

Functional - Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.DetectionZones

Functional - Captures the class DETECTION_ZONES.
Functional.Escort

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

Functional - Yet Another Missile Trainer.
Functional.Mantis

Functional - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.
Functional.MissileTrainer

Functional - Train missile defence and deflection.
Functional.Movement

Functional - Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Basic ATC.
Functional.RAT

Functional - Create random airtraffic in your missions.
Functional.Range

Functional - Range Practice.
Functional.Scoring

Functional - Administer the scoring of player achievements, file and log the scoring events for use at websites.
Functional.Sead

Functional - Make SAM sites execute evasive and defensive behaviour when being fired upon.
Functional.Shorad

Functional - Short Range Air Defense System.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional - Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional - Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional - Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional - Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.ATIS


Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.CSAR

Ops - Combat Search and Rescue.
Ops.CTLD

Ops - Combat Troops & Logistics Department.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Sound.Radio

Sound - Radio transmissions.
Sound.RadioQueue

Sound - Queues Radio Transmissions.
Sound.RadioSpeech

Core - Makes the radio talk.
Sound.SRS

Sound - Simple Radio Standalone (SRS) Integration and Text-to-Speech.
Sound.SoundOutput

Sound - Sound output classes.
Sound.UserSound

Sound - Manage user sound.
Tasking.CommandCenter

Tasking - A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.
Tasking.Mission

Tasking - A mission models a goal to be achieved through the execution and completion of tasks by human players.
Tasking.Task

Tasking - A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking - Controls the information of a Task.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking - Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_CARGO

Tasking - Base class to model tasks for players to transport cargo.
Tasking.Task_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Tasking.Task_Capture_Zone

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_Cargo_CSAR

Tasking - Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking - Models tasks for players to transport cargo.
Tasking.Task_Manager

Tasking - This module contains the TASK_MANAGER class and derived classes.
Utilities.Enums

Utilities Enumerators.
Utilities.FiFo

 UTILS - Classic FiFo Stack.
Utilities.Profiler

Utils - Lua Profiler.
Utilities.STTS

Utilities  - DCS Simple Text-To-Speech (STTS).
Utilities.Socket

Utilities - Socket.
Utilities.Templates

Utilities - Templates.
Utilities.Utils

Utilities - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.
Wrapper.Airbase

Wrapper - AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper - CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.Group

Wrapper - GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

Wrapper - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
Wrapper.Marker

Wrapper - Markers On the F10 map.
Wrapper.Net

Wrapper - DCS net functions.
Wrapper.Object

Wrapper - OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper - POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper - SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper - STATIC wraps the DCS StaticObject class.
Wrapper.Storage

Wrapper - Warehouse storage of DCS airbases.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
Wrapper.Weapon

Wrapper - Weapon functions.

Module Functional.Escort

Functional - Taking the lead of AI escorting your flight.

Features:

Escort navigation commands.
Escort hold at position commands.
Escorts reporting detected targets.
Escorts scanning targets in advance.
Escorts attacking specific targets.
Request assistance from other groups for attack.
Manage rule of engagement of escorts.
Manage the allowed evasion techniques of escorts.
Make escort to execute a defined mission or path.
Escort tactical situation reporting.

Missions:

ESC - Escorting

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.

Authors: FlightControl

Global(s)

Global ESCORT

ESCORT class

ESCORT construction methods.

#ESCORT ESCORT

ESCORT class

ESCORT construction methods.

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

ESCORT.New: Creates a new ESCORT object from a Wrapper.Group#GROUP for a Wrapper.Client#CLIENT, with an optional briefing text.

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 _Resume(EscortGroup)

_Resume(EscortGroup)

@param Wrapper.Group#GROUP EscortGroup

Parameter:

EscortGroup

Type(s)

Type ESCORT

ESCORT

Fields and Methods inherited from ESCORT	Description
ESCORT.CT1
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
ESCORT.EscortName
ESCORT.EscortSetGroup
ESCORT.FollowDistance
ESCORT.GT1
ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)	JoinsUp and Follows a CLIENT.
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:RegisterRoute()	Registers the waypoints
ESCORT:SetDetection(Detection)	Set a Detection method for the EscortClient to be reported upon.
ESCORT.SmokeDirectionVector
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, EscortGroupAttack)
ESCORT:_AttackTarget(DetectedItem)
ESCORT:_Flare(Color, Message)
ESCORT:_FollowScheduler()
ESCORT:_HoldPosition(OrbitGroup, OrbitHeight, OrbitSeconds)
ESCORT:_JoinUpAndFollow(Distance)
ESCORT:_ROE(EscortROEFunction, EscortROEMessage)
ESCORT:_ROT(EscortROTFunction, EscortROTMessage)
ESCORT:_ReportNearbyTargetsNow()
ESCORT:_ReportTargetsScheduler()	Report Targets Scheduler.
ESCORT:_ResumeMission(WayPoint)
ESCORT:_ScanTargets(ScanDuration)
ESCORT:_Smoke(Color, Message)
ESCORT:_SwitchReportNearbyTargets(ReportTargets)

Type ESCORT.MODE

ESCORT.MODE

Fields and Methods inherited from ESCORT.MODE	Description
ESCORT.MODE.FOLLOW
ESCORT.MODE.MISSION

Type MENUPARAM

MENUPARAM

Fields and Methods inherited from MENUPARAM	Description
MENUPARAM.ParamDistance
MENUPARAM.ParamFunction
MENUPARAM.ParamMessage
MENUPARAM.ParamSelf

Type Functional.Escort

Type ESCORT

Field(s)

#number ESCORT.CT1

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.EscortMode

ESCORT.EscortName

ESCORT.EscortSetGroup

#number ESCORT.FollowDistance

#number ESCORT.GT1

Function(s)

ESCORT:JoinUpAndFollow(EscortGroup, EscortClient, Distance)

JoinsUp and Follows a CLIENT.

Defined in:

ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

Wrapper.Client#CLIENT EscortClient

DCS#Distance Distance

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.

Defined in:

ESCORT

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.

Defined in:

ESCORT

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.

Defined in:

ESCORT

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.

Defined in:

ESCORT

Parameter:

DCS#Distance Distance

The distance in meters that the escort needs to follow the client.

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.

Defined in:

ESCORT

Parameters:

DCS#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#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.

Defined in:

ESCORT

Parameters:

DCS#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#Time Seconds

#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.

Defined in:

ESCORT

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.

Defined in:

ESCORT

Parameter:

DCS#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.

Defined in:

ESCORT

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.

Defined in:

ESCORT

Parameters:

DCS#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#Time Seconds

#string MenuTextFormat

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.

Defined in:

ESCORT

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

Defined in:

ESCORT

Return value:

#ESCORT:

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

ESCORT class constructor for an AI group

Defined in:

ESCORT

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:RegisterRoute()

Registers the waypoints

Defined in:

ESCORT

Return value:

#table:

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.

Defined in:

ESCORT

Parameter:

Function.Detection#DETECTION_BASE Detection

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.