Banner Image

Module Ops.Auftrag

Ops - Auftrag (mission) for Ops.

Main Features:

  • Simplifies defining and executing DCS tasks.
  • Additional useful events.
  • Set mission start/stop times.
  • Set mission priority and urgency (can cancel running missions).
  • Specific mission options for ROE, ROT, formation, etc.
  • Interface to FLIGHTGROUP, AIRWING and WINGCOMMANDER classes.
  • FSM events when a mission is done, successful or failed.

Author: funkyfranky

Global(s)

Global AUFTRAG

A warrior's mission is to foster the success of others. --- Morihei Ueshiba


Banner Image

The AUFTRAG Concept

As you probably know, setting tasks in DCS is often tedious.

#AUFTRAG AUFTRAG

A warrior's mission is to foster the success of others. --- Morihei Ueshiba


Banner Image

The AUFTRAG Concept

As you probably know, setting tasks in DCS is often tedious.

The AUFTRAG class significantly simplifies the necessary workflow by using optimized default parameters.

You can think of an AUFTRAG as document, which contains the mission briefing, i.e. information about the target location, mission altitude, speed and various other parameters. This document can be handed over directly to a pilot (or multiple pilots) via the FLIGHTGROUP class. The pilots will then execute the mission. The AUFTRAG document can also be given to an AIRWING. The airwing will then determine the best assets (pilots and payloads) available for the job. One more up the food chain, an AUFTRAG can be passed to a WINGCOMMANDER. The wing commander will find the best AIRWING and pass the job over to it.

Airborne Missions

Several mission types are supported by this class.

Anti-Ship

An anti-ship mission can be created with the AUFTRAG.NewANTISHIP(Target, Altitude) function.

AWACS

An AWACS mission can be created with the AUFTRAG.NewAWACS() function.

BAI

A BAI mission can be created with the AUFTRAG.NewBAI() function.

Bombing

A bombing mission can be created with the AUFTRAG.NewBOMBING() function.

Bombing Runway

A bombing runway mission can be created with the AUFTRAG.NewBOMBRUNWAY() function.

Bombing Carpet

A carpet bombing mission can be created with the AUFTRAG.NewBOMBCARPET() function.

CAP

A CAP mission can be created with the AUFTRAG.NewCAP() function.

CAS

A CAS mission can be created with the AUFTRAG.NewCAS() function.

Escort

An escort mission can be created with the AUFTRAG.NewESCORT() function.

FACA

An FACA mission can be created with the AUFTRAG.NewFACA() function.

Ferry

Not implemented yet.

Intercept

An intercept mission can be created with the AUFTRAG.NewINTERCEPT() function.

Orbit

An orbit mission can be created with the AUFTRAG.NewORBIT() function.

PATROL

An patrol mission can be created with the AUFTRAG.NewPATROL() function.

RECON

Not implemented yet.

RESCUE HELO

An rescue helo mission can be created with the AUFTRAG.NewRESCUEHELO() function.

SEAD

An SEAD mission can be created with the AUFTRAG.NewSEAD() function.

STRIKE

An strike mission can be created with the AUFTRAG.NewSTRIKE() function.

Tanker

A refueling tanker mission can be created with the AUFTRAG.NewTANKER() function.

TROOPTRANSPORT

A troop transport mission can be created with the AUFTRAG.NewTROOPTRANSPORT() function.

Ground Missions

ARTY

An arty mission can be created with the AUFTRAG.NewARTY() function.

Options and Parameters

Assigning Missions

An AUFTRAG can be assigned to groups, airwings or wingcommanders

Group Level

Flight Group

Assigning an AUFTRAG to a flight groups is done via the Ops.FlightGroup#FLIGHTGROUP.AddMission function. See FLIGHTGROUP docs for details.

Navy Group

Assigning an AUFTRAG to a navy groups is done via the Ops.NavyGroup#NAVYGROUP.AddMission function. See NAVYGROUP docs for details.

Airwing Level

Adding an AUFTRAG to an airwing is done via the Ops.AirWing#AIRWING.AddMission function. See AIRWING docs for further details.

Wing Commander Level

Assigning an AUFTRAG to a wing commander is done via the Ops.WingCommander#WINGCOMMANDER.AddMission function. See WINGCOMMADER docs for details.

Events

The AUFTRAG class creates many useful (FSM) events, which can be used in the mission designers script.

Examples

Global _AUFTRAGSNR

Global mission counter.

#number _AUFTRAGSNR

Global mission counter.

Type(s)

AUFTRAG , extends Core.Fsm#FSM , extends Core.Base#BASE
Fields and Methods inherited from AUFTRAG Description

AUFTRAG:AddAsset(Asset)

Add asset to mission.

AUFTRAG:AddConditionFailure(ConditionFunction, ...)

Add failure condition.

AUFTRAG:AddConditionStart(ConditionFunction, ...)

Add start condition.

AUFTRAG:AddConditionSuccess(ConditionFunction, ...)

Add success condition.

AUFTRAG:AddOpsGroup(OpsGroup)

Add a Ops group to the mission.

AUFTRAG:AssignSquadrons(Squadrons)

Assign airwing squadron(s) to the mission.

AUFTRAG:CheckGroupsDone()

Check if all flights are done with their mission (or dead).

AUFTRAG.ClassName

Name of the class.

AUFTRAG:CountMissionTargets(Target)

Count alive mission targets.

AUFTRAG:CountOpsGroups()

Count alive flight groups assigned for this mission.

AUFTRAG.DCStask

DCS task structure.

AUFTRAG.Debug

Debug mode. Messages to all about status.

AUFTRAG:DelAsset(Asset)

Delete asset from mission.

AUFTRAG:DelOpsGroup(OpsGroup)

Remove an Ops group from the mission.

AUFTRAG:EvalConditionsAll(Conditions)

Check if all given condition are true.

AUFTRAG:EvalConditionsAny(Conditions)

Check if any of the given conditions is true.

AUFTRAG:Evaluate()

Evaluate mission outcome - success or failure.

AUFTRAG:GetAssetByName(Name)

Get asset by its spawn group name.

AUFTRAG:GetAssetDataByName(AssetName)

Get asset data table.

AUFTRAG:GetDCSMissionTask(TaskControllable)

Get DCS task table for the given mission.

AUFTRAG:GetGroupData(opsgroup)

Get flight data table.

AUFTRAG:GetGroupStatus(opsgroup)

Get ops group mission status.

AUFTRAG:GetGroupWaypointCoordinate(opsgroup)

Get opsgroup waypoint coordinate.

AUFTRAG:GetGroupWaypointIndex(opsgroup)

Get opsgroup waypoint index.

AUFTRAG:GetGroupWaypointTask(opsgroup)

Get opsgroup waypoint task.

AUFTRAG:GetMissionTypesText(MissionTypes)

Get coordinate of target.

AUFTRAG:GetMissionWaypointCoord(group)

Get coordinate of target.

AUFTRAG:GetObjective()

Get mission objective object.

AUFTRAG:GetOpsGroups()

Get all OPS groups.

AUFTRAG:GetTargetCoordinate()

Get coordinate of target.

AUFTRAG:GetTargetDamage()

Get target damage.

AUFTRAG:GetTargetData()

Get coordinate of target.

AUFTRAG:GetTargetDistance(FromCoord)

Get distance to target.

AUFTRAG:GetTargetInitialLife()

Get target life points.

AUFTRAG:GetTargetLife()

Get target life points.

AUFTRAG:GetTargetName()

Get name of the target.

AUFTRAG:GetTargetType()

Get type of target.

AUFTRAG:GetTargetVec2()

Get 2D vector of target.

AUFTRAG.GroupStatus

AUFTRAG:IsCancelled()

Check if mission was cancelled.

AUFTRAG:IsDone()

Check if mission is done.

AUFTRAG:IsExecuting()

Check if mission is executing.

AUFTRAG:IsNotOver()

Check if mission is NOT over.

AUFTRAG:IsOver()

Check if mission is over.

AUFTRAG:IsPlanned()

Check if mission is PLANNED.

AUFTRAG:IsQueued()

Check if mission is QUEUED at an AIRWING mission queue.

AUFTRAG:IsReadyToCancel()

Check if mission is ready to be started.

AUFTRAG:IsReadyToGo()

Check if mission is ready to be started.

AUFTRAG:IsRequested()

Check if mission is REQUESTED, i.e.

AUFTRAG:IsScheduled()

Check if mission is SCHEDULED, i.e.

AUFTRAG:IsStarted()

Check if mission is STARTED, i.e.

AUFTRAG:IsSuccess()

Check if mission was a success.

AUFTRAG:New(Type)

Create a new generic AUFTRAG object.

AUFTRAG:NewANTISHIP(Target, Altitude)

Create an ANTI-SHIP mission.

AUFTRAG:NewARTY(Target, Nshots, Radius)

Create an ARTY mission.

AUFTRAG:NewAUTO(EngageGroup)

