Banner Image

Module AI.AI_Escort

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


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

Escorts detect targets using a built-in detection mechanism. The detected targets are reported at a specified time interval. Once targets are reported, each escort has these targets as menu options to command the attack of these targets. Targets are by default grouped per area of 5000 meters, but the kind of detection and the grouping range can be altered.

Different formations can be selected in the Flight menu: Trail, Stack, Left Line, Right Line, Left Wing, Right Wing, Central Wing and Boxed formations are available. The Flight menu also allows for a mass attack, where all of the escorts are commanded to attack a target.

Escorts can emit flares to reports their location. They can be commanded to hold at a location, which can be their current or the leader location. In this way, you can spread out the escorts over the battle field before a coordinated attack.

But basically, the escort class provides 4 modes of operation, and depending on the mode, you are either leading the flight, or following the flight.

Leading the flight

When leading the flight, you are expected to guide the escorts towards the target areas, and carefully coordinate the attack based on the threat levels reported, and the available weapons carried by the escorts. Ground ships or ground troops can execute A-assisted attacks, when they have long-range ground precision weapons for attack.

Following the flight

Escorts can be commanded to execute a specific mission path. In this mode, the escorts are in the lead. You as a player, are following the escorts, and are commanding them to progress the mission while ensuring that the escorts survive. You are joining the escorts in the battlefield. They will detect and report targets and you will ensure that the attacks are well coordinated, assigning the correct escort type for the detected target type. Once the attack is finished, the escort will resume the mission it was assigned. In other words, you can use the escorts for reconnaissance, and for guiding the attack. Imagine you as a mi-8 pilot, assigned to pickup cargo. Two ka-50s are guiding the way, and you are following. You are in control. The ka-50s detect targets, report them, and you command how the attack will commence and from where. You can control where the escorts are holding position and which targets are attacked first. You are in control how the ka-50s will follow their mission path.

Escorts can act as part of a AI A2G dispatcher offensive. In this way, You was a player are in control. The mission is defined by the A2G dispatcher, and you are responsible to join the flight and ensure that the attack is well coordinated.

It is with great proud that I present you this class, and I hope you will enjoy the functionality and the dynamism it brings in your DCS world simulations.

RADIO MENUs that can be created:

Find a summary below of the current available commands:

Navigation ...:

Escort group navigation functions:

  • "Join-Up": The escort group fill follow you in the assigned formation.
  • "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": The escort group will hover above the ground at the position they were. The altitude can be specified as a parameter.
  • "At my location": The escort group will hover or orbit at the position where you are. The escort will fly to your location and hold position. The altitude can be specified as a parameter.

Report targets ...:

Report targets will make the escort group to report any target that it identifies within detection range. Any detected target can be attacked using the "Attack Targets" menu function. (see below).

  • "Report now": Will report the current detected targets.
  • "Report targets on": Will make the escorts to report the detected targets and will fill the "Attack Targets" menu list.
  • "Report targets off": Will stop detecting 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. This menu will be available in Flight menu or in each Escort menu.

Scan targets ...:

Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or rejoin formation.

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

Request assistance from ...:

This menu item will list all detected targets within a 15km range, similar as with the menu item Attack Targets. This menu item allows to request attack support from other ground based escorts supporting the current escort. 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 AI_ESCORT

AI_ESCORT class

AI_ESCORT construction methods.

#AI_ESCORT AI_ESCORT

AI_ESCORT class

AI_ESCORT construction methods.

Create a new AI_ESCORT object with the AI_ESCORT.New method:

Usage:

-- Declare a new EscortPlanes object as follows:

