Banner Image

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:

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)

Parameter:

Wrapper.Group#GROUP EscortGroup

Type(s)

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

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: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.OptionReactionOnThreat

Which REACTION_ON_THREAT 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: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)

Fields and Methods inherited from BASE Description

ESCORT.ClassID

The ID number of the class.

ESCORT.ClassName

The name of the class.

ESCORT.ClassNameAndID

The name of the class concatenated with the ID number of the class.

ESCORT:ClearState(Object, StateName)

Clear the state of an object.

ESCORT:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

ESCORT:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

ESCORT:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

ESCORT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

ESCORT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

ESCORT:E(Arguments)

Log an exception which will be traced always.

ESCORT:EventDispatcher()

Returns the event dispatcher

ESCORT:EventRemoveAll()

Remove all subscribed events

ESCORT:F(Arguments)

Trace a function call.

ESCORT:F2(Arguments)

Trace a function call level 2.

ESCORT:F3(Arguments)

Trace a function call level 3.

ESCORT:GetClassID()

Get the ClassID of the class instance.

ESCORT:GetClassName()

Get the ClassName of the class instance.

ESCORT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

ESCORT:GetEventPriority()

Get the Class Event processing Priority.

ESCORT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

ESCORT:GetState(Object, Key)

Get a Value given a Key from the Object.

ESCORT:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

ESCORT:I(Arguments)

Log an information which will be traced always.

ESCORT:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

ESCORT:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

ESCORT:IsTrace()

Enquires if tracing is on (for the class).

ESCORT:New()

BASE constructor.

ESCORT:OnEvent(EventData)

Occurs when an object is completely destroyed.

ESCORT:OnEventBaseCaptured(EventData)

Occurs when a ground unit captures either an airbase or a farp.

ESCORT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

ESCORT:OnEventCrash(EventData)

Occurs when any aircraft crashes into the ground and is completely destroyed.

ESCORT:OnEventDead(EventData)

Occurs when an object is dead.

ESCORT:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

ESCORT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

ESCORT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

ESCORT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

ESCORT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

ESCORT:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

ESCORT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

ESCORT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

ESCORT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

ESCORT:OnEventMissionEnd(EventData)

Occurs when a mission ends

ESCORT:OnEventMissionStart(EventData)

Occurs when a mission starts

ESCORT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

ESCORT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

ESCORT:OnEventPlayerLeaveUnit(EventData)

Occurs when any player relieves control of a unit to the AI.

ESCORT:OnEventRefueling(EventData)

Occurs when an aircraft connects with a tanker and begins taking on fuel.

ESCORT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

ESCORT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

ESCORT:OnEventShootingStart(EventData)

Occurs when any unit begins firing a weapon that has a high rate of fire.

ESCORT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

ESCORT:OnEventTakeoff(EventData)

Occurs when an aircraft takes off from an airbase, farp, or ship.

ESCORT:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

ESCORT:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

ESCORT:ScheduleStop(SchedulerFunction)

Stops the Schedule.

ESCORT.Scheduler

ESCORT:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

ESCORT:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

ESCORT:T(Arguments)

Trace a function logic level 1.

ESCORT:T2(Arguments)

Trace a function logic level 2.

ESCORT:T3(Arguments)

Trace a function logic level 3.

ESCORT:TraceAll(TraceAll)

Trace all methods in MOOSE

ESCORT:TraceClass(Class)

Set tracing for a class

ESCORT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

ESCORT:TraceLevel(Level)

Set trace level

ESCORT:TraceOff()

Set trace off.

ESCORT:TraceOn()

Set trace on.

ESCORT:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

ESCORT:UnHandleEvent(Event)

UnSubscribe to a DCS event.

ESCORT._

ESCORT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

ESCORT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

ESCORT.__

ESCORT:onEvent(event)

Fields and Methods inherited from ESCORT.MODE Description

ESCORT.MODE.FOLLOW

ESCORT.MODE.MISSION

Field(s)

#number ESCORT.CT1
ESCORT.EscortMenuEvasion

Reaction to Threats

ESCORT.EscortMenuROE

Rules of Engagement

ESCORT.EscortMenuResumeMission

Mission Resume Menu Root

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.

#number ESCORT.FollowDistance

The current follow distance.

Core.Scheduler#SCHEDULER ESCORT.FollowScheduler

The instance of the SCHEDULER class.

#number ESCORT.GT1
DCS#AI.Option.Air.val.REACTION_ON_THREAT ESCORT.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the EscortGroup.

#boolean ESCORT.ReportTargets

If true, nearby targets are reported.

Function(s)

JoinsUp and Follows a CLIENT.

Defined in:

ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

Wrapper.Client#CLIENT EscortClient

DCS#Distance Distance

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:

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:

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:

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:

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:

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

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

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:

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

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:

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:

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:

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

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:

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:

Defines the default menus

Defined in:

ESCORT

Return value:

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:

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." )

Registers the waypoints

Defined in:

ESCORT

Return value:

#table:

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:

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.

Defined in:

ESCORT

Parameter:

#boolean SmokeDirection

If true, then the direction vector will be smoked.

  • @param #ESCORT self

Defined in:

ESCORT

Parameters:

self

EscortGroupAttack

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

Color

Message

Defined in:

ESCORT

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

OrbitGroup

OrbitHeight

OrbitSeconds

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

Distance

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

EscortROEFunction

EscortROEMessage

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

EscortROTFunction

EscortROTMessage

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

Report Targets Scheduler.

Defined in:

ESCORT

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

WayPoint

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

ScanDuration

Defined in:

ESCORT

Parameters:

#MENUPARAM MenuParam

self

Color

Message

Defined in:

ESCORT

Parameter:

ReportTargets

Field(s)

#number ESCORT.CT1
ESCORT.EscortMenuEvasion

Reaction to Threats

ESCORT.EscortMenuROE

Rules of Engagement

ESCORT.EscortMenuResumeMission

Mission Resume Menu Root

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.

#number ESCORT.FollowDistance

The current follow distance.

Core.Scheduler#SCHEDULER ESCORT.FollowScheduler

The instance of the SCHEDULER class.

#number ESCORT.GT1
DCS#AI.Option.Air.val.REACTION_ON_THREAT ESCORT.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the EscortGroup.

#boolean ESCORT.ReportTargets

If true, nearby targets are reported.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

Get a Value given a Key from the Object.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end
  

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Occurs when a ground unit captures either an airbase or a farp.

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft crashes into the ground and is completely destroyed.

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player relieves control of a unit to the AI.

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft connects with a tanker and begins taking on fuel.

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft takes off from an airbase, farp, or ship.

initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class. @param #BASE self @param DCS#Event event

Defined in:

Parameter:

event

ESCORT.Mode class

Field(s)

Function(s)