Create a mission to attack a group.

AUFTRAG:NewAWACS(Coordinate, Altitude, Speed, Heading, Leg)

Create a AWACS mission.

AUFTRAG:NewBAI(Target, Altitude)

Create a BAI mission.

AUFTRAG:NewBOMBCARPET(Target, Altitude, CarpetLength)

Create a CARPET BOMBING mission.

AUFTRAG:NewBOMBING(Target, Altitude)

Create a BOMBING mission.

AUFTRAG:NewBOMBRUNWAY(Airdrome, Altitude)

Create a BOMBRUNWAY mission.

AUFTRAG:NewCAP(ZoneCAP, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes)

Create a CAP mission.

AUFTRAG:NewCAS(ZoneCAS, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes)

Create a CAS mission.

AUFTRAG:NewESCORT(EscortGroup, OffsetVector, EngageMaxDistance, TargetTypes)

Create an ESCORT (or FOLLOW) mission.

AUFTRAG:NewFACA(Target, Designation, DataLink, Frequency, Modulation)

Create a FACA mission.

AUFTRAG:NewINTERCEPT(Target)

Create an INTERCEPT mission.

AUFTRAG:NewORBIT(Coordinate, Altitude, Speed, Heading, Leg)

Create an ORBIT mission, which can be either a circular orbit or a race-track pattern.

AUFTRAG:NewORBIT_CIRCLE(Coordinate, Altitude, Speed)

Create an ORBIT mission, where the aircraft will go in a circle around the specified coordinate.

AUFTRAG:NewORBIT_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg)

Create an ORBIT mission, where the aircraft will fly a race-track pattern.

AUFTRAG:NewPATROL(Coordinate, Altitude, Speed, Heading, Leg)

Create a PATROL mission.

AUFTRAG:NewRESCUEHELO(Carrier)

Create a RESCUE HELO mission.

AUFTRAG:NewSEAD(Target, Altitude)

Create a SEAD mission.

AUFTRAG:NewSTRIKE(Target, Altitude)

Create a STRIKE mission.

AUFTRAG:NewTANKER(Coordinate, Altitude, Speed, Heading, Leg, RefuelSystem)

Create a TANKER mission.

AUFTRAG:NewTROOPTRANSPORT(TransportGroupSet, DropoffCoordinate, PickupCoordinate)

Create a TROOP TRANSPORT mission.

AUFTRAG.Ntargets

Number of mission targets.

AUFTRAG:OnEventUnitLost(EventData)

Unit lost event.

AUFTRAG:SetEngageAltitude(Altitude)

Set engage altitude.

AUFTRAG:SetEngageAsGroup(Switch)

Set whether target will be attack as group.

AUFTRAG:SetEngageRange(Range)

Set max engage range.

AUFTRAG:SetFormation(Formation)

Set formation for this mission.

AUFTRAG:SetGroupStatus(opsgroup, status)

Set opsgroup mission status.

AUFTRAG:SetGroupWaypointCoordinate(opsgroup, coordinate)

Set Ops group waypoint coordinate.

AUFTRAG:SetGroupWaypointIndex(opsgroup, waypointindex)

Set opsgroup waypoint index.

AUFTRAG:SetGroupWaypointTask(opsgroup, task)

Set Ops group waypoint task.

AUFTRAG:SetMissionAltitude(Altitude)

Set mission altitude.

AUFTRAG:SetName(Name)

Set mission name.

AUFTRAG:SetPriority(Prio, Urgent)

Set mission priority and (optional) urgency.

AUFTRAG:SetROE(roe)

Set Rules of Engagement (ROE) for this mission.

AUFTRAG:SetROT(roe, rot)

Set Reaction on Threat (ROT) for this mission.

AUFTRAG:SetRadio(Frequency, Modulation)

Set radio frequency and modulation for this mission.

AUFTRAG:SetRepeatOnFailure(Nrepeat)

Set how many times the mission is repeated if it fails.

AUFTRAG:SetRequiredAssets(Nassets)

Define how many assets are required to do the job.

AUFTRAG:SetTACAN(Channel, Morse)

Set TACAN beacon channel and Morse code for this mission.

AUFTRAG:SetTime(ClockStart, ClockStop)

Set mission start and stop time.

AUFTRAG:SetWeaponExpend(WeaponExpend)

Set number of weapons to expend.

AUFTRAG:SetWeaponType(WeaponType)

Set weapon type used for the engagement.

AUFTRAG.Status

AUFTRAG.TargetType

AUFTRAG.Tover

Mission abs. time stamp, when mission was over.

AUFTRAG.Tstart

Mission start time in seconds.

AUFTRAG.Tstop

Mission stop time in seconds.

AUFTRAG.Type

AUFTRAG:UpdateMarker()

Update mission F10 map marker.

AUFTRAG:_GetDCSAttackTask(target, DCStasks)

Get DCS task table for an attack group or unit task.

AUFTRAG:_GetTargetLife(Target, Healthy)

Get target life points.

AUFTRAG:_SetLogID()

Set log ID string.

AUFTRAG:_TargetFromObject(Object)

Create target data from a given object.

AUFTRAG.airwing

The assigned airwing.

AUFTRAG.artyRadius

Radius in meters.

AUFTRAG.artyShots

Number of shots fired.

AUFTRAG.assets

Airwing Assets assigned for this mission.

AUFTRAG.auftragsnummer

Auftragsnummer.

AUFTRAG.cancelContactLost

If true, cancel mission if the contact is lost.

AUFTRAG.conditionFailure

If all stop conditions are true, the mission is cancelled.

AUFTRAG.conditionStart

Condition(s) that have to be true, before the mission will be started.

AUFTRAG.conditionSuccess

If all stop conditions are true, the mission is cancelled.

AUFTRAG.dTevaluate

Time interval in seconds before the mission result is evaluated after mission is over.

AUFTRAG.duration

Mission duration in seconds.

AUFTRAG.engageAltitude

Engagement altitude in meters.

AUFTRAG.engageAsGroup

Group attack.

AUFTRAG.engageDirection

Engagement direction in degrees.

AUFTRAG.engageMaxDistance

Max engage distance.

AUFTRAG.engageQuantity

Number of times a target is engaged.

AUFTRAG.engageRange

AUFTRAG.engageTarget

Target data to engage.

AUFTRAG.engageTargetTypes

Table of target types that are engaged in the engagement zone.

AUFTRAG.engageWeaponExpend

How many weapons are used.

AUFTRAG.engageWeaponType

Weapon type used.

AUFTRAG.engageZone

Circular engagement zone.

AUFTRAG.enrouteTasks

Mission enroute tasks.

AUFTRAG.escortGroup

The group to be escorted.

AUFTRAG.escortVec3

The 3D offset vector from the escorted group to the escort group.

AUFTRAG.facDatalink

FAC datalink enabled.

AUFTRAG.facDesignation

FAC designation type.

AUFTRAG.facFreq

FAC radio frequency in MHz.

AUFTRAG.facModu

FAC radio modulation 0=AM 1=FM.

AUFTRAG.failurecondition

AUFTRAG.groupdata

Group specific data.

AUFTRAG.lid

Class id string for output to DCS log file.

AUFTRAG.marker

F10 map marker.

AUFTRAG.missionAltitude

Mission altitude in meters.

AUFTRAG.missionFraction

Mission coordiante fraction. Default is 0.5.

AUFTRAG.missionRange

Mission range in meters. Used in AIRWING class.

AUFTRAG.missionRepeatMax

Number of times mission is repeated if failed.

AUFTRAG.missionRepeated

Number of times mission was repeated.

AUFTRAG.missionTask

Mission task. See ENUMS.MissionTask.

AUFTRAG.name

Mission name.

AUFTRAG.nassets

Number of required assets by the Airwing.

AUFTRAG:onafterAssetDead(From, Event, To, Asset)

On after "AssetDead" event.

AUFTRAG:onafterAssign(From, Event, To)

On after "Assign" event.

AUFTRAG:onafterCancel(From, Event, To)

On after "Cancel" event.

AUFTRAG:onafterDone(From, Event, To)

On after "Done" event.

AUFTRAG:onafterExecuting(From, Event, To)

On after "Execute" event.

AUFTRAG:onafterFailed(From, Event, To)

On after "Failed" event.

AUFTRAG:onafterGroupDead(From, Event, To, OpsGroup)

On after "GroupDead" event.

AUFTRAG:onafterQueued(From, Event, To, Airwing)

On after "Queue" event.

AUFTRAG:onafterRepeat(From, Event, To)

On after "Repeat" event.

AUFTRAG:onafterRequested(From, Event, To)

On after "Requested" event.

AUFTRAG:onafterScheduled(From, Event, To, FlightGroup)

On after "Schedule" event.

AUFTRAG:onafterStarted(From, Event, To)

On after "Start" event.

AUFTRAG:onafterStatus(From, Event, To)

On after "Status" event.

AUFTRAG:onafterStop(From, Event, To)