-- First find the GROUP object and the CLIENT object.
local EscortUnit = 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 = AI_ESCORT:New( EscortUnit, 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." )

Type(s)

Fields and Methods inherited from AI_ESCORT Description

AI_ESCORT.CT1

AI_ESCORT.Detection

AI_ESCORT:Distance(PlayerUnit, DetectedItem)

Measure distance between coordinate player and coordinate detected item.

AI_ESCORT.EscortBriefing

AI_ESCORT.EscortGroupSet

AI_ESCORT.EscortMenuScan

AI_ESCORT.EscortMenuScanForTargets

AI_ESCORT.EscortMenuTargetAssistance

AI_ESCORT.EscortName

AI_ESCORT.FlightMenu

AI_ESCORT.FollowDistance

AI_ESCORT.GT1

AI_ESCORT:GetFlightReportType()

AI_ESCORT.MainMenu

AI_ESCORT.Menu

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

AI_ESCORT:MenuFlare(MenuTextFormat)

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

AI_ESCORT:MenuFormation(Formation, ...)

AI_ESCORT:MenuFormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

Defines a menu slot to let the escort to join in a box formation.

AI_ESCORT:MenuFormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

Defines a menu slot to let the escort to join in a center wing formation.

AI_ESCORT:MenuFormationLeftLine(XStart, YStart, ZStart, ZSpace)

Defines a menu slot to let the escort to join in a leFt wing formation.

AI_ESCORT:MenuFormationLeftWing(XStart, XSpace, YStart, ZStart, ZSpace)

Defines a menu slot to let the escort to join in a left wing formation.

AI_ESCORT:MenuFormationRightLine(XStart, YStart, ZStart, ZSpace)

Defines a menu slot to let the escort to join in a right line formation.

AI_ESCORT:MenuFormationRightWing(XStart, XSpace, YStart, ZStart, ZSpace)

Defines a menu slot to let the escort to join in a right wing formation.

AI_ESCORT:MenuFormationStack(XStart, XSpace, YStart, YSpace)

Defines a menu slot to let the escort to join in a stacked formation.

AI_ESCORT:MenuFormationTrail(XStart, XSpace, YStart)

Defines a menu slot to let the escort to join in a trail formation.

AI_ESCORT:MenuFormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

Defines a menu slot to let the escort to join in a vic formation.

AI_ESCORT:MenuHoldAtEscortPosition(Height, Speed, 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.

AI_ESCORT:MenuHoldAtLeaderPosition(Height, Speed, 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.

AI_ESCORT:MenuJoinUp()

Defines --- Defines a menu slot to let the escort to join formation.

AI_ESCORT:MenuROE()

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

AI_ESCORT:MenuROT(MenuTextFormat)

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

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

AI_ESCORT:MenuSmoke(MenuTextFormat)

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

AI_ESCORT:MenuTargets(Seconds)

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

AI_ESCORT:MenusAirplanes(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

Defines the default menus for airplanes.

AI_ESCORT:MenusHelicopters(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

Defines the default menus for helicopters.

AI_ESCORT:New(EscortUnit, EscortGroupSet, EscortName, EscortBriefing)

AI_ESCORT class constructor for an AI group

AI_ESCORT.PlayerGroup

AI_ESCORT.PlayerUnit

AI_ESCORT:RegisterRoute()

Registers the waypoints

AI_ESCORT:SetDetection(Detection)

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

AI_ESCORT:SetEscortMenuFlare(EscortGroup)

AI_ESCORT:SetEscortMenuHoldAtEscortPosition(EscortGroup)

AI_ESCORT:SetEscortMenuHoldAtLeaderPosition(EscortGroup)

AI_ESCORT:SetEscortMenuJoinUp(EscortGroup)

Sets a menu slot to join formation for an escort.

AI_ESCORT:SetEscortMenuROE(EscortGroup)

AI_ESCORT:SetEscortMenuROT(EscortGroup)

AI_ESCORT:SetEscortMenuResumeMission(EscortGroup)

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

AI_ESCORT:SetEscortMenuSmoke(EscortGroup)

AI_ESCORT:SetEscortMenuTargets(EscortGroup)

AI_ESCORT:SetFlightMenuFlare()

AI_ESCORT:SetFlightMenuFormation(Formation)

AI_ESCORT:SetFlightMenuHoldAtEscortPosition()

AI_ESCORT:SetFlightMenuHoldAtLeaderPosition()

AI_ESCORT:SetFlightMenuJoinUp()

AI_ESCORT:SetFlightMenuROE()

AI_ESCORT:SetFlightMenuROT()

AI_ESCORT:SetFlightMenuReportType()

AI_ESCORT:SetFlightMenuSmoke()

AI_ESCORT:SetFlightMenuTargets()

AI_ESCORT:SetFlightReportType(ReportType)

AI_ESCORT.SmokeDirectionVector

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

AI_ESCORT.XSpace

AI_ESCORT.XStart

AI_ESCORT.YSpace

AI_ESCORT.YStart

AI_ESCORT.ZLevels

AI_ESCORT.ZSpace

AI_ESCORT.ZStart

AI_ESCORT._AssistTarget(EscortGroup, DetectedItem, self)

  • @param #AI_ESCORT self

AI_ESCORT:_AttackTarget(EscortGroup, DetectedItem)

AI_ESCORT:_EscortFormationStack(XStart, XSpace, YStart, YSpace, EscortGroup)

Lets the escort to join in a stacked formation.

AI_ESCORT:_EscortFormationTrail(XStart, XSpace, YStart, EscortGroup)

Lets the escort to join in a trail formation.

AI_ESCORT:_Flare(EscortGroup, Color, Message)

AI_ESCORT:_FlightAttackNearestTarget(TargetType)

AI_ESCORT:_FlightAttackTarget(DetectedItem)

AI_ESCORT:_FlightFlare(Color, Message)

AI_ESCORT:_FlightFormationStack(XStart, XSpace, YStart, YSpace)

AI_ESCORT:_FlightFormationTrail(XStart, XSpace, YStart)

AI_ESCORT:_FlightHoldPosition(OrbitGroup, OrbitHeight, OrbitSeconds)

AI_ESCORT:_FlightJoinUp()

AI_ESCORT:_FlightROEHoldFire(EscortROEMessage)

AI_ESCORT:_FlightROEOpenFire(EscortROEMessage)

AI_ESCORT:_FlightROEReturnFire(EscortROEMessage)

AI_ESCORT:_FlightROEWeaponFree(EscortROEMessage)

AI_ESCORT:_FlightROTEvadeFire(EscortROTMessage)

AI_ESCORT:_FlightROTNoReaction(EscortROTMessage)

AI_ESCORT:_FlightROTPassiveDefense(EscortROTMessage)

AI_ESCORT:_FlightROTVertical(EscortROTMessage)

AI_ESCORT:_FlightReportNearbyTargetsNow()

AI_ESCORT:_FlightReportTargetsScheduler(EscortGroup)

Report Targets Scheduler for the flight.

AI_ESCORT:_FlightSmoke(Color, Message)

AI_ESCORT:_FlightSwitchReportNearbyTargets(ReportTargets)

AI_ESCORT:_FlightSwitchReportTypeAirborne()

AI_ESCORT:_FlightSwitchReportTypeAll()

AI_ESCORT:_FlightSwitchReportTypeGround()

AI_ESCORT:_FlightSwitchReportTypeGroundRadar()

AI_ESCORT:_HoldPosition(OrbitGroup, EscortGroup, OrbitHeight, OrbitSeconds)

AI_ESCORT:_InitEscortMenus(EscortGroup)

AI_ESCORT:_InitEscortRoute(EscortGroup)

AI_ESCORT:_InitFlightMenus()

AI_ESCORT:_JoinUp(EscortGroup)

AI_ESCORT:_ROE(EscortGroup, EscortROEFunction, EscortROEMessage)

AI_ESCORT:_ROT(EscortGroup, EscortROTFunction, EscortROTMessage)

AI_ESCORT:_ReportNearbyTargetsNow(EscortGroup)

AI_ESCORT:_ReportTargetsScheduler(EscortGroup, Report)

Report Targets Scheduler.

AI_ESCORT:_ResumeMission(EscortGroup, WayPoint)

AI_ESCORT:_ResumeScheduler(EscortGroup)

Resume Scheduler.

AI_ESCORT:_ScanTargets(ScanDuration)

AI_ESCORT:_Smoke(EscortGroup, Color, Message)

AI_ESCORT.___Resume(EscortGroup, self)

AI_ESCORT:onafterStart(EscortGroupSet)

AI_ESCORT:onafterStop(EscortGroupSet)

Fields and Methods inherited from AI_FORMATION Description

AI_ESCORT.FlightRandomization

AI_ESCORT.FollowDistance

The current follow distance.

AI_ESCORT.FollowGroupSet

AI_ESCORT:FollowMe(FollowGroup, ClientUnit, CT1, CV1, CT2, CV2)

Follow me.

AI_ESCORT.FollowMode

The mode the escort is in.

AI_ESCORT.FollowName

AI_ESCORT.FollowScheduler

The instance of the SCHEDULER class.

AI_ESCORT.FollowUnit

AI_ESCORT:FormationBox(XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Trigger for AI_FORMATION

AI_ESCORT:FormationCenterWing(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Trigger for AI_FORMATION

AI_ESCORT:FormationLeftLine(XStart, YStart, ZStart, ZSpace)

FormationLeftLine Trigger for AI_FORMATION

AI_ESCORT:FormationLeftWing(XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Trigger for AI_FORMATION

AI_ESCORT:FormationLine(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Trigger for AI_FORMATION

AI_ESCORT:FormationRightLine(XStart, YStart, ZStart, ZSpace)

FormationRightLine Trigger for AI_FORMATION

AI_ESCORT:FormationRightWing(XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Trigger for AI_FORMATION

AI_ESCORT:FormationStack(XStart, XSpace, YStart, YSpace)

FormationStack Trigger for AI_FORMATION

AI_ESCORT:FormationTrail(XStart, XSpace, YStart)

FormationTrail Trigger for AI_FORMATION

AI_ESCORT:FormationVic(XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Trigger for AI_FORMATION

AI_ESCORT:GetFlightMode(FollowGroup)

Gets your escorts to flight mode.

AI_ESCORT:New(FollowUnit, FollowGroupSet, FollowName, FollowBriefing)

AI_FORMATION class constructor for an AI group

AI_ESCORT:OnAfterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationRightLine Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace)

FormationStack Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationTrail(From, Event, To, XStart, XSpace, YStart)

FormationTrail Handler OnAfter for AI_FORMATION

AI_ESCORT:OnAfterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Handler OnAfter for AI_FORMATION

AI_ESCORT:OnBeforeFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationRightLine Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationStack(From, Event, To, XStart, XSpace, YStart, YSpace)

FormationStack Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationTrail(From, Event, To, XStart, XSpace, YStart)

FormationTrail Handler OnBefore for AI_FORMATION

AI_ESCORT:OnBeforeFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Handler OnBefore for AI_FORMATION

AI_ESCORT.OptionReactionOnThreat

Which REACTION_ON_THREAT is set to the FollowGroup.

AI_ESCORT.ReportTargets

If true, nearby targets are reported.

AI_ESCORT:SetFlightModeAttack(FollowGroup)

This sets your escorts to execute an attack.

AI_ESCORT:SetFlightModeFormation(FollowGroup)

This sets your escorts to fly in a formation.

AI_ESCORT:SetFlightModeMission(FollowGroup)

This sets your escorts to fly a mission.

AI_ESCORT:SetFlightRandomization(FlightRandomization)

Use the method AI.AI_Formation#AI_FORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation.

AI_ESCORT:SetFollowTimeInterval(dt)

Set time interval between updates of the formation.

AI_ESCORT.SmokeDirectionVector

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

AI_ESCORT.__Enum

AI_ESCORT:__FormationBox(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels)

FormationBox Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationCenterWing(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationLeftLine(Delay, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationLeftWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationLine(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationLine Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationRightLine(Delay, XStart, YStart, ZStart, ZSpace)

FormationRightLine Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationRightWing(Delay, XStart, XSpace, YStart, ZStart, ZSpace)

FormationRightWing Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationStack(Delay, XStart, XSpace, YStart, YSpace)

FormationStack Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationTrail(Delay, XStart, XSpace, YStart)

FormationTrail Asynchronous Trigger for AI_FORMATION

AI_ESCORT:__FormationVic(Delay, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationVic Asynchronous Trigger for AI_FORMATION

AI_ESCORT.dtFollow

Time step between position updates.

AI_ESCORT:onafterFormationBox(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, ZLevels, FollowGroupSet)

FormationBox Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationCenterWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace)

FormationCenterWing Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationLeftLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationLeftLine Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationLeftWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

FormationLeftWing Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationLine(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, Formation)

FormationLine Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationRightLine(FollowGroupSet, From, Event, To, XStart, YStart, ZStart, ZSpace)

FormationRightLine Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationRightWing(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, ZStart, ZSpace)

AI_ESCORT:onafterFormationStack(FollowGroupSet, From, Event, To, XStart, XSpace, YStart, YSpace)

FormationStack Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationTrail(FollowGroupSet, From, Event, To, XStart, XSpace, YStart)

FormationTrail Handler OnAfter for AI_FORMATION

AI_ESCORT:onafterFormationVic(From, Event, To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, FollowGroupSet)

FormationVic Handle for AI_FORMATION

AI_ESCORT:onafterStop(FollowGroupSet, From, Event, To)

Stop function.

AI_ESCORT:onbeforeFollow(FollowGroupSet, From, Event, To)

Follow event fuction.

AI_ESCORT:onenterFollowing(FollowGroupSet, From, Event, To)

Enter following state.

Fields and Methods inherited from FSM_SET Description

AI_ESCORT:Get()

Gets the SET_BASE object that the FSM_SET governs.

AI_ESCORT:New(FSMT, Set_SET_BASE, FSMSet)

Creates a new FSM_SET object.

AI_ESCORT.Set

AI_ESCORT:_call_handler(step, trigger, params, EventName)

Fields and Methods inherited from FSM Description

AI_ESCORT:AddEndState(State)

Adds an End state.

AI_ESCORT:AddProcess(From, Event, Process, ReturnEvents)

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

AI_ESCORT:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

AI_ESCORT:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

AI_ESCORT:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AI_ESCORT.CallScheduler

Call scheduler.

AI_ESCORT.ClassName

Name of the class.

AI_ESCORT.Events

AI_ESCORT:GetCurrentState()

Get current state.

AI_ESCORT:GetEndStates()

Returns the End states.

AI_ESCORT:GetProcess(From, Event)

AI_ESCORT:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

AI_ESCORT:GetScores()

Returns a table with the scores defined.

AI_ESCORT:GetStartState()

Returns the start state of the FSM.

AI_ESCORT:GetState()

Get current state.

AI_ESCORT:GetSubs()

Returns a table with the Subs defined.

AI_ESCORT:GetTransitions()

Returns a table of the transition rules defined within the FSM.

AI_ESCORT:Is(State)

Check if FSM is in state.

AI_ESCORT:LoadCallBacks(CallBackTable)

Load call backs.

AI_ESCORT:New()

Creates a new FSM object.

AI_ESCORT.Scores

Scores.

AI_ESCORT:SetProcess(From, Event, Fsm)

AI_ESCORT:SetStartState(State)

Sets the start state of the FSM.

AI_ESCORT._EndStates

AI_ESCORT._EventSchedules

AI_ESCORT._Processes

AI_ESCORT._Scores

AI_ESCORT._StartState

AI_ESCORT._Transitions

AI_ESCORT:_add_to_map(Map, Event)

Add to map.

AI_ESCORT:_call_handler(step, trigger, params, EventName)

Call handler.

AI_ESCORT:_create_transition(EventName)

Create transition.

AI_ESCORT:_delayed_transition(EventName)

Delayed transition.

AI_ESCORT:_eventmap(Events, EventStructure)

Event map.

AI_ESCORT:_gosub(ParentFrom, ParentEvent)

Go sub.

AI_ESCORT:_handler(EventName, ...)

Handler.

AI_ESCORT:_isendstate(Current)

Is end state.

AI_ESCORT:_submap(subs, sub, name)

Sub maps.

AI_ESCORT:can(e)

Check if can do an event.

AI_ESCORT:cannot(e)

Check if cannot do an event.

AI_ESCORT.current

Current state name.

AI_ESCORT.endstates

AI_ESCORT:is(State, state)

Check if FSM is in state.

AI_ESCORT.options

Options.

AI_ESCORT.subs

Subs.

Fields and Methods inherited from BASE Description

AI_ESCORT.ClassID

The ID number of the class.

AI_ESCORT.ClassName

The name of the class.

AI_ESCORT.ClassNameAndID

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

AI_ESCORT:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AI_ESCORT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

AI_ESCORT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

AI_ESCORT:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

AI_ESCORT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AI_ESCORT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AI_ESCORT:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

AI_ESCORT:E(Arguments)

Log an exception which will be traced always.

AI_ESCORT:EventDispatcher()

Returns the event dispatcher

AI_ESCORT:EventRemoveAll()

Remove all subscribed events

AI_ESCORT:F(Arguments)

Trace a function call.

AI_ESCORT:F2(Arguments)

Trace a function call level 2.

AI_ESCORT:F3(Arguments)

Trace a function call level 3.

AI_ESCORT:GetClassID()

Get the ClassID of the class instance.

AI_ESCORT:GetClassName()

Get the ClassName of the class instance.

AI_ESCORT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AI_ESCORT:GetEventPriority()

Get the Class Core.Event processing Priority.

AI_ESCORT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AI_ESCORT:GetState(Object, Key)

Get a Value given a Key from the Object.

AI_ESCORT:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

AI_ESCORT:I(Arguments)

Log an information which will be traced always.

AI_ESCORT:Inherit(Child, Parent)

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

AI_ESCORT:IsInstanceOf(ClassName)

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

AI_ESCORT:IsTrace()

Enquires if tracing is on (for the class).

AI_ESCORT:New()

BASE constructor.

AI_ESCORT:OnEvent(EventData)

Occurs when an Event for an object is triggered.

AI_ESCORT:OnEventBDA(EventData)

BDA.

AI_ESCORT:OnEventBaseCaptured(EventData)

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

AI_ESCORT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AI_ESCORT:OnEventCrash(EventData)

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

AI_ESCORT:OnEventDead(EventData)

Occurs when an object is dead.

AI_ESCORT:OnEventDetailedFailure(EventData)

Unknown precisely what creates this event, likely tied into newer damage model.

AI_ESCORT:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

AI_ESCORT:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_ESCORT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AI_ESCORT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AI_ESCORT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AI_ESCORT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AI_ESCORT:OnEventKill(EventData)

Occurs on the death of a unit.

AI_ESCORT:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_ESCORT:OnEventLandingAfterEjection(EventData)

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

AI_ESCORT:OnEventLandingQualityMark(EventData)

Landing quality mark.

AI_ESCORT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AI_ESCORT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AI_ESCORT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AI_ESCORT:OnEventMissionEnd(EventData)

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_ESCORT:OnEventMissionStart(EventData)

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

AI_ESCORT:OnEventParatrooperLanding(EventData)

Weapon add.

AI_ESCORT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AI_ESCORT:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

AI_ESCORT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AI_ESCORT:OnEventPlayerLeaveUnit(EventData)

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

AI_ESCORT:OnEventRefueling(EventData)

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

AI_ESCORT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AI_ESCORT:OnEventScore(EventData)

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

AI_ESCORT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AI_ESCORT:OnEventShootingStart(EventData)

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

AI_ESCORT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AI_ESCORT:OnEventTakeoff(EventData)

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

AI_ESCORT:OnEventTriggerZone(EventData)

Trigger zone.

AI_ESCORT:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AI_ESCORT:ScheduleStop(SchedulerID)

Stops the Schedule.

AI_ESCORT.Scheduler

AI_ESCORT:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

AI_ESCORT:SetState(Object, Key, Value)

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

AI_ESCORT:T(Arguments)

Trace a function logic level 1.

AI_ESCORT:T2(Arguments)

Trace a function logic level 2.

AI_ESCORT:T3(Arguments)

Trace a function logic level 3.

AI_ESCORT:TraceAll(TraceAll)

Trace all methods in MOOSE

AI_ESCORT:TraceClass(Class)

Set tracing for a class

AI_ESCORT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AI_ESCORT:TraceLevel(Level)

Set trace level

AI_ESCORT:TraceOff()

Set trace off.

AI_ESCORT:TraceOn()

Set trace on.

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

AI_ESCORT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

AI_ESCORT._

AI_ESCORT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AI_ESCORT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AI_ESCORT.__

AI_ESCORT:onEvent(event)

The main event handling function...

Fields and Methods inherited from MENUPARAM Description

MENUPARAM.ParamDistance

MENUPARAM.ParamFunction

MENUPARAM.ParamMessage

MENUPARAM.ParamSelf

Field(s)

#number AI_ESCORT.CT1
AI_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...

#number AI_ESCORT.GT1

Function(s)

Measure distance between coordinate player and coordinate detected item.

Defined in:

AI_ESCORT

Parameters:

PlayerUnit

DetectedItem

Defined in:

AI_ESCORT

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

Defined in:

AI_ESCORT

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:

AI_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:

Defined in:

AI_ESCORT

Parameters:

Formation

...

Defines a menu slot to let the escort to join in a box formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

Return value:

Defines a menu slot to let the escort to join in a center wing formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

Defines a menu slot to let the escort to join in a leFt wing formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

Defines a menu slot to let the escort to join in a left wing formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

Defines a menu slot to let the escort to join in a right line formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

Defines a menu slot to let the escort to join in a right wing formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

Defines a menu slot to let the escort to join in a stacked formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

Return value:

Defines a menu slot to let the escort to join in a trail formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

Return value:

Defines a menu slot to let the escort to join in a vic formation.

This menu will appear under Formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

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:

AI_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 Speed

Optional parameter that lets the escort orbit with a specified speed. The default value is a speed that is average for the type of airplane or helicopter.

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

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:

AI_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 Speed

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 --- Defines a menu slot to let the escort to join formation.

Defined in:

AI_ESCORT

Return value:

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

All rules of engagement will appear under the menu ROE.

Defined in:

AI_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:

AI_ESCORT

Parameter:

MenuTextFormat

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:

AI_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:

AI_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 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:

AI_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 the default menus for airplanes.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

Return value:

Defines the default menus for helicopters.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#nubmer ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

Return value:

AI_ESCORT class constructor for an AI group

Defined in:

AI_ESCORT

Parameters:

The client escorted by the EscortGroup.

Core.Set#SET_GROUP EscortGroupSet

The set of group AI escorting the EscortUnit.

#string EscortName

Name of the escort.

#string EscortBriefing

A text showing the AI_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 EscortUnit = 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 = AI_ESCORT:New( EscortUnit, 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:

AI_ESCORT

Return value:

#table:

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

Detection methods are based on the derived classes from DETECTION_BASE.

Defined in:

AI_ESCORT

Parameter:

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Sets a menu slot to join formation for an escort.

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Return value:

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Parameter:

EscortGroup

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:

AI_ESCORT

Parameter:

EscortGroup

Return value:

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Parameter:

Formation

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Parameter:

ReportType

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:

AI_ESCORT

Parameter:

#boolean SmokeDirection

If true, then the direction vector will be smoked.

  • @param #AI_ESCORT self

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

The escort group that will attack the detected item.

self

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

The escort group that will attack the detected item.

Lets the escort to join in a stacked formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

EscortGroup

Return value:

Lets the escort to join in a trail formation.

Defined in:

AI_ESCORT

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#nubmer YStart

The start position on the Y-axis in meters for the first group.

EscortGroup

Return value:

Defined in:

AI_ESCORT

Parameters:

EscortGroup

Color

Message

Defined in:

AI_ESCORT

Parameter:

TargetType

Defined in:

AI_ESCORT

Parameter:

DetectedItem

Defined in:

AI_ESCORT

Parameters:

Color

Message

Defined in:

AI_ESCORT

Parameters:

XStart

XSpace

YStart

YSpace

Defined in:

AI_ESCORT

Parameters:

XStart

XSpace

YStart

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP OrbitGroup

#number OrbitHeight

#number OrbitSeconds

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Parameter:

EscortROEMessage

Defined in:

AI_ESCORT

Parameter:

EscortROEMessage

Defined in:

AI_ESCORT

Parameter:

EscortROEMessage

Defined in:

AI_ESCORT

Parameter:

EscortROEMessage

Defined in:

AI_ESCORT

Parameter:

EscortROTMessage

Defined in:

AI_ESCORT

Parameter:

EscortROTMessage

Defined in:

AI_ESCORT

Parameter:

EscortROTMessage

Defined in:

AI_ESCORT

Parameter:

EscortROTMessage

Report Targets Scheduler for the flight.

The report is generated from the perspective of the player plane, and is reported by the first plane in the formation set.

Defined in:

AI_ESCORT

Parameter:

Wrapper.Group#GROUP EscortGroup

Defined in:

AI_ESCORT

Parameters:

Color

Message

Defined in:

AI_ESCORT

Parameter:

ReportTargets

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP OrbitGroup

Wrapper.Group#GROUP EscortGroup

#number OrbitHeight

#number OrbitSeconds

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Defined in:

AI_ESCORT

Parameters:

EscortGroup

EscortROEFunction

EscortROEMessage

Defined in:

AI_ESCORT

Parameters:

EscortGroup

EscortROTFunction

EscortROTMessage

Defined in:

AI_ESCORT

Parameter:

EscortGroup

Report Targets Scheduler.

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

Report

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

#number WayPoint

Resume Scheduler.

Defined in:

AI_ESCORT

Parameter:

Wrapper.Group#GROUP EscortGroup

Defined in:

AI_ESCORT

Parameter:

ScanDuration

Defined in:

AI_ESCORT

Parameters:

EscortGroup

Color

Message

Defined in:

AI_ESCORT

Parameters:

Wrapper.Group#GROUP EscortGroup

#AI_ESCORT self

Defined in:

AI_ESCORT

Parameter:

Core.Set#SET_GROUP EscortGroupSet

Defined in:

AI_ESCORT

Parameter:

Core.Set#SET_GROUP EscortGroupSet

Field(s)

#number AI_ESCORT.CT1
AI_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...

#number AI_ESCORT.GT1

Function(s)

Follow me.

Defined in:

Parameters:

Wrapper.Group#GROUP FollowGroup

Follow group.

Wrapper.Unit#UNIT ClientUnit

Client Unit.

DCS#Time CT1

Time

DCS#Vec3 CV1

Vec3

DCS#Time CT2

Time

DCS#Vec3 CV2

Vec3

FormationBox Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

FormationCenterWing Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftLine Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftWing Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLine Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationRightLine Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationRightWing Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationStack Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

FormationTrail Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

FormationVic Trigger for AI_FORMATION

Defined in:

Parameters:

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Gets your escorts to flight mode.

Defined in:

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

AI_FORMATION class constructor for an AI group

Defined in:

Parameters:

Wrapper.Unit#UNIT FollowUnit

The UNIT leading the FolllowGroupSet.

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string FollowName

Name of the escort.

#string FollowBriefing

Briefing.

Return value:

FormationBox Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

FormationCenterWing Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftLine Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftWing Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLine Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationRightLine Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationRightWing Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationStack Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

FormationTrail Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

FormationVic Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationBox Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

Return value:

#boolean:

FormationCenterWing Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

FormationLeftLine Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

FormationLeftWing Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

FormationLine Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

FormationRightLine Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

FormationRightWing Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

FormationStack Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

Return value:

#boolean:

FormationTrail Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

Return value:

#boolean:

FormationVic Handler OnBefore for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

#boolean:

This sets your escorts to execute an attack.

Defined in:

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

This sets your escorts to fly in a formation.

Defined in:

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

This sets your escorts to fly a mission.

Defined in:

Parameter:

Wrapper.Group#GROUP FollowGroup

FollowGroup.

Return value:

Use the method AI.AI_Formation#AI_FORMATION.SetFlightRandomization() to make the air units in your formation randomize their flight a bit while in formation.

Defined in:

Parameter:

#number FlightRandomization

The formation flying errors that pilots can make while in formation. Is a range set in meters.

Return value:

Set time interval between updates of the formation.

Defined in:

Parameter:

#number dt

Time step in seconds between formation updates. Default is every 0.5 seconds.

Return value:

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:

Parameter:

#boolean SmokeDirection

If true, then the direction vector will be smoked.

Return value:

FormationBox Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

FormationCenterWing Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftLine Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftWing Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLine Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationRightLine Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationRightWing Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationStack Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

FormationTrail Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

FormationVic Asynchronous Trigger for AI_FORMATION

Defined in:

Parameters:

#number Delay

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationBox Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

#number ZLevels

The amount of levels on the Z-axis.

FollowGroupSet

Return value:

FormationCenterWing Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLeftLine Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

FormationLeftWing Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FormationLine Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Formation

Return value:

FormationRightLine Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

Return value:

Defined in:

Parameters:

FollowGroupSet

From

Event

To

XStart

XSpace

YStart

ZStart

ZSpace

FormationStack Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

Return value:

FormationTrail Handler OnAfter for AI_FORMATION

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The group AI escorting the FollowUnit.

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

Return value:

FormationVic Handle for AI_FORMATION

Defined in:

Parameters:

#string From

#string Event

#string To

#number XStart

The start position on the X-axis in meters for the first group.

#number XSpace

The space between groups on the X-axis in meters for each sequent group.

#number YStart

The start position on the Y-axis in meters for the first group.

#number YSpace

The space between groups on the Y-axis in meters for each sequent group.

#number ZStart

The start position on the Z-axis in meters for the first group.

#number ZSpace

The space between groups on the Z-axis in meters for each sequent group.

FollowGroupSet

Return value:

Stop function.

Formation will not be updated any more.

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The following set of groups.

#string From

From state.

#string Event

Event.

#string To

The to state.

Follow event fuction.

Check if coming from state "stopped". If so the transition is rejected.

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The following set of groups.

#string From

From state.

#string Event

Event.

#string To

The to state.

Enter following state.

Defined in:

Parameters:

Core.Set#SET_GROUP FollowGroupSet

The following set of groups.

#string From

From state.

#string Event

Event.

#string To

The to state.

Field(s)

#number AI_ESCORT.CT1
AI_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...

#number AI_ESCORT.GT1

Function(s)

Gets the SET_BASE object that the FSM_SET governs.

Defined in:

Return value:

Creates a new FSM_SET object.

Defined in:

Parameters:

#table FSMT

Finite State Machine Table

Set_SET_BASE

FSMSet (optional) The Set object that the FSM_SET governs.

FSMSet

Return value:

Defined in:

Parameters:

step

trigger

params

EventName

Field(s)

#number AI_ESCORT.CT1
AI_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...

#number AI_ESCORT.GT1

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#number AI_ESCORT.CT1
AI_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...

#number AI_ESCORT.GT1

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.

IniObjectCategory

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.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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.

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.

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 Core.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 Core.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, set to nil, 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:

Event ID.

#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 Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

The EventData structure.

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

Discard chair after ejection.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • initiator: The unit that killed the target
  • target: Target Object
  • weapon: Weapon Object

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

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 shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
  • subplace: is always 0 for unknown reasons.

Defined in:

Parameter:

The EventData structure.

Landing quality mark.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes. 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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. 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.

Trigger zone.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

  • initiator: The unit that is was destroyed.

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:

#string:

The Schedule ID 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:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

Set the Class Core.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 Core.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, set to nil, 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

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

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:

Event ID.

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

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event