On after "Stop" event.

AUFTRAG:onafterSuccess(From, Event, To)

On after "Success" event.

AUFTRAG.optionCM

Counter measures.

AUFTRAG.optionECM

ECM.

AUFTRAG.optionFormation

Formation.

AUFTRAG.optionROE

ROE.

AUFTRAG.optionROT

ROT.

AUFTRAG.optionRTBammo

RTB on out-of-ammo.

AUFTRAG.optionRTBfuel

RTB on out-of-fuel.

AUFTRAG.orbitAltitude

Orbit altitude in meters.

AUFTRAG.orbitHeading

Orbit heading in degrees.

AUFTRAG.orbitLeg

Length of orbit leg in meters.

AUFTRAG.orbitRaceTrack

Race-track orbit coordinate.

AUFTRAG.orbitSpeed

Orbit speed in m/s.

AUFTRAG.patroldata

Patrol data.

AUFTRAG.prio

Mission priority.

AUFTRAG.radioFreq

Mission radio frequency in MHz.

AUFTRAG.radioModu

Mission radio modulation (0=AM and 1=FM).

AUFTRAG.refuelSystem

Refuel type (boom or probe) for TANKER missions.

AUFTRAG.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed.

AUFTRAG.squadrons

User specifed airwing squadrons assigned for this mission. Only these will be considered for the job!

AUFTRAG.status

Mission status.

AUFTRAG.successcondition

AUFTRAG.tacanChannel

Mission TACAN channel.

AUFTRAG.tacanMorse

Mission TACAN morse code.

AUFTRAG.transportDropoff

Coordinate where to drop off the cargo.

AUFTRAG.transportGroupSet

Groups to be transported.

AUFTRAG.transportPickup

Coordinate where to pickup the cargo.

AUFTRAG.type

Mission type.

AUFTRAG.urgent

Mission is urgent. Running missions with lower prio might be cancelled.

AUFTRAG.version

AUFTRAG class version.

AUFTRAG.wingcommander

The WINGCOMMANDER managing this mission.

Fields and Methods inherited from FSM Description

AUFTRAG:AddEndState(State)

Adds an End state.

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

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

AUFTRAG:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

AUFTRAG:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

AUFTRAG.CallScheduler

AUFTRAG.Events

AUFTRAG:GetCurrentState()

AUFTRAG:GetEndStates()

Returns the End states.

AUFTRAG:GetProcess(From, Event)

AUFTRAG:GetProcesses()

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

AUFTRAG:GetScores()

Returns a table with the scores defined.

AUFTRAG:GetStartState()

Returns the start state of the FSM.

AUFTRAG:GetState()

AUFTRAG:GetSubs()

Returns a table with the Subs defined.

AUFTRAG:GetTransitions()

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

AUFTRAG:Is(State)

AUFTRAG:LoadCallBacks(CallBackTable)

AUFTRAG:New()

Creates a new FSM object.

AUFTRAG.Scores

AUFTRAG:SetProcess(From, Event, Fsm)

AUFTRAG:SetStartState(State)

Sets the start state of the FSM.

AUFTRAG._EndStates

AUFTRAG._EventSchedules

AUFTRAG._Processes

AUFTRAG._Scores

AUFTRAG._StartState

AUFTRAG._Transitions

AUFTRAG:_add_to_map(Map, Event)

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

AUFTRAG:_create_transition(EventName)

AUFTRAG:_delayed_transition(EventName)

AUFTRAG:_eventmap(Events, EventStructure)

AUFTRAG:_gosub(ParentFrom, ParentEvent)

AUFTRAG:_handler(EventName, ...)

AUFTRAG:_isendstate(Current)

AUFTRAG:_submap(subs, sub, name)

AUFTRAG:can(e)

AUFTRAG:cannot(e)

AUFTRAG.current

AUFTRAG.endstates

AUFTRAG:is(state)

AUFTRAG.options

AUFTRAG.subs

Fields and Methods inherited from BASE Description

AUFTRAG.ClassID

The ID number of the class.

AUFTRAG.ClassName

The name of the class.

AUFTRAG.ClassNameAndID

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

AUFTRAG:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

AUFTRAG:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

AUFTRAG:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

AUFTRAG:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

AUFTRAG:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

AUFTRAG:E(Arguments)

Log an exception which will be traced always.

AUFTRAG:EventDispatcher()

Returns the event dispatcher

AUFTRAG:EventRemoveAll()

Remove all subscribed events

AUFTRAG:F(Arguments)

Trace a function call.

AUFTRAG:F2(Arguments)

Trace a function call level 2.

AUFTRAG:F3(Arguments)

Trace a function call level 3.

AUFTRAG:GetClassID()

Get the ClassID of the class instance.

AUFTRAG:GetClassName()

Get the ClassName of the class instance.

AUFTRAG:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

AUFTRAG:GetEventPriority()

Get the Class Event processing Priority.

AUFTRAG:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

AUFTRAG:GetState(Object, Key)

Get a Value given a Key from the Object.

AUFTRAG:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

AUFTRAG:I(Arguments)

Log an information which will be traced always.

AUFTRAG:Inherit(Child, Parent)

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

AUFTRAG:IsInstanceOf(ClassName)

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

AUFTRAG:IsTrace()

Enquires if tracing is on (for the class).

AUFTRAG:New()

BASE constructor.

AUFTRAG:OnEvent(EventData)

Occurs when an object is completely destroyed.

AUFTRAG:OnEventBaseCaptured(EventData)

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

AUFTRAG:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

AUFTRAG:OnEventCrash(EventData)

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

AUFTRAG:OnEventDead(EventData)

Occurs when an object is dead.

AUFTRAG:OnEventDetailedFailure(EventData)

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

AUFTRAG:OnEventEjection(EventData)

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

AUFTRAG:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

AUFTRAG:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

AUFTRAG:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

AUFTRAG:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

AUFTRAG:OnEventKill(EventData)

Occurs on the death of a unit.

AUFTRAG:OnEventLand(EventData)

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

AUFTRAG:OnEventLandingAfterEjection(EventData)

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

AUFTRAG:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

AUFTRAG:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

AUFTRAG:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

AUFTRAG:OnEventMissionEnd(EventData)

Occurs when a mission ends

AUFTRAG:OnEventMissionStart(EventData)

Occurs when a mission starts

AUFTRAG:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

AUFTRAG:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

AUFTRAG:OnEventPlayerLeaveUnit(EventData)

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

AUFTRAG:OnEventRefueling(EventData)

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

AUFTRAG:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

AUFTRAG:OnEventScore(EventData)

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

AUFTRAG:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

AUFTRAG:OnEventShootingStart(EventData)

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

AUFTRAG:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

AUFTRAG:OnEventTakeoff(EventData)

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

AUFTRAG:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

AUFTRAG:ScheduleStop(SchedulerFunction)

Stops the Schedule.

AUFTRAG.Scheduler

AUFTRAG:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

AUFTRAG:SetState(Object, Key, Value)

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

AUFTRAG:T(Arguments)

Trace a function logic level 1.

AUFTRAG:T2(Arguments)

Trace a function logic level 2.

AUFTRAG:T3(Arguments)

Trace a function logic level 3.

AUFTRAG:TraceAll(TraceAll)

Trace all methods in MOOSE

AUFTRAG:TraceClass(Class)

Set tracing for a class

AUFTRAG:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

AUFTRAG:TraceLevel(Level)

Set trace level

AUFTRAG:TraceOff()

Set trace off.

AUFTRAG:TraceOn()

Set trace on.

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

AUFTRAG:UnHandleEvent(Event)

UnSubscribe to a DCS event.

AUFTRAG._

AUFTRAG:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

AUFTRAG:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

AUFTRAG.__

AUFTRAG:onEvent(event)

Fields and Methods inherited from AUFTRAG.Capability Description

AUFTRAG.Capability.MissionType

Type of mission.

AUFTRAG.Capability.Performance

Number describing the performance level. The higher the better.

Fields and Methods inherited from AUFTRAG.Condition Description

AUFTRAG.Condition.arg

Optional arguments passed to the condition callback function.

AUFTRAG.Condition.func

Callback function to check for a condition. Should return a #boolean.

Fields and Methods inherited from AUFTRAG.GroupData Description

AUFTRAG.GroupData.asset

The squadron asset.

AUFTRAG.GroupData.opsgroup

The OPS group.

AUFTRAG.GroupData.status

Group mission status.

AUFTRAG.GroupData.waypointcoordinate

Waypoint coordinate.

AUFTRAG.GroupData.waypointindex

Waypoint index.

AUFTRAG.GroupData.waypointtask

Waypoint task.

Fields and Methods inherited from AUFTRAG.GroupStatus Description

AUFTRAG.GroupStatus.CANCELLED

Mission was cancelled.

AUFTRAG.GroupStatus.DONE

Mission task of the Ops group is done.

AUFTRAG.GroupStatus.EXECUTING

Ops group is executing this mission.

AUFTRAG.GroupStatus.PAUSED

Ops group has paused this mission, e.g. for refuelling.

AUFTRAG.GroupStatus.SCHEDULED

Mission is scheduled in a FLIGHGROUP queue waiting to be started.

AUFTRAG.GroupStatus.STARTED

Ops group started this mission but it is not executed yet.

Fields and Methods inherited from AUFTRAG.Status Description

AUFTRAG.Status.CANCELLED

Mission was cancelled.

AUFTRAG.Status.DONE

Mission is over.

AUFTRAG.Status.EXECUTING

Mission is being executed.

AUFTRAG.Status.FAILED

Mission failed.

AUFTRAG.Status.PLANNED

Mission is at the early planning stage.

AUFTRAG.Status.QUEUED

Mission is queued at an airwing.

AUFTRAG.Status.REQUESTED

Mission assets were requested from the warehouse.

AUFTRAG.Status.SCHEDULED

Mission is scheduled in a FLIGHGROUP queue waiting to be started.

AUFTRAG.Status.STARTED

Mission has started but is not executed yet.

AUFTRAG.Status.SUCCESS

Mission was a success.

AUFTRAG.Status.status

Fields and Methods inherited from AUFTRAG.Success Description

AUFTRAG.Success.DAMAGED

Target was damaged.

AUFTRAG.Success.DESTROYED

Target was destroyed.

AUFTRAG.Success.ENGAGED

Target was engaged.

AUFTRAG.Success.SURVIVED

Group did survive.

Fields and Methods inherited from AUFTRAG.TargetData Description

AUFTRAG.TargetData.Lifepoints

Total life points.

AUFTRAG.TargetData.Lifepoints0

Inital life points.

AUFTRAG.TargetData.Name

Target name.

AUFTRAG.TargetData.Ninital

Number of initial targets.

AUFTRAG.TargetData.Target

Target Object.

AUFTRAG.TargetData.Type

Target type: "Group", "Unit", "Static", "Coordinate", "Airbase", "SetGroup", "SetUnit".

Fields and Methods inherited from AUFTRAG.TargetType Description

AUFTRAG.TargetType.AIRBASE

Target is an AIRBASE.

AUFTRAG.TargetType.COORDINATE

Target is a COORDINATE.

AUFTRAG.TargetType.GROUP

Target is a GROUP object.

AUFTRAG.TargetType.SETGROUP

Target is a SET of GROUPs.

AUFTRAG.TargetType.SETUNIT

Target is a SET of UNITs.

AUFTRAG.TargetType.STATIC

Target is a STATIC object.

AUFTRAG.TargetType.UNIT

Target is a UNIT object.

Fields and Methods inherited from AUFTRAG.Type Description

AUFTRAG.Type.ANTISHIP

Anti-ship mission.

AUFTRAG.Type.ARTY

Fire at point.

AUFTRAG.Type.AWACS

AWACS mission.

AUFTRAG.Type.BAI

Battlefield Air Interdiction.

AUFTRAG.Type.BOMBCARPET

Carpet bombing.

AUFTRAG.Type.BOMBING

Bombing mission.

AUFTRAG.Type.BOMBRUNWAY

Bomb runway of an airbase.

AUFTRAG.Type.CAP

Combat Air Patrol.

AUFTRAG.Type.CAS

Close Air Support.

AUFTRAG.Type.ESCORT

Escort mission.

AUFTRAG.Type.FACA

Forward AirController airborne mission.

AUFTRAG.Type.FERRY

Ferry flight mission.

AUFTRAG.Type.INTERCEPT

Intercept mission.

AUFTRAG.Type.ORBIT

Orbit mission.

AUFTRAG.Type.PATROL

Similar to CAP but no auto engage targets.

AUFTRAG.Type.RECON

Recon mission.

AUFTRAG.Type.RECOVERYTANKER

Recovery tanker mission. Not implemented yet.

AUFTRAG.Type.RESCUEHELO

Rescue helo.

AUFTRAG.Type.SEAD

Suppression/destruction of enemy air defences.

AUFTRAG.Type.STRIKE

Strike mission.

AUFTRAG.Type.TANKER

Tanker mission.

AUFTRAG.Type.TROOPTRANSPORT

Troop transport mission.

AUFTRAG class.

Field(s)

#string AUFTRAG.ClassName

Name of the class.

#table AUFTRAG.DCStask

DCS task structure.

#boolean AUFTRAG.Debug

Debug mode. Messages to all about status.

#number AUFTRAG.Ntargets

Number of mission targets.

#number AUFTRAG.Tover

Mission abs. time stamp, when mission was over.

#number AUFTRAG.Tstart

Mission start time in seconds.

#number AUFTRAG.Tstop

Mission stop time in seconds.

Ops.AirWing#AIRWING AUFTRAG.airwing

The assigned airwing.

#number AUFTRAG.artyRadius

Radius in meters.

#number AUFTRAG.artyShots

Number of shots fired.

#table AUFTRAG.assets

Airwing Assets assigned for this mission.

#number AUFTRAG.auftragsnummer

Auftragsnummer.

#boolean AUFTRAG.cancelContactLost

If true, cancel mission if the contact is lost.

#table AUFTRAG.conditionFailure

If all stop conditions are true, the mission is cancelled.

#table AUFTRAG.conditionStart

Condition(s) that have to be true, before the mission will be started.

#table AUFTRAG.conditionSuccess

If all stop conditions are true, the mission is cancelled.

#number AUFTRAG.dTevaluate

Time interval in seconds before the mission result is evaluated after mission is over.

#number AUFTRAG.duration

Mission duration in seconds.

#number AUFTRAG.engageAltitude

Engagement altitude in meters.

#boolean AUFTRAG.engageAsGroup

Group attack.

#number AUFTRAG.engageDirection

Engagement direction in degrees.

#number AUFTRAG.engageMaxDistance

Max engage distance.

#number AUFTRAG.engageQuantity

Number of times a target is engaged.

#AUFTRAG.TargetData AUFTRAG.engageTarget

Target data to engage.

#table AUFTRAG.engageTargetTypes

Table of target types that are engaged in the engagement zone.

#number AUFTRAG.engageWeaponExpend

How many weapons are used.

#number AUFTRAG.engageWeaponType

Weapon type used.

Core.Zone#ZONE_RADIUS AUFTRAG.engageZone

Circular engagement zone.

#table AUFTRAG.enrouteTasks

Mission enroute tasks.

Wrapper.Group#GROUP AUFTRAG.escortGroup

The group to be escorted.

DCS#Vec3 AUFTRAG.escortVec3

The 3D offset vector from the escorted group to the escort group.

#boolean AUFTRAG.facDatalink

FAC datalink enabled.

#number AUFTRAG.facDesignation

FAC designation type.

#number AUFTRAG.facFreq

FAC radio frequency in MHz.

#number AUFTRAG.facModu

FAC radio modulation 0=AM 1=FM.

#table AUFTRAG.groupdata

Group specific data.

#string AUFTRAG.lid

Class id string for output to DCS log file.

#number AUFTRAG.missionAltitude

Mission altitude in meters.

#number AUFTRAG.missionFraction

Mission coordiante fraction. Default is 0.5.

#number AUFTRAG.missionRange

Mission range in meters. Used in AIRWING class.

#number AUFTRAG.missionRepeatMax

Number of times mission is repeated if failed.

#number AUFTRAG.missionRepeated

Number of times mission was repeated.

#string AUFTRAG.missionTask

Mission task. See ENUMS.MissionTask.

#string AUFTRAG.name

Mission name.

#number AUFTRAG.nassets

Number of required assets by the Airwing.

#number AUFTRAG.optionCM

Counter measures.

#number AUFTRAG.optionECM

ECM.

#number AUFTRAG.optionFormation

Formation.

#number AUFTRAG.optionROE

ROE.

#number AUFTRAG.optionROT

ROT.

#number AUFTRAG.optionRTBammo

RTB on out-of-ammo.

#number AUFTRAG.optionRTBfuel

RTB on out-of-fuel.

#number AUFTRAG.orbitAltitude

Orbit altitude in meters.

#number AUFTRAG.orbitHeading

Orbit heading in degrees.

#number AUFTRAG.orbitLeg

Length of orbit leg in meters.

Core.Point#COORDINATE AUFTRAG.orbitRaceTrack

Race-track orbit coordinate.

#number AUFTRAG.orbitSpeed

Orbit speed in m/s.

#number AUFTRAG.prio

Mission priority.

#number AUFTRAG.radioFreq

Mission radio frequency in MHz.

#number AUFTRAG.radioModu

Mission radio modulation (0=AM and 1=FM).

#number AUFTRAG.refuelSystem

Refuel type (boom or probe) for TANKER missions.

#number AUFTRAG.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed.

#table AUFTRAG.squadrons

User specifed airwing squadrons assigned for this mission. Only these will be considered for the job!

#string AUFTRAG.status

Mission status.

#number AUFTRAG.tacanChannel

Mission TACAN channel.

#number AUFTRAG.tacanMorse

Mission TACAN morse code.

Core.Point#COORDINATE AUFTRAG.transportDropoff

Coordinate where to drop off the cargo.

Core.Set#SET_GROUP AUFTRAG.transportGroupSet

Groups to be transported.

Core.Point#COORDINATE AUFTRAG.transportPickup

Coordinate where to pickup the cargo.

#string AUFTRAG.type

Mission type.

#boolean AUFTRAG.urgent

Mission is urgent. Running missions with lower prio might be cancelled.

#string AUFTRAG.version

AUFTRAG class version.

Ops.WingCommander#WINGCOMMANDER AUFTRAG.wingcommander

The WINGCOMMANDER managing this mission.

Function(s)

Add asset to mission.

Defined in:

AUFTRAG

Parameter:

The asset to be added to the mission.

Return value:

self

Add failure condition.

Defined in:

AUFTRAG

Parameters:

#function ConditionFunction

If this function returns true, the mission is cancelled.

...

Condition function arguments if any.

Return value:

self

Add start condition.

Defined in:

AUFTRAG

Parameters:

#function ConditionFunction

Function that needs to be true before the mission can be started. Must return a #boolean.

...

Condition function arguments if any.

Return value:

self

Add success condition.

Defined in:

AUFTRAG

Parameters:

#function ConditionFunction

If this function returns true, the mission is cancelled.

...

Condition function arguments if any.

Return value:

self

Add a Ops group to the mission.

Defined in:

AUFTRAG

Parameter:

The OPSGROUP object.

Assign airwing squadron(s) to the mission.

Only these squads will be considered for the job.

Defined in:

AUFTRAG

Parameter:

#table Squadrons

A table of SQUADRONs or a single SQUADRON object.

Return value:

self

Check if all flights are done with their mission (or dead).

Defined in:

AUFTRAG

Return value:

#boolean:

If true, all flights are done with the mission.

Count alive mission targets.

Defined in:

AUFTRAG

Parameter:

(Optional) The target object.

Return value:

#number:

Number of alive target units.

Count alive flight groups assigned for this mission.

Defined in:

AUFTRAG

Return value:

#number:

Number of alive flight groups.

Delete asset from mission.

Defined in:

AUFTRAG

Parameter:

The asset to be removed.

Return value:

self

Remove an Ops group from the mission.

Defined in:

AUFTRAG

Parameter:

The OPSGROUP object.

Check if all given condition are true.

Defined in:

AUFTRAG

Parameter:

#table Conditions

Table of conditions.

Return value:

#boolean:

If true, all conditions were true. Returns false if at least one condition returned false.

Check if any of the given conditions is true.

Defined in:

AUFTRAG

Parameter:

#table Conditions

Table of conditions.

Return value:

#boolean:

If true, at least one condition is true.

Evaluate mission outcome - success or failure.

Defined in:

AUFTRAG

Return value:

self

Get asset by its spawn group name.

Defined in:

AUFTRAG

Parameter:

#string Name

Asset spawn group name.

Return value:

Get asset data table.

Defined in:

AUFTRAG

Parameter:

#string AssetName

Name of the asset.

Return value:

Group data or nil if OPS group does not exist.

Get DCS task table for the given mission.

Defined in:

AUFTRAG

Parameter:

The controllable for which this task is set. Most tasks don't need it.

Return value:

The DCS task table. If multiple tasks are necessary, this is returned as a combo task.

Get flight data table.

Defined in:

AUFTRAG

Parameter:

The flight group.

Return value:

Flight data or nil if opsgroup does not exist.

Get ops group mission status.

Defined in:

AUFTRAG

Parameter:

The flight group.

Get opsgroup waypoint coordinate.

Defined in:

AUFTRAG

Parameter:

opsgroup

Return value:

Waypoint Coordinate.

Get opsgroup waypoint index.

Defined in:

AUFTRAG

Parameter:

The flight group.

Return value:

#number:

Waypoint index

Get opsgroup waypoint task.

Defined in:

AUFTRAG

Parameter:

The flight group.

Return value:

task Waypoint task. Waypoint task.

Get coordinate of target.

First unit/group of the set is used.

Defined in:

AUFTRAG

Parameter:

MissionTypes

Return value:

#string:

Get coordinate of target.

First unit/group of the set is used.

Defined in:

AUFTRAG

Parameter:

Group.

Return value:

Coordinate where the mission is executed.

Get mission objective object.

Could be many things depending on the mission type.

Defined in:

AUFTRAG

Return value:

The target object. Could be many things.

Get all OPS groups.

Defined in:

AUFTRAG

Return value:

#table:

Table of Ops.OpsGroup#OPSGROUP or {}.

Get coordinate of target.

Defined in:

AUFTRAG

Return value:

The target coordinate or nil.

Get target damage.

Defined in:

AUFTRAG

Return value:

#number:

Damage in percent.

Get coordinate of target.

Defined in:

AUFTRAG

Return value:

The target object. Could be many things.

Get distance to target.

Defined in:

AUFTRAG

Parameter:

The coordinate from which the distance is measured.

Return value:

#number:

Distance in meters or 0.

Get target life points.

Defined in:

AUFTRAG

Return value:

#number:

Number of initial life points when mission was planned.

Get target life points.

Defined in:

AUFTRAG

Return value:

#number:

Life points of target.

Get name of the target.

Defined in:

AUFTRAG

Return value:

#string:

Name of the target or "N/A".

Get type of target.

Defined in:

AUFTRAG

Return value:

#string:

The target type.

Get 2D vector of target.

Defined in:

AUFTRAG

Return value:

The target 2D vector or nil.

Check if mission was cancelled.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission was cancelled.

Check if mission is done.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is done.

Check if mission is executing.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is currently executing.

Check if mission is NOT over.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is NOT over yet.

Check if mission is over.

This could be state DONE or CANCELLED.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is currently executing.

Check if mission is PLANNED.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is in the planning state.

Check if mission is QUEUED at an AIRWING mission queue.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is queued.

Check if mission is ready to be started.

  • Mission stop already passed.
  • Any stop condition is true.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission should be cancelled.

Check if mission is ready to be started.

  • Mission start time passed.
  • Mission stop time did not pass already.
  • All start conditions are true.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission can be started.

Check if mission is REQUESTED, i.e.

request for WAREHOUSE assets is done.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is requested.

Check if mission is SCHEDULED, i.e.

request for WAREHOUSE assets is done.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is queued.

Check if mission is STARTED, i.e.

group is on its way to the mission execution waypoint.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is started.

Check if mission was a success.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission was successful.

Create a new generic AUFTRAG object.

Defined in:

AUFTRAG

Parameter:

#string Type

Mission type.

Return value:

self

Create an ANTI-SHIP mission.

Defined in:

AUFTRAG

Parameters:

The target to attack. Can be passed as a Wrapper.Group#GROUP or Wrapper.Unit#UNIT object.

#number Altitude

Engage altitude in feet. Default 2000 ft.

Return value:

self

Create an ARTY mission.

Defined in:

AUFTRAG

Parameters:

Center of the firing solution.

#number Nshots

Number of shots to be fired. Default 3.

#number Radius

Radius of the shells in meters. Default 100 meters.

Return value:

self

Create a mission to attack a group.

Mission type is automatically chosen from the group category.

Defined in:

AUFTRAG

Parameter:

Wrapper.Group#GROUP EngageGroup

Group to be engaged.

Return value:

self

Create a AWACS mission.

Defined in:

AUFTRAG

Parameters:

Where to orbit. Altitude is also taken from the coordinate.

#number Altitude

Orbit altitude in feet. Default is y component of Coordinate.

#number Speed

Orbit speed in knots. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default 270 (East to West).

#number Leg

Length of race-track in NM. Default 10 NM.

Return value:

self

Create a BAI mission.

Defined in:

AUFTRAG

Parameters:

The target to attack. Can be a GROUP, UNIT or STATIC object.

#number Altitude

Engage altitude in feet. Default 2000 ft.

Return value:

self

Create a CARPET BOMBING mission.

Defined in:

AUFTRAG

Parameters:

Target coordinate. Can also be specified as a GROUP, UNIT or STATIC object.

#number Altitude

Engage altitude in feet. Default 25000 ft.

#number CarpetLength

Length of bombing carpet in meters. Default 500 m.

Return value:

self

Create a BOMBING mission.

Flight will drop bombs a specified coordinate.

Defined in:

AUFTRAG

Parameters:

Target coordinate. Can also be specified as a GROUP, UNIT or STATIC object.

#number Altitude

Engage altitude in feet. Default 25000 ft.

Return value:

self

Create a BOMBRUNWAY mission.

Defined in:

AUFTRAG

Parameters:

The airbase to bomb. This must be an airdrome (not a FARP or ship) as these to not have a runway.

#number Altitude

Engage altitude in feet. Default 25000 ft.

Return value:

self

Create a CAP mission.

Defined in:

AUFTRAG

Parameters:

Circular CAP zone. Detected targets in this zone will be engaged.

#number Altitude

Altitude at which to orbit in feet. Default is 10,000 ft.

#number Speed

Orbit speed in knots. Default 350 kts.

Where to orbit. Default is the center of the CAP zone.

#number Heading

Heading of race-track pattern in degrees. If not specified, a simple circular orbit is performed.

#number Leg

Length of race-track in NM. If not specified, a simple circular orbit is performed.

#table TargetTypes

Table of target types. Default {"Air"}.

Return value:

self

Create a CAS mission.

Defined in:

AUFTRAG

Parameters:

Circular CAS zone. Detected targets in this zone will be engaged.

#number Altitude

Altitude at which to orbit. Default is 10,000 ft.

#number Speed

Orbit speed in knots. Default 350 KIAS.

Where to orbit. Default is the center of the CAS zone.

#number Heading

Heading of race-track pattern in degrees. If not specified, a simple circular orbit is performed.

#number Leg

Length of race-track in NM. If not specified, a simple circular orbit is performed.

#table TargetTypes

(Optional) Table of target types. Default {"Helicopters", "Ground Units", "Light armed ships"}.

Return value:

self

Create an ESCORT (or FOLLOW) mission.

Flight will escort another group and automatically engage certain target types.

Defined in:

AUFTRAG

Parameters:

Wrapper.Group#GROUP EscortGroup

The group to escort.

DCS#Vec3 OffsetVector

A table with x, y and z components specifying the offset of the flight to the escorted group. Default {x=200, y=0, z=-100} for 200 meters to the right, same alitude, 100 meters behind.

#number EngageMaxDistance

Max engage distance of targets in meters. Default auto (nil).

#table TargetTypes

Types of targets to engage automatically. Default is {"Air"}, i.e. all enemy airborne units. Use an empty set {} for a simple "FOLLOW" mission.

Return value:

self

Create a FACA mission.

Defined in:

AUFTRAG

Parameters:

Target group. Must be a GROUP object.

#string Designation

Designation of target. See AI.Task.Designation. Default AI.Task.Designation.AUTO.

#boolean DataLink

Enable data link. Default true.

#number Frequency

Radio frequency in MHz the FAC uses for communication. Default is 133 MHz.

#number Modulation

Radio modulation band. Default 0=AM. Use 1 for FM. See radio.modulation.AM or radio.modulaton.FM.

Return value:

self

Create an INTERCEPT mission.

Defined in:

AUFTRAG

Parameter:

The target to intercept. Can also be passed as simple Wrapper.Group#GROUP or Wrapper.Unit#UNIT object.

Return value:

self

Create an ORBIT mission, which can be either a circular orbit or a race-track pattern.

Defined in:

AUFTRAG

Parameters:

Where to orbit.

#number Altitude

Orbit altitude in feet. Default is y component of Coordinate.

#number Speed

Orbit speed in knots. Default 350 KIAS.

#number Heading

Heading of race-track pattern in degrees. If not specified, a circular orbit is performed.

#number Leg

Length of race-track in NM. If not specified, a circular orbit is performed.

Return value:

self

Create an ORBIT mission, where the aircraft will go in a circle around the specified coordinate.

Defined in:

AUFTRAG

Parameters:

Position where to orbit around.

#number Altitude

Orbit altitude in feet. Default is y component of Coordinate.

#number Speed

Orbit speed in knots. Default 350 KIAS.

Return value:

self

Create an ORBIT mission, where the aircraft will fly a race-track pattern.

Defined in:

AUFTRAG

Parameters:

Where to orbit.

#number Altitude

Orbit altitude in feet. Default is y component of Coordinate.

#number Speed

Orbit speed in knots. Default 350 KIAS.

#number Heading

Heading of race-track pattern in degrees. Default random in [0, 360) degrees.

#number Leg

Length of race-track in NM. Default 10 NM.

Return value:

self

Create a PATROL mission.

Defined in:

AUFTRAG

Parameters:

Where to orbit.

#number Altitude

Orbit altitude in feet. Default is y component of Coordinate.

#number Speed

Orbit speed in knots. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default random in [0, 360) degrees.

#number Leg

Length of race-track in NM. Default 10 NM.

Return value:

self

Create a RESCUE HELO mission.

Defined in:

AUFTRAG

Parameter:

The carrier unit.

Return value:

self

Create a SEAD mission.

Defined in:

AUFTRAG

Parameters:

The target to attack. Can be a GROUP or UNIT object.

#number Altitude

Engage altitude in feet. Default 2000 ft.

Return value:

self

Create a STRIKE mission.

Flight will attack the closest map object to the specified coordinate.

Defined in:

AUFTRAG

Parameters:

The target coordinate. Can also be given as a GROUP, UNIT or STATIC object.

#number Altitude

Engage altitude in feet. Default 2000 ft.

Return value:

self

Create a TANKER mission.

Defined in:

AUFTRAG

Parameters:

Where to orbit.

#number Altitude

Orbit altitude in feet. Default is y component of Coordinate.

#number Speed

Orbit speed in knots. Default 350 kts.

#number Heading

Heading of race-track pattern in degrees. Default 270 (East to West).

#number Leg

Length of race-track in NM. Default 10 NM.

#number RefuelSystem

Refueling system.

Return value:

self

Create a TROOP TRANSPORT mission.

Defined in:

AUFTRAG

Parameters:

Core.Set#SET_GROUP TransportGroupSet

The set group(s) to be transported.

Core.Point#COORDINATE DropoffCoordinate

Coordinate where the helo will land drop off the the troops.

Core.Point#COORDINATE PickupCoordinate

Coordinate where the helo will land to pick up the the cargo. Default is the fist transport group.

Return value:

self

Unit lost event.

Defined in:

AUFTRAG

Parameter:

Event data.

Set engage altitude.

Defined in:

AUFTRAG

Parameter:

#string Altitude

Altitude in feet. Default 6000 ft.

Return value:

self

Set whether target will be attack as group.

Defined in:

AUFTRAG

Parameter:

#boolean Switch

If true or nil, engage as group. If false, not.

Return value:

self

Set max engage range.

Defined in:

AUFTRAG

Parameter:

#number Range

Max range in NM. Default 100 NM.

Return value:

self

Set formation for this mission.

Defined in:

AUFTRAG

Parameter:

#number Formation

Formation.

Return value:

self

Set opsgroup mission status.

Defined in:

AUFTRAG

Parameters:

The flight group.

#string status

New status.

Set Ops group waypoint coordinate.

Defined in:

AUFTRAG

Parameters:

The flight group.

Waypoint Coordinate.

Set opsgroup waypoint index.

Defined in:

AUFTRAG

Parameters:

The flight group.

#number waypointindex

Waypoint index.

Set Ops group waypoint task.

Defined in:

AUFTRAG

Parameters:

The flight group.

Waypoint task.

Set mission altitude.

Defined in:

AUFTRAG

Parameter:

#string Altitude

Altitude in feet.

Return value:

self

Set mission name.

Defined in:

AUFTRAG

Parameter:

#string Name

Name of the mission. Default is "Auftrag Nr. X", where X is a running number, which is automatically increased.

Return value:

self

Set mission priority and (optional) urgency.

Urgent missions can cancel other running missions.

Defined in:

AUFTRAG

Parameters:

#number Prio

Priority 1=high, 100=low. Default 50.

#boolean Urgent

If true, another running mission might be cancelled if it has a lower priority.

Return value:

self

Set Rules of Engagement (ROE) for this mission.

Defined in:

AUFTRAG

Parameter:

#string roe

Mission ROE.

Return value:

self

Set Reaction on Threat (ROT) for this mission.

Defined in:

AUFTRAG

Parameters:

#string roe

Mission ROT.

rot

Return value:

self

Set radio frequency and modulation for this mission.

Defined in:

AUFTRAG

Parameters:

#number Frequency

Frequency in MHz.

#number Modulation

Radio modulation. Default 0=AM.

Return value:

self

Set how many times the mission is repeated if it fails.

Defined in:

AUFTRAG

Parameter:

#number Nrepeat

Number of repeats. Default 0.

Return value:

self

Define how many assets are required to do the job.

Defined in:

AUFTRAG

Parameter:

#number Nassets

Number of asset groups. Default 1.

Return value:

self

Set TACAN beacon channel and Morse code for this mission.

Defined in:

AUFTRAG

Parameters:

#number Channel

TACAN channel.

#string Morse

Morse code. Default "XXX".

Return value:

self

Set mission start and stop time.

Defined in:

AUFTRAG

Parameters:

#string ClockStart

Time the mission is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.

#string ClockStop

(Optional) Time the mission is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.

Return value:

self

Set number of weapons to expend.

Defined in:

AUFTRAG

Parameter:

#number WeaponExpend

How much of the weapon load is expended during the attack, e.g. AI.Task.WeaponExpend.ALL. Default "Auto".

Return value:

self

Set weapon type used for the engagement.

Defined in:

AUFTRAG

Parameter:

#number WeaponType

Weapon type. Default is ENUMS.WeaponFlag.Auto

Return value:

self

Update mission F10 map marker.

Defined in:

AUFTRAG

Return value:

self

Get DCS task table for an attack group or unit task.

Defined in:

AUFTRAG

Parameters:

Target data.

#table DCStasks

DCS DCS tasks table to which the task is added.

Return value:

The DCS task table.

Get target life points.

Defined in:

AUFTRAG

Parameters:

(Optional) The target object.

#boolean Healthy

Get the life points of the healthy target.

Return value:

#number:

Life points of target.

Set log ID string.

Defined in:

AUFTRAG

Return value:

self

Create target data from a given object.

Defined in:

AUFTRAG

Parameter:

The target GROUP, UNIT, STATIC.

Return value:

On after "AssetDead" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Assign" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Cancel" event.

Cancells the mission.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Done" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Execute" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Failed" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "GroupDead" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The ops group that is dead now.

On after "Queue" event.

Mission is added to the mission queue of an AIRWING.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airwing.

On after "Repeat" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Requested" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Schedule" event.

Mission is added to the mission queue of a FLIGHTGROUP.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Ops.OpsGroup#OPSGROUP FlightGroup

On after "Start" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Status" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Stop" event.

Remove mission from AIRWING and FLIGHTGROUP mission queues.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Success" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string AUFTRAG.ClassName

Name of the class.

#table AUFTRAG.DCStask

DCS task structure.

#boolean AUFTRAG.Debug

Debug mode. Messages to all about status.

#number AUFTRAG.Ntargets

Number of mission targets.

#number AUFTRAG.Tover

Mission abs. time stamp, when mission was over.

#number AUFTRAG.Tstart

Mission start time in seconds.

#number AUFTRAG.Tstop

Mission stop time in seconds.

Ops.AirWing#AIRWING AUFTRAG.airwing

The assigned airwing.

#number AUFTRAG.artyRadius

Radius in meters.

#number AUFTRAG.artyShots

Number of shots fired.

#table AUFTRAG.assets

Airwing Assets assigned for this mission.

#number AUFTRAG.auftragsnummer

Auftragsnummer.

#boolean AUFTRAG.cancelContactLost

If true, cancel mission if the contact is lost.

#table AUFTRAG.conditionFailure

If all stop conditions are true, the mission is cancelled.

#table AUFTRAG.conditionStart

Condition(s) that have to be true, before the mission will be started.

#table AUFTRAG.conditionSuccess

If all stop conditions are true, the mission is cancelled.

#number AUFTRAG.dTevaluate

Time interval in seconds before the mission result is evaluated after mission is over.

#number AUFTRAG.duration

Mission duration in seconds.

#number AUFTRAG.engageAltitude

Engagement altitude in meters.

#boolean AUFTRAG.engageAsGroup

Group attack.

#number AUFTRAG.engageDirection

Engagement direction in degrees.

#number AUFTRAG.engageMaxDistance

Max engage distance.

#number AUFTRAG.engageQuantity

Number of times a target is engaged.

#AUFTRAG.TargetData AUFTRAG.engageTarget

Target data to engage.

#table AUFTRAG.engageTargetTypes

Table of target types that are engaged in the engagement zone.

#number AUFTRAG.engageWeaponExpend

How many weapons are used.

#number AUFTRAG.engageWeaponType

Weapon type used.

Core.Zone#ZONE_RADIUS AUFTRAG.engageZone

Circular engagement zone.

#table AUFTRAG.enrouteTasks

Mission enroute tasks.

Wrapper.Group#GROUP AUFTRAG.escortGroup

The group to be escorted.

DCS#Vec3 AUFTRAG.escortVec3

The 3D offset vector from the escorted group to the escort group.

#boolean AUFTRAG.facDatalink

FAC datalink enabled.

#number AUFTRAG.facDesignation

FAC designation type.

#number AUFTRAG.facFreq

FAC radio frequency in MHz.

#number AUFTRAG.facModu

FAC radio modulation 0=AM 1=FM.

#table AUFTRAG.groupdata

Group specific data.

#string AUFTRAG.lid

Class id string for output to DCS log file.

#number AUFTRAG.missionAltitude

Mission altitude in meters.

#number AUFTRAG.missionFraction

Mission coordiante fraction. Default is 0.5.

#number AUFTRAG.missionRange

Mission range in meters. Used in AIRWING class.

#number AUFTRAG.missionRepeatMax

Number of times mission is repeated if failed.

#number AUFTRAG.missionRepeated

Number of times mission was repeated.

#string AUFTRAG.missionTask

Mission task. See ENUMS.MissionTask.

#string AUFTRAG.name

Mission name.

#number AUFTRAG.nassets

Number of required assets by the Airwing.

#number AUFTRAG.optionCM

Counter measures.

#number AUFTRAG.optionECM

ECM.

#number AUFTRAG.optionFormation

Formation.

#number AUFTRAG.optionROE

ROE.

#number AUFTRAG.optionROT

ROT.

#number AUFTRAG.optionRTBammo

RTB on out-of-ammo.

#number AUFTRAG.optionRTBfuel

RTB on out-of-fuel.

#number AUFTRAG.orbitAltitude

Orbit altitude in meters.

#number AUFTRAG.orbitHeading

Orbit heading in degrees.

#number AUFTRAG.orbitLeg

Length of orbit leg in meters.

Core.Point#COORDINATE AUFTRAG.orbitRaceTrack

Race-track orbit coordinate.

#number AUFTRAG.orbitSpeed

Orbit speed in m/s.

#number AUFTRAG.prio

Mission priority.

#number AUFTRAG.radioFreq

Mission radio frequency in MHz.

#number AUFTRAG.radioModu

Mission radio modulation (0=AM and 1=FM).

#number AUFTRAG.refuelSystem

Refuel type (boom or probe) for TANKER missions.

#number AUFTRAG.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed.

#table AUFTRAG.squadrons

User specifed airwing squadrons assigned for this mission. Only these will be considered for the job!

#string AUFTRAG.status

Mission status.

#number AUFTRAG.tacanChannel

Mission TACAN channel.

#number AUFTRAG.tacanMorse

Mission TACAN morse code.

Core.Point#COORDINATE AUFTRAG.transportDropoff

Coordinate where to drop off the cargo.

Core.Set#SET_GROUP AUFTRAG.transportGroupSet

Groups to be transported.

Core.Point#COORDINATE AUFTRAG.transportPickup

Coordinate where to pickup the cargo.

#string AUFTRAG.type

Mission type.

#boolean AUFTRAG.urgent

Mission is urgent. Running missions with lower prio might be cancelled.

#string AUFTRAG.version

AUFTRAG class version.

Ops.WingCommander#WINGCOMMANDER AUFTRAG.wingcommander

The WINGCOMMANDER managing this mission.

Function(s)

Adds an End state.

Defined in:

Parameter:

State

Set the default 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.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

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.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

#string AUFTRAG.ClassName

Name of the class.

#table AUFTRAG.DCStask

DCS task structure.

#boolean AUFTRAG.Debug

Debug mode. Messages to all about status.

#number AUFTRAG.Ntargets

Number of mission targets.

#number AUFTRAG.Tover

Mission abs. time stamp, when mission was over.

#number AUFTRAG.Tstart

Mission start time in seconds.

#number AUFTRAG.Tstop

Mission stop time in seconds.

Ops.AirWing#AIRWING AUFTRAG.airwing

The assigned airwing.

#number AUFTRAG.artyRadius

Radius in meters.

#number AUFTRAG.artyShots

Number of shots fired.

#table AUFTRAG.assets

Airwing Assets assigned for this mission.

#number AUFTRAG.auftragsnummer

Auftragsnummer.

#boolean AUFTRAG.cancelContactLost

If true, cancel mission if the contact is lost.

#table AUFTRAG.conditionFailure

If all stop conditions are true, the mission is cancelled.

#table AUFTRAG.conditionStart

Condition(s) that have to be true, before the mission will be started.

#table AUFTRAG.conditionSuccess

If all stop conditions are true, the mission is cancelled.

#number AUFTRAG.dTevaluate

Time interval in seconds before the mission result is evaluated after mission is over.

#number AUFTRAG.duration

Mission duration in seconds.

#number AUFTRAG.engageAltitude

Engagement altitude in meters.

#boolean AUFTRAG.engageAsGroup

Group attack.

#number AUFTRAG.engageDirection

Engagement direction in degrees.

#number AUFTRAG.engageMaxDistance

Max engage distance.

#number AUFTRAG.engageQuantity

Number of times a target is engaged.

#AUFTRAG.TargetData AUFTRAG.engageTarget

Target data to engage.

#table AUFTRAG.engageTargetTypes

Table of target types that are engaged in the engagement zone.

#number AUFTRAG.engageWeaponExpend

How many weapons are used.

#number AUFTRAG.engageWeaponType

Weapon type used.

Core.Zone#ZONE_RADIUS AUFTRAG.engageZone

Circular engagement zone.

#table AUFTRAG.enrouteTasks

Mission enroute tasks.

Wrapper.Group#GROUP AUFTRAG.escortGroup

The group to be escorted.

DCS#Vec3 AUFTRAG.escortVec3

The 3D offset vector from the escorted group to the escort group.

#boolean AUFTRAG.facDatalink

FAC datalink enabled.

#number AUFTRAG.facDesignation

FAC designation type.

#number AUFTRAG.facFreq

FAC radio frequency in MHz.

#number AUFTRAG.facModu

FAC radio modulation 0=AM 1=FM.

#table AUFTRAG.groupdata

Group specific data.

#string AUFTRAG.lid

Class id string for output to DCS log file.

#number AUFTRAG.missionAltitude

Mission altitude in meters.

#number AUFTRAG.missionFraction

Mission coordiante fraction. Default is 0.5.

#number AUFTRAG.missionRange

Mission range in meters. Used in AIRWING class.

#number AUFTRAG.missionRepeatMax

Number of times mission is repeated if failed.

#number AUFTRAG.missionRepeated

Number of times mission was repeated.

#string AUFTRAG.missionTask

Mission task. See ENUMS.MissionTask.

#string AUFTRAG.name

Mission name.

#number AUFTRAG.nassets

Number of required assets by the Airwing.

#number AUFTRAG.optionCM

Counter measures.

#number AUFTRAG.optionECM

ECM.

#number AUFTRAG.optionFormation

Formation.

#number AUFTRAG.optionROE

ROE.

#number AUFTRAG.optionROT

ROT.

#number AUFTRAG.optionRTBammo

RTB on out-of-ammo.

#number AUFTRAG.optionRTBfuel

RTB on out-of-fuel.

#number AUFTRAG.orbitAltitude

Orbit altitude in meters.

#number AUFTRAG.orbitHeading

Orbit heading in degrees.

#number AUFTRAG.orbitLeg

Length of orbit leg in meters.

Core.Point#COORDINATE AUFTRAG.orbitRaceTrack

Race-track orbit coordinate.

#number AUFTRAG.orbitSpeed

Orbit speed in m/s.

#number AUFTRAG.prio

Mission priority.

#number AUFTRAG.radioFreq

Mission radio frequency in MHz.

#number AUFTRAG.radioModu

Mission radio modulation (0=AM and 1=FM).

#number AUFTRAG.refuelSystem

Refuel type (boom or probe) for TANKER missions.

#number AUFTRAG.requestID

The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed.

#table AUFTRAG.squadrons

User specifed airwing squadrons assigned for this mission. Only these will be considered for the job!

#string AUFTRAG.status

Mission status.

#number AUFTRAG.tacanChannel

Mission TACAN channel.

#number AUFTRAG.tacanMorse

Mission TACAN morse code.

Core.Point#COORDINATE AUFTRAG.transportDropoff

Coordinate where to drop off the cargo.

Core.Set#SET_GROUP AUFTRAG.transportGroupSet

Groups to be transported.

Core.Point#COORDINATE AUFTRAG.transportPickup

Coordinate where to pickup the cargo.

#string AUFTRAG.type

Mission type.

#boolean AUFTRAG.urgent

Mission is urgent. Running missions with lower prio might be cancelled.

#string AUFTRAG.version

AUFTRAG class version.

Ops.WingCommander#WINGCOMMANDER AUFTRAG.wingcommander

The WINGCOMMANDER managing this mission.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

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

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

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

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when any 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.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

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

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event

Mission capability.

Field(s)

#string AUFTRAG.Capability.MissionType

Type of mission.

#number AUFTRAG.Capability.Performance

Number describing the performance level. The higher the better.

Function(s)

Generic mission condition.

Field(s)

#table AUFTRAG.Condition.arg

Optional arguments passed to the condition callback function.

#function AUFTRAG.Condition.func

Callback function to check for a condition. Should return a #boolean.

Function(s)

Group specific data.

Each ops group subscribed to this mission has different data for this.

Field(s)

#string AUFTRAG.GroupData.status

Group mission status.

#number AUFTRAG.GroupData.waypointindex

Waypoint index.

Function(s)

Mission status of an assigned group.

Field(s)

#string AUFTRAG.GroupStatus.CANCELLED

Mission was cancelled.

#string AUFTRAG.GroupStatus.DONE

Mission task of the Ops group is done.

#string AUFTRAG.GroupStatus.EXECUTING

Ops group is executing this mission.

#string AUFTRAG.GroupStatus.PAUSED

Ops group has paused this mission, e.g. for refuelling.

#string AUFTRAG.GroupStatus.SCHEDULED

Mission is scheduled in a FLIGHGROUP queue waiting to be started.

#string AUFTRAG.GroupStatus.STARTED

Ops group started this mission but it is not executed yet.

Function(s)

Mission status.

Field(s)

#string AUFTRAG.Status.CANCELLED

Mission was cancelled.

#string AUFTRAG.Status.DONE

Mission is over.

#string AUFTRAG.Status.EXECUTING

Mission is being executed.

#string AUFTRAG.Status.FAILED

Mission failed.

#string AUFTRAG.Status.PLANNED

Mission is at the early planning stage.

#string AUFTRAG.Status.QUEUED

Mission is queued at an airwing.

#string AUFTRAG.Status.REQUESTED

Mission assets were requested from the warehouse.

#string AUFTRAG.Status.SCHEDULED

Mission is scheduled in a FLIGHGROUP queue waiting to be started.

#string AUFTRAG.Status.STARTED

Mission has started but is not executed yet.

#string AUFTRAG.Status.SUCCESS

Mission was a success.

Function(s)

Mission success.

Field(s)

#string AUFTRAG.Success.DAMAGED

Target was damaged.

#string AUFTRAG.Success.DESTROYED

Target was destroyed.

#string AUFTRAG.Success.ENGAGED

Target was engaged.

#string AUFTRAG.Success.SURVIVED

Group did survive.

Function(s)

Target data.

Field(s)

#number AUFTRAG.TargetData.Lifepoints

Total life points.

#number AUFTRAG.TargetData.Lifepoints0

Inital life points.

#string AUFTRAG.TargetData.Name

Target name.

#number AUFTRAG.TargetData.Ninital

Number of initial targets.

#string AUFTRAG.TargetData.Type

Target type: "Group", "Unit", "Static", "Coordinate", "Airbase", "SetGroup", "SetUnit".

Function(s)

Target type.

Field(s)

#string AUFTRAG.TargetType.AIRBASE

Target is an AIRBASE.

#string AUFTRAG.TargetType.COORDINATE

Target is a COORDINATE.

#string AUFTRAG.TargetType.GROUP

Target is a GROUP object.

#string AUFTRAG.TargetType.SETGROUP

Target is a SET of GROUPs.

#string AUFTRAG.TargetType.SETUNIT

Target is a SET of UNITs.

#string AUFTRAG.TargetType.STATIC

Target is a STATIC object.

#string AUFTRAG.TargetType.UNIT

Target is a UNIT object.

Function(s)

Mission types.

Field(s)

#string AUFTRAG.Type.ANTISHIP

Anti-ship mission.

#string AUFTRAG.Type.ARTY

Fire at point.

#string AUFTRAG.Type.AWACS

AWACS mission.

#string AUFTRAG.Type.BAI

Battlefield Air Interdiction.

#string AUFTRAG.Type.BOMBCARPET

Carpet bombing.

#string AUFTRAG.Type.BOMBING

Bombing mission.

#string AUFTRAG.Type.BOMBRUNWAY

Bomb runway of an airbase.

#string AUFTRAG.Type.CAP

Combat Air Patrol.

#string AUFTRAG.Type.CAS

Close Air Support.

#string AUFTRAG.Type.ESCORT

Escort mission.

#string AUFTRAG.Type.FACA

Forward AirController airborne mission.

#string AUFTRAG.Type.FERRY

Ferry flight mission.

#string AUFTRAG.Type.INTERCEPT

Intercept mission.

#string AUFTRAG.Type.ORBIT

Orbit mission.

#string AUFTRAG.Type.PATROL

Similar to CAP but no auto engage targets.

#string AUFTRAG.Type.RECON

Recon mission.

#string AUFTRAG.Type.RECOVERYTANKER

Recovery tanker mission. Not implemented yet.

#string AUFTRAG.Type.RESCUEHELO

Rescue helo.

#string AUFTRAG.Type.SEAD

Suppression/destruction of enemy air defences.

#string AUFTRAG.Type.STRIKE

Strike mission.

#string AUFTRAG.Type.TANKER

Tanker mission.

#string AUFTRAG.Type.TROOPTRANSPORT

Troop transport mission.

Function(s)