Module Ops.Auftrag
Global(s)
Global AUFTRAG |
A warrior's mission is to foster the success of others. -- Morihei Ueshiba The AUFTRAG ConceptThe AUFTRAG class significantly simplifies the workflow of using DCS tasks. |
A warrior's mission is to foster the success of others. -- Morihei Ueshiba
The AUFTRAG Concept
The AUFTRAG class significantly simplifies the workflow of using DCS tasks.
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 Ops.FlightGroup#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.
Similarly, an AUFTRAG can be given to ground or navel groups via the Ops.ArmyGroup#ARMYGROUP or Ops.NavyGroup#NAVYGROUP classes, respectively. These classes have also AIRWING analouges, which are called BRIGADE and FLEET. Brigades and fleets will likewise select the best assets they have available and pass on the AUFTRAG to them.
One more up the food chain, an AUFTRAG can be passed to a COMMANDER. The commander will recruit the best assets of AIRWINGs, BRIGADEs and/or FLEETs 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() 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.
Strafing
A strafing mission can be created with the AUFTRAG.NewSTRAFING() 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.
Ground Escort
An escort mission can be created with the AUFTRAG.NewGROUNDESCORT() function.
Intercept
An intercept mission can be created with the AUFTRAG.NewINTERCEPT() function.
Orbit
An orbit mission can be created with the AUFTRAG.NewORBIT() function.
GCICAP
An patrol mission can be created with the AUFTRAG.NewGCICAP() function.
RECON
An reconnaissance mission can be created with the AUFTRAG.NewRECON() function.
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.
CARGOTRANSPORT
A cargo transport mission can be created with the AUFTRAG.NewCARGOTRANSPORT() function.
HOVER
A mission for a helicoptre or VSTOL plane to Hover at a point for a certain amount of time can be created with the AUFTRAG.NewHOVER() function.
Ground Missions
ARTY
An arty mission can be created with the AUFTRAG.NewARTY() function.
GROUNDATTACK
A ground attack mission can be created with the AUFTRAG.NewGROUNDATTACK() function.
Assigning Missions
An AUFTRAG can be assigned to groups (FLIGHTGROUP, ARMYGROUP, NAVYGROUP), legions (AIRWING, BRIGADE, FLEET) or to a COMMANDER.
Group Level
Flight Group
Assigning an AUFTRAG to a flight group is done via the Ops.FlightGroup#FLIGHTGROUP.AddMission function. See FLIGHTGROUP docs for details.
Army Group
Assigning an AUFTRAG to an army group is done via the Ops.ArmyGroup#ARMYGROUP.AddMission function. See ARMYGROUP docs for details.
Navy Group
Assigning an AUFTRAG to a navy group is done via the Ops.NavyGroup#NAVYGROUP.AddMission function. See NAVYGROUP docs for details.
Legion Level
Adding an AUFTRAG to an airwing is done via the Ops.Airwing#AIRWING.AddMission function. See AIRWING docs for further details. Similarly, an AUFTRAG can be added to a brigade via the Ops.Brigade#BRIGADE.AddMission function.
Commander Level
Assigning an AUFTRAG to a commander is done via the Ops.Commander#COMMANDER.AddMission function. The commander will select the best assets available from all the legions under his command. See COMMANDER docs for details.
Chief Level
Assigning an AUFTRAG to a commander is done via the Ops.Chief#CHIEF.AddMission function. The chief will simply pass on the mission to his/her commander.
Transportation
TODO
Events
The AUFTRAG class creates many useful (FSM) events, which can be used in the mission designers script.
TODO
Examples
TODO
Global _AUFTRAGSNR |
Global mission counter. |
Global mission counter.
Type(s)
| Fields and Methods inherited from AUFTRAG | Description |
|---|---|
|
Add asset to mission. |
|
|
Add failure condition. |
|
|
Add push condition. |
|
|
Add start condition. |
|
|
Add success condition. |
|
|
Add LEGION to mission. |
|
|
Add a Ops group to the mission. |
|
|
Add a required payload for this mission. |
|
|
Add carriers for a transport of mission assets. |
|
|
[LEGION, COMMANDER, CHIEF] Assign a legion cohort to the mission. |
|
|
[LEGION, COMMANDER, CHIEF] Assign an escort cohort. |
|
|
[LEGION, COMMANDER, CHIEF] Add an escort Legion. |
|
|
[LEGION, COMMANDER, CHIEF] Assign a legion to the mission. |
|
|
[LEGION, COMMANDER, CHIEF] Assign airwing squadron(s) to the mission. |
|
|
[LEGION, COMMANDER, CHIEF] Assign a transport cohort. |
|
|
[LEGION, COMMANDER, CHIEF] Assign a transport Legion. |
|
|
Triggers the FSM event "Cancel". |
|
|
Check if all groups are done with their mission (or dead). |
|
AUFTRAG.CheckMissionCapability(MissionTypes, Capabilities, All) |
Check if a mission type is contained in a list of possible capabilities. |
AUFTRAG.CheckMissionCapabilityAll(MissionTypes, Capabilities) |
Check if a mission type is contained in a list of possible capabilities. |
AUFTRAG.CheckMissionCapabilityAny(MissionTypes, Capabilities) |
Check if a mission type is contained in a list of possible capabilities. |
|
Checks if a mission type is contained in a table of possible types. |
|
|
Name of the class. |
|
|
Count alive mission targets. |
|
|
Count alive OPS groups assigned for this mission. |
|
|
Count OPS groups in a certain status. |
|
|
DCS task structure. |
|
|
Delete asset from mission. |
|
|
Remove an Ops group from the mission. |
|
|
Triggers the FSM event "Done". |
|
|
Check if all given condition are true. |
|
|
Check if any of the given conditions is true. |
|
|
Evaluate mission outcome - success or failure. |
|
|
Triggers the FSM event "Executing". |
|
|
Triggers the FSM event "Failed". |
|
|
Get asset by its spawn group name. |
|
|
Get asset data table. |
|
|
Get casualties, i.e. number of own units that died during this mission. |
|
|
Get DCS task table for the given mission. |
|
|
Get flight data table. |
|
|
Get Egress waypoint UID of OPS group. |
|
|
Get ops group mission status. |
|
|
Get mission (ingress) waypoint coordinate of OPS group |
|
|
Get mission (ingress) waypoint UID of OPS group. |
|
|
Get mission waypoint task of OPS group. |
|
|
Get mission importance. |
|
|
Get kills, i.e. |
|
|
Get LEGION mission status. |
|
|
Get the mission egress coordinate if this was defined. |
|
|
Get DCS task table for an attack group or unit task. |
|
|
Get coordinate of target. |
|
AUFTRAG:GetMissionWaypointCoord(group, randomradius, surfacetypes) |
Get coordinate of target. |
|
Get mission name. |
|
|
Get number of required assets. |
|
|
Get mission objective object. |
|
|
Get all OPS groups. |
|
|
Get the attach OPS transport of the mission. |
|
|
Get mission priority. |
|
|
[LEGION, COMMANDER, CHIEF] Get number of required assets. |
|
|
Get coordinate of target. |
|
|
Get target damage. |
|
|
Get target. |
|
|
Get distance to target. |
|
|
Get heading of target. |
|
|
Get target life points. |
|
|
Get initial number of targets. |
|
|
Get target life points. |
|
|
Get name of the target. |
|
|
Get type of target. |
|
|
Get 2D vector of target. |
|
|
Get mission type. |
|
|
Check if mission is for aircarft (airplanes and/or helicopters). |
|
|
Check if mission is for airplanes. |
|
|
Check if mission was cancelled. |
|
|
Check if mission is done. |
|
|
Check if mission is EXECUTING. |
|
|
Check if mission is for ground units. |
|
|
Check if mission is for helicopters. |
|
|
Check if mission is for naval units. |
|
|
Check if mission is NOT over. |
|
|
Check if mission is over. |
|
|
Check if mission is PLANNED. |
|
|
Check if mission is QUEUED at a LEGION mission queue. |
|
|
Check if mission is ready to be cancelled. |
|
|
Check if mission is ready to be started. |
|
|
Check if mission is ready to be pushed. |
|
|
Check if mission is REQUESTED. |
|
|
Check if mission is SCHEDULED. |
|
|
Check if mission is STARTED. |
|
|
Check if mission was a success. |
|
|
Check if mission is "urgent". |
|
|
Number of requested warehouse assets. |
|
|
Number of required warehouse assets for each assigned legion. |
|
|
Number of required warehouse assets for each assigned legion. |
|
|
Max. number of required warehouse assets. |
|
|
Min. number of required warehouse assets. |
|
|
Number of assigned groups. |
|
|
Max number of required carrier assets. |
|
|
Min number of required carrier assets. |
|
|
Number of own casualties during mission. |
|
|
Number of assigned groups that are dead. |
|
|
Number of elements (units) assigned to mission. |
|
|
Max. number of required escort assets for each group the mission is assigned to. |
|
|
Min. number of required escort assets for each group the mission is assigned to. |
|
|
Create a new generic AUFTRAG object. |
|
|
[GROUND, NAVAL] Create an AIRDEFENSE mission. |
|
|
[AIR] Create an ALERT 5 mission. |
|
|
[GROUND] Create a AMMO SUPPLY mission. |
|
|
[AIR] Create an ANTI-SHIP mission. |
|
|
[OBSOLETE] Create a ARMORATTACK mission. |
|
|
[GROUND] Create an ARMORED ON GUARD mission. |
|
|
[GROUND, NAVAL] Create an ARTY mission. |
|
|
Create a mission to attack a group. |
|
|
[AIR] Create a AWACS mission. |
|
|
[AIR] Create a BAI mission. |
|
AUFTRAG:NewBARRAGE(Zone, Heading, Angle, Radius, Altitude, Nshots) |
[GROUND, NAVAL] Create an BARRAGE mission. |
|
[AIR] Create a CARPET BOMBING mission. |
|
|
[AIR] Create a BOMBING mission. |
|
|
[AIR] Create a BOMBRUNWAY mission. |
|
AUFTRAG:NewCAP(ZoneCAP, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes) |
[AIR] Create a CAP mission. |
|
[AIR] Create a CAP mission over a (moving) group. |
|
AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation) |
[AIR, GROUND, NAVAL] Create a CAPTUREZONE mission. |
|
[AIR ROTARY] Create a CARGO TRANSPORT mission. |
|
AUFTRAG:NewCAS(ZoneCAS, Altitude, Speed, Coordinate, Heading, Leg, TargetTypes) |
[AIR] Create a CAS mission. |
AUFTRAG:NewCASENHANCED(CasZone, Altitude, Speed, RangeMax, NoEngageZoneSet, TargetTypes) |
[AIR] Create a CASENHANCED mission. |
AUFTRAG:NewESCORT(EscortGroup, OffsetVector, EngageMaxDistance, TargetTypes) |
[AIR] Create an ESCORT (or FOLLOW) mission. |
|
[GROUND] Create an EWR mission. |
|
AUFTRAG:NewFAC(FacZone, Speed, Altitude, Frequency, Modulation) |
[AIR, GROUND] Create a FAC mission. |
AUFTRAG:NewFACA(Target, Designation, DataLink, Frequency, Modulation) |
[AIR] Create a FACA mission. |
|
[GROUND] Create a FUEL SUPPLY mission. |
|
|
Create a mission to attack a TARGET object. |
|
AUFTRAG:NewGCICAP(Coordinate, Altitude, Speed, Heading, Leg) |
[AIR] Create a Ground Controlled CAP (GCICAP) mission. |
|
[GROUND] Create a GROUNDATTACK mission. |
|
AUFTRAG:NewGROUNDESCORT(EscortGroup, OrbitDistance, TargetTypes) |
[AIR/HELO] Create a GROUNDESCORT (or FOLLOW) mission. |
AUFTRAG:NewHOVER(Coordinate, Altitude, Time, Speed, MissionAlt) |
[AIR ROTARY] Create an HOVER mission. |
|
[AIR] Create an INTERCEPT mission. |
|
|
[AIR ROTARY] Create an LANDATCOORDINATE mission. |
|
|
[GROUND, NAVAL] Create a mission to do NOTHING. |
|
|
[GROUND, NAVAL] Create an ON GUARD mission. |
|
|
[AIR] Create an ORBIT mission, which can be either a circular orbit or a race-track pattern. |
|
|
[AIR] Create an ORBIT mission, where the aircraft will go in a circle around the specified coordinate. |
|
AUFTRAG:NewORBIT_GROUP(Group, Altitude, Speed, Leg, Heading, OffsetVec2, Distance) |
[AIR] Create an ORBIT mission, where the aircraft will fly a circular or race-track pattern over a given group or unit. |
AUFTRAG:NewORBIT_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg) |
[AIR] Create an ORBIT mission, where the aircraft will fly a race-track pattern. |
|
[AIR, GROUND, NAVAL] Create a PATROLZONE mission. |
|
AUFTRAG:NewPATROL_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg, Formation) |
[AIR] Create an enhanced orbit race track mission. |
|
[GROUND] Create a REARMING mission. |
|
AUFTRAG:NewRECON(ZoneSet, Speed, Altitude, Adinfinitum, Randomly, Formation) |
[AIR, GROUND, NAVAL] Create a RECON mission. |
|
[AIRPANE] Create a RECOVERY TANKER mission. |
|
|
[AIR ROTARY] Create a RESCUE HELO mission. |
|
|
[AIR] Create a SEAD mission. |
|
|
[AIR] Create a STRAFING mission. |
|
|
[AIR] Create a STRIKE mission. |
|
AUFTRAG:NewTANKER(Coordinate, Altitude, Speed, Heading, Leg, RefuelSystem) |
[AIR] Create a TANKER mission. |
AUFTRAG:NewTROOPTRANSPORT(TransportGroupSet, DropoffCoordinate, PickupCoordinate, PickupRadius) |
[AIR ROTARY, GROUND] Create a TROOP TRANSPORT mission. |
|
Number of (enemy) units killed by assets of this mission. |
|
|
Number of times the mission is repeated. |
|
|
Number of times mission is repeated if failed. |
|
|
Number of times mission is repeated if successful. |
|
|
On after "Cancel" event. |
|
|
On after "Done" event. |
|
|
On after "Executing" event. |
|
|
On after "Failed" event. |
|
|
On after "Planned" event. |
|
|
On after "Queued" event. |
|
|
On after "Repeat" event. |
|
|
On after "Requested" event. |
|
|
On after "Scheduled" event. |
|
|
On after "Started" event. |
|
|
On after "Success" event. |
|
|
Unit lost event. |
|
|
Triggers the FSM event "Planned". |
|
|
Triggers the FSM event "Queued". |
|
|
Remove LEGION from mission. |
|
|
Triggers the FSM event "Repeat". |
|
|
Triggers the FSM event "Requested". |
|
|
Triggers the FSM event "Scheduled". |
|
|
Set alarm state for this mission. |
|
|
Set that (jet) aircraft are generally allowed to use afterburner. |
|
|
Set that (jet) aircraft are allowed to use afterburner in mission execution phase. |
|
|
[LEGION, COMMANDER, CHIEF] Set that only alive (spawned) assets are considered. |
|
|
Set time how long the mission is executed. |
|
|
Set EPLRS datalink setting for this mission. |
|
|
Set emission setting for this mission. |
|
|
Enable markers, which dispay the mission status on the F10 map. |
|
|
Set engage altitude. |
|
|
Set whether target will be attack as group. |
|
AUFTRAG:SetEngageDetected(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet) |
Enable to automatically engage detected targets. |
|
Set time interval between mission done and success/failure evaluation. |
|
|
Set formation for this mission. |
|
|
Set Egress waypoint UID for OPS group. |
|
|
Set opsgroup mission status. |
|
|
Set mission (ingress) waypoint coordinate for OPS group. |
|
|
Set mission (ingress) waypoint UID for OPS group. |
|
|
Set mission waypoint task for OPS group. |
|
|
Set ICLS beacon channel and Morse code for this mission. |
|
|
Set immortality setting for this mission. |
|
|
Set invisibility setting for this mission. |
|
|
Set LEGION mission status. |
|
|
Set mission altitude. |
|
|
Set the mission egress coordinate. |
|
|
Set max mission range. |
|
|
Set mission speed. |
|
|
Set the mission waypoint coordinate where the mission is executed. |
|
|
Set randomization of the mission waypoint coordinate. |
|
|
Set mission name. |
|
|
Attach OPS transport to the mission. |
|
|
Set mission priority and (optional) urgency. |
|
|
Set that (jet) aircraft are generally not allowed to use afterburner. |
|
|
Set that (jet) aircraft are not allowed to use afterburner in mission execution phase. |
|
|
Set mission push time. |
|
|
Set Rules of Engagement (ROE) for this mission. |
|
|
Set Reaction on Threat (ROT) for this mission. |
|
|
Set radio frequency and modulation for this mission. |
|
|
[LEGION, COMMANDER, CHIEF] Set that mission assets get reinforced if their number drops below the minimum number of required assets of the mission (c.f. SetRequiredAssets() function). |
|
|
[LEGION, COMMANDER, CHIEF] Set how many times the mission is repeated. |
|
|
[LEGION, COMMANDER, CHIEF] Set how many times the mission is repeated if it fails. |
|
|
[LEGION, COMMANDER, CHIEF] Set how many times the mission is repeated if it was successful. |
|
|
[LEGION, COMMANDER, CHIEF] Define how many assets are required to do the job. |
|
|
[LEGION, COMMANDER, CHIEF] Set required attribute(s) the assets must have. |
|
AUFTRAG:SetRequiredCarriers(NcarriersMin, NcarriersMax, Categories, Attributes, Properties) |
[LEGION, COMMANDER, CHIEF] Set number of required carrier groups if an OPSTRANSPORT assignment is required. |
AUFTRAG:SetRequiredEscorts(NescortMin, NescortMax, MissionType, TargetTypes, EngageRange) |
[LEGION, COMMANDER, CHIEF] Define how many assets are required that escort the mission assets. |
|
[LEGION, COMMANDER, CHIEF] Set required property or properties the assets must have. |
|
|
[LEGION, COMMANDER, CHIEF] Attach OPS transport to the mission. |
|
|
[LEGION, COMMANDER, CHIEF] Set whether assigned assets return to their legion once the mission is over. |
|
|
Set TACAN beacon channel and Morse code for this mission. |
|
|
Set that mission assets are teleported to the mission execution waypoint. |
|
|
Set mission start and stop time. |
|
|
Set verbosity level. |
|
|
Set number of weapons to expend. |
|
|
Set weapon type used for the engagement. |
|
|
Triggers the FSM event "Started". |
|
|
Triggers the FSM event "Status". |
|
|
Triggers the FSM event "Stop". |
|
|
Triggers the FSM event "Success". |
|
|
Time stamp (abs) when mission is executing. Is |
|
|
Mission abs. time stamp, when mission was over. |
|
|
Mission push/execute time in abs. seconds. |
|
|
Mission start time in abs. seconds. |
|
|
Time stamp (abs) when mission is started. |
|
|
Mission stop time in abs. seconds. |
|
|
Update mission F10 map marker. |
|
|
Add assets to mission. |
|
|
Create a mission to attack a group. |
|
|
Get DCS task table for an attack group or unit task. |
|
|
Get coordinate which was set as mission waypoint coordinate. |
|
|
Get request from legion this mission requested assets from. |
|
|
Get request ID from legion this mission requested assets from |
|
|
Check if reinforcement is done. |
|
|
Check if reinforcement is still ongoing. |
|
|
[PRIVATE, AIR, GROUND, NAVAL] Create a mission to relocate all cohort assets to another LEGION. |
|
|
Set log ID string. |
|
|
Set request ID from legion this mission requested assets from |
|
|
Create target data from a given object. |
|
|
Triggers the FSM event "Cancel" after a delay. |
|
|
Triggers the FSM event "Done" after a delay. |
|
|
Triggers the FSM event "Executing" after a delay. |
|
|
Triggers the FSM event "Failed" after a delay. |
|
|
Triggers the FSM event "Planned" after a delay. |
|
|
Triggers the FSM event "Queued" after a delay. |
|
|
Triggers the FSM event "Repeat" after a delay. |
|
|
Triggers the FSM event "Requested" after a delay. |
|
|
Triggers the FSM event "Scheduled" after a delay. |
|
|
Triggers the FSM event "Started" after a delay. |
|
|
Triggers the FSM event "Status" after a delay. |
|
|
Triggers the FSM event "Stop" after a delay. |
|
|
Triggers the FSM event "Success" after a delay. |
|
|
Alert 5 mission type. This is the mission type, the alerted assets will be able to carry out. |
|
|
Altitude in meters. Can be used for a Barrage. |
|
|
Shooting angle in degrees (for Barrage). |
|
|
Heading in degrees (for Barrage). |
|
|
Radius in meters. |
|
|
Number of shots fired. |
|
|
Warehouse assets assigned for this mission. |
|
|
Generalized attribute(s) of assets. |
|
|
Auftragsnummer. |
|
|
Generalized attribute(s) of transport assets. |
|
|
DCS attribute(s) of transport assets. |
|
|
Mission categories. |
|
|
The CHIEF managing this mission. |
|
|
The COMMANDER managing this mission. |
|
|
If all conditions are true, the mission is cancelled. |
|
|
If all conditions are true, the mission is executed. Before, the group(s) wait at the mission execution waypoint. |
|
|
Condition(s) that have to be true, before the mission will be started. |
|
|
If all conditions are true, the mission is cancelled. |
|
|
Time interval in seconds before the mission result is evaluated after mission is over. |
|
|
Mission duration in seconds. |
|
|
Mission execution time in seconds. |
|
|
Engagement altitude in meters. |
|
|
Group attack. |
|
|
Engagement direction in degrees. |
|
|
Length of engage (carpet or strafing) in meters. |
|
|
Max engage distance. |
|
|
Number of times a target is engaged. |
|
|
Target data to engage. |
|
|
Table of target types that are engaged in the engagement zone. |
|
|
How many weapons are used. |
|
|
Weapon type used. |
|
|
Circular engagement zone. |
|
|
Mission enroute tasks. |
|
|
Cohorts explicitly requested for providing escorting assets. |
|
|
Engage range in nautical miles (NM). |
|
|
The group to be escorted. |
|
|
Name of the escorted group. |
|
|
Legions explicitly requested for providing escorting assets. |
|
|
Escort mission type. |
|
|
Target types that will be engaged. |
|
|
The 3D offset vector from the escorted group to the escort group. |
|
|
FAC datalink enabled. |
|
|
FAC designation type. |
|
|
FAC radio frequency in MHz. |
|
|
FAC radio modulation 0=AM 1=FM. |
|
|
Group specific data. |
|
|
ICLS setting. |
|
|
Importance. |
|
|
If |
|
|
Assigned legions. |
|
|
Class id string for output to DCS log file. |
|
|
F10 map marker. |
|
|
Coalition to which the marker is dispayed. |
|
|
If true, display marker on F10 map with the AUFTRAG status. |
|
|
Mission altitude in meters. |
|
|
Mission egress waypoint coordinate. |
|
|
Mission coordiante fraction. Default is 0.5. |
|
|
Mission range in meters. Used by LEGION classes (AIRWING, BRIGADE, ...). |
|
|
Mission speed in km/h. |
|
|
Mission task. See |
|
|
Mission waypoint coordinate. |
|
|
Random radius in meters. |
|
|
Mission name. |
|
|
On after "AssetDead" event. |
|
|
On after "Assign" event. |
|
|
On after "Cancel" event. |
|
|
On after "Done" event. |
|
AUFTRAG:onafterElementDestroyed(From, Event, To, OpsGroup, Element) |
On after "ElementDestroyed" event. |
|
On after "Execute" event. |
|
|
On after "Failed" event. |
|
|
On after "GroupDead" event. |
|
|
On after "Planned" event. |
|
|
On after "Queue" event. |
|
|
On after "Repeat" event. |
|
|
On after "Requested" event. |
|
|
On after "Schedule" event. |
|
|
On after "Start" event. |
|
|
On after "Status" event. |
|
|
On after "Stop" event. |
|
|
On after "Success" event. |
|
|
On before "Repeat" event. |
|
|
Operation this mission is part of. |
|
|
OPS transport assignment. |
|
|
Alarm state. |
|
|
Counter measures. |
|
|
ECM. |
|
|
EPLRS datalink. |
|
|
Emission is on or off. |
|
|
Formation. |
|
|
Immortal is on/off. |
|
|
Invisible is on/off. |
|
|
ROE. |
|
|
ROT. |
|
|
RTB on out-of-ammo. |
|
|
RTB on out-of-fuel. |
|
|
Orbit altitude in meters. |
|
|
Distance threshold in meters for moving orbit targets. |
|
|
Orbit heading in degrees. |
|
|
Length of orbit leg in meters. |
|
|
2D offset vector. |
|
|
Orbit speed in m/s. |
|
|
2D orbit vector. |
|
|
Patrol data. |
|
|
User specified airwing payloads for this mission. Only these will be considered for the job! |
|
|
Mission priority. |
|
|
DCS attribute(s) of assets. |
|
|
Radio freq and modulation. |
|
|
Refuel type (boom or probe) for TANKER missions. |
|
|
Number of times mission was repeated. |
|
|
Number of times mission was repeated after a failure. |
|
|
Number of times mission was repeated after a success. |
|
|
The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed. |
|
|
User specified cohorts assigned for this mission. Only these will be considered for the job! |
|
|
User specified legions assigned for this mission. Only these will be considered for the job! |
|
|
Mission status. |
|
|
Mission status of the CHIEF. |
|
|
Mission status of the COMMANDER. |
|
|
Mission status of all assigned LEGIONs. |
|
|
TACAN setting. |
|
|
Heading of target in degrees. |
|
|
Groups are teleported to the mission ingress waypoint. |
|
|
Cohorts explicitly requested for providing transport carrier assets. |
|
|
Deploy zone of an OPSTRANSPORT. |
|
|
Disembark zone of an OPSTRANSPORT. |
|
|
Coordinate where to drop off the cargo. |
|
|
Groups to be transported. |
|
|
Legions explicitly requested for providing transport carrier assets. |
|
|
Coordinate where to pickup the cargo. |
|
|
Radius in meters for pickup zone. Default 500 m. |
|
|
Mission type. |
|
|
If |
|
|
Mission is urgent. Running missions with lower prio might be cancelled. |
|
|
Verbosity level. |
|
|
AUFTRAG class version. |
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End 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. |
|
|
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. |
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
| Fields and Methods inherited from AUFTRAG.Capability | Description |
|---|---|
|
Type of mission. |
|
|
Number describing the performance level. The higher the better. |
| Fields and Methods inherited from AUFTRAG.Category | Description |
|---|---|
|
Airplanes and helicopters. |
|
|
Airplanes. |
|
|
Ground troops. |
|
|
Helicopter. |
|
|
Naval grous. |
| Fields and Methods inherited from AUFTRAG.Condition | Description |
|---|---|
|
Optional arguments passed to the condition callback function. |
|
|
Callback function to check for a condition. Should return a #boolean. |
| Fields and Methods inherited from AUFTRAG.GroupData | Description |
|---|---|
|
The warehouse asset. |
|
|
The OPS group. |
|
|
Group mission status. |
|
|
Egress Waypoint UID. |
|
|
Ingress waypoint coordinate. |
|
|
Mission (ingress) Waypoint UID. |
|
|
Waypoint task. |
|
|
Egress waypoint coordinate. |
| Fields and Methods inherited from AUFTRAG.GroupStatus | Description |
|---|---|
|
Mission was cancelled. |
|
|
Mission task of the Ops group is done. |
|
|
Ops group is executing this mission. |
|
|
Ops group has paused this mission, e.g. for refuelling. |
|
|
Mission is scheduled in a FLIGHGROUP queue waiting to be started. |
|
|
Ops group started this mission but it is not executed yet. |
| Fields and Methods inherited from AUFTRAG.SpecialTask | Description |
|---|---|
|
Air defense. |
|
|
Alert 5 task. |
|
|
Ammo Supply. |
|
|
On guard with armor. |
|
|
Barrage. |
|
|
Capture OPS zone. |
|
|
Early Warning Radar. |
|
|
Ferry mission. |
|
|
AI formation task. |
|
|
Fuel Supply. |
|
|
Ground attack. |
|
|
Hover. |
|
|
Nothing. |
|
|
On guard. |
|
|
Patrol Racetrack. |
|
|
Patrol zone task. |
|
|
Rearming. |
|
|
Recon task. |
|
|
Recovery tanker. |
|
|
Relocate cohort. |
| Fields and Methods inherited from AUFTRAG.Status | Description |
|---|---|
|
Mission was cancelled. |
|
|
Mission is over. |
|
|
Mission is being executed. |
|
|
Mission failed. |
|
|
Mission is at the early planning stage and has not been added to any queue. |
|
|
Mission is queued at a LEGION. |
|
|
Mission assets were requested from the warehouse. |
|
|
Mission is scheduled in an OPSGROUP queue waiting to be started. |
|
|
Mission has started but is not executed yet. |
|
|
Mission was a success. |
| Fields and Methods inherited from AUFTRAG.Success | Description |
|---|---|
|
Target was damaged. |
|
|
Target was destroyed. |
|
|
Target was engaged. |
|
|
Group did survive. |
| Fields and Methods inherited from AUFTRAG.TargetData | Description |
|---|---|
|
Total life points. |
|
|
Inital life points. |
|
|
Target name. |
|
|
Number of initial targets. |
|
|
Target Object. |
|
|
Target type: "Group", "Unit", "Static", "Coordinate", "Airbase", "SetGroup", "SetUnit". |
| Fields and Methods inherited from AUFTRAG.TargetType | Description |
|---|---|
|
Target is an AIRBASE. |
|
|
Target is a COORDINATE. |
|
|
Target is a GROUP object. |
|
|
Target is a SET of GROUPs. |
|
|
Target is a SET of UNITs. |
|
|
Target is a STATIC object. |
|
|
Target is a UNIT object. |
| Fields and Methods inherited from AUFTRAG.Type | Description |
|---|---|
|
Air defense. |
|
|
Alert 5. |
|
|
Ammo supply. |
|
|
Anti-ship mission. |
|
|
Armor attack. |
|
|
On guard - with armored groups. |
|
|
Fire at point. |
|
|
AWACS mission. |
|
|
Battlefield Air Interdiction. |
|
|
Barrage. |
|
|
Carpet bombing. |
|
|
Bombing mission. |
|
|
Bomb runway of an airbase. |
|
|
Combat Air Patrol. |
|
|
Capture zone mission. |
|
|
Cargo transport. |
|
|
Close Air Support. |
|
|
Enhanced CAS. |
|
|
Escort mission. |
|
|
Early Warning Radar. |
|
|
Forward AirController mission. |
|
|
Forward AirController airborne mission. |
|
|
Ferry mission. |
|
|
Fuel supply. |
|
|
Similar to CAP but no auto engage targets. |
|
|
Ground attack. |
|
|
Ground escort mission. |
|
|
Hover. |
|
|
Intercept mission. |
|
|
Land at coordinate. |
|
|
Nothing. |
|
|
On guard. |
|
|
Ops transport. |
|
|
Orbit mission. |
|
|
Patrol Racetrack. |
|
|
Patrol a zone. |
|
|
Rearming mission. |
|
|
Recon mission. |
|
|
Recovery tanker. |
|
|
Relocate a cohort from one legion to another. |
|
|
Rescue helo. |
|
|
Suppression/destruction of enemy air defences. |
|
|
Strafing run. |
|
|
Strike mission. |
|
|
Tanker mission. |
|
|
Troop transport mission. |
AUFTRAG class.
Field(s)
Name of the class.
DCS task structure.
Number of requested warehouse assets.
Number of required warehouse assets for each assigned legion.
Number of required warehouse assets for each assigned legion.
Max. number of required warehouse assets.
Min. number of required warehouse assets.
Number of assigned groups.
Max number of required carrier assets.
Min number of required carrier assets.
Number of own casualties during mission.
Number of assigned groups that are dead.
Number of elements (units) assigned to mission.
Max. number of required escort assets for each group the mission is assigned to.
Min. number of required escort assets for each group the mission is assigned to.
Number of (enemy) units killed by assets of this mission.
Number of times the mission is repeated.
Number of times mission is repeated if failed.
Number of times mission is repeated if successful.
Time stamp (abs) when mission is executing. Is #nil on start.
Mission abs. time stamp, when mission was over.
Mission push/execute time in abs. seconds.
Mission start time in abs. seconds.
Time stamp (abs) when mission is started.
Mission stop time in abs. seconds.
Alert 5 mission type. This is the mission type, the alerted assets will be able to carry out.
Altitude in meters. Can be used for a Barrage.
Shooting angle in degrees (for Barrage).
Heading in degrees (for Barrage).
Radius in meters.
Number of shots fired.
Warehouse assets assigned for this mission.
Generalized attribute(s) of assets.
Auftragsnummer.
Generalized attribute(s) of transport assets.
DCS attribute(s) of transport assets.
Mission categories.
If all conditions are true, the mission is cancelled.
If all conditions are true, the mission is executed. Before, the group(s) wait at the mission execution waypoint.
Condition(s) that have to be true, before the mission will be started.
If all conditions are true, the mission is cancelled.
Time interval in seconds before the mission result is evaluated after mission is over.
Mission duration in seconds.
Mission execution time in seconds.
Engagement altitude in meters.
Group attack.
Engagement direction in degrees.
Length of engage (carpet or strafing) in meters.
Max engage distance.
Number of times a target is engaged.
Table of target types that are engaged in the engagement zone.
How many weapons are used.
Weapon type used.
Set parameters.
Mission enroute tasks.
Cohorts explicitly requested for providing escorting assets.
Engage range in nautical miles (NM).
Name of the escorted group.
Legions explicitly requested for providing escorting assets.
Escort mission type.
Target types that will be engaged.
FAC datalink enabled.
FAC designation type.
FAC radio frequency in MHz.
FAC radio modulation 0=AM 1=FM.
Group specific data.
Importance.
If true, assets return to their legion (default). If false, they will stay alive.
Assigned legions.
Class id string for output to DCS log file.
Coalition to which the marker is dispayed.
If true, display marker on F10 map with the AUFTRAG status.
Mission altitude in meters.
Mission coordiante fraction. Default is 0.5.
Mission range in meters. Used by LEGION classes (AIRWING, BRIGADE, ...).
Mission speed in km/h.
Mission task. See ENUMS.MissionTask.
Random radius in meters.
Mission name.
Alarm state.
Counter measures.
ECM.
EPLRS datalink.
Emission is on or off.
Formation.
Immortal is on/off.
Invisible is on/off.
ROE.
ROT.
RTB on out-of-ammo.
RTB on out-of-fuel.
Orbit altitude in meters.
Distance threshold in meters for moving orbit targets.
Orbit heading in degrees.
Length of orbit leg in meters.
Orbit speed in m/s.
User specified airwing payloads for this mission. Only these will be considered for the job!
Mission priority.
DCS attribute(s) of assets.
Refuel type (boom or probe) for TANKER missions.
Number of times mission was repeated.
Number of times mission was repeated after a failure.
Number of times mission was repeated after a success.
The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed.
User specified cohorts assigned for this mission. Only these will be considered for the job!
User specified legions assigned for this mission. Only these will be considered for the job!
Mission status.
Mission status of the CHIEF.
Mission status of the COMMANDER.
Mission status of all assigned LEGIONs.
Heading of target in degrees.
Groups are teleported to the mission ingress waypoint.
Cohorts explicitly requested for providing transport carrier assets.
Legions explicitly requested for providing transport carrier assets.
Radius in meters for pickup zone. Default 500 m.
Mission type.
If true, DCS task is updated at every status update of the assigned groups.
Mission is urgent. Running missions with lower prio might be cancelled.
Verbosity level.
AUFTRAG class version.
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 push condition.
Defined in:
AUFTRAG
Parameters:
#function ConditionFunction
If this function returns true, the mission is executed.
...
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 LEGION to mission.
Add a Ops group to the mission.
Defined in:
AUFTRAG
Parameter:
Ops.OpsGroup#OPSGROUP OpsGroup
The OPSGROUP object.
Return value:
self
Add a required payload for this mission.
Only these payloads will be used for this mission. If they are not available, the mission cannot start. Only available for use with an AIRWING.
Defined in:
AUFTRAG
Parameter:
Ops.Airwing#AIRWING.Payload Payload
Required payload.
Return value:
self
Add carriers for a transport of mission assets.
Defined in:
AUFTRAG
Parameter:
Core.Set#SET_OPSGROUP Carriers
Set of carriers. Can also be a single group.
Return value:
self
[LEGION, COMMANDER, CHIEF] Assign a legion cohort to the mission.
Only these cohorts will be considered for the job.
[LEGION, COMMANDER, CHIEF] Assign an escort cohort.
[LEGION, COMMANDER, CHIEF] Add an escort Legion.
[LEGION, COMMANDER, CHIEF] Assign a legion to the mission.
Only cohorts of this legion will be considered for the job. You can assign multiple legions.
[LEGION, COMMANDER, CHIEF] 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 SQUADRON(s). Has to be a table {} even if a single squad is given.
Return value:
self
[LEGION, COMMANDER, CHIEF] Assign a transport cohort.
[LEGION, COMMANDER, CHIEF] Assign a transport Legion.
Check if all groups are done with their mission (or dead).
Defined in:
AUFTRAG
Return value:
#boolean:
If true, all groups are done with the mission.
Check if a mission type is contained in a list of possible capabilities.
Defined in:
AUFTRAG
Parameters:
#table MissionTypes
The requested mission type. Can also be passed as a single mission type #string.
#table Capabilities
A table with possible capabilities Ops.Auftrag#AUFTRAG.Capability.
#boolean All
If true, given mission type must be includedin ALL capabilities. If false or nil, it must only match one.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Check if a mission type is contained in a list of possible capabilities.
Defined in:
AUFTRAG
Parameters:
#table MissionTypes
The requested mission type. Can also be passed as a single mission type #string.
#table Capabilities
A table with possible capabilities Ops.Auftrag#AUFTRAG.Capability.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Check if a mission type is contained in a list of possible capabilities.
Defined in:
AUFTRAG
Parameters:
#table MissionTypes
The requested mission type. Can also be passed as a single mission type #string.
#table Capabilities
A table with possible capabilities Ops.Auftrag#AUFTRAG.Capability.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Checks if a mission type is contained in a table of possible types.
Defined in:
AUFTRAG
Parameters:
#string MissionType
The requested mission type.
#table PossibleTypes
A table with possible mission types.
Return value:
#boolean:
If true, the requested mission type is part of the possible mission types.
Count alive mission targets.
Defined in:
AUFTRAG
Return value:
#number:
Number of alive target units.
Count alive OPS groups assigned for this mission.
Defined in:
AUFTRAG
Return value:
#number:
Number of alive OPS groups.
Count OPS groups in a certain status.
Defined in:
AUFTRAG
Parameter:
#string Status
Status of group, e.g. AUFTRAG.GroupStatus.EXECUTING.
Return value:
#number:
Number of alive OPS 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:
Ops.OpsGroup#OPSGROUP OpsGroup
The OPSGROUP object.
Return value:
self
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.
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 casualties, i.e. number of own units that died during this mission.
Defined in:
AUFTRAG
Return value:
#number:
Number of dead units.
Get DCS task table for the given mission.
Defined in:
AUFTRAG
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:
Ops.OpsGroup#OPSGROUP opsgroup
The flight group.
Return value:
Flight data or nil if opsgroup does not exist.
Get Egress waypoint UID of OPS group.
Defined in:
AUFTRAG
Parameter:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
Return value:
#number:
Waypoint UID.
Get ops group mission status.
Defined in:
AUFTRAG
Parameter:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
Return value:
#string:
The group status.
Get mission (ingress) waypoint coordinate of OPS group
Defined in:
AUFTRAG
Parameter:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
Return value:
Waypoint Coordinate.
Get mission (ingress) waypoint UID of OPS group.
Defined in:
AUFTRAG
Parameter:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
Return value:
#number:
Waypoint UID.
Get mission waypoint task of OPS group.
Defined in:
AUFTRAG
Parameter:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
Return value:
task Waypoint task. Waypoint task.
Get mission importance.
Defined in:
AUFTRAG
Return value:
#number:
Importance. Smaller is higher.
Get kills, i.e.
number of units that were destroyed by assets of this mission.
Defined in:
AUFTRAG
Return value:
#number:
Number of units destroyed.
Get LEGION mission status.
Defined in:
AUFTRAG
Parameter:
Ops.Legion#LEGION Legion
The legion.
Return value:
#string:
status Current status.
Get the mission egress coordinate if this was defined.
Get DCS task table for an attack group or unit task.
Defined in:
AUFTRAG
Parameter:
#string MissionType
Mission (AUFTAG) type.
Return value:
#string:
DCS mission task for the auftrag type.
Get coordinate of target.
First unit/group of the set is used.
Defined in:
AUFTRAG
Parameter:
#table MissionTypes
A table of mission types.
Return value:
#string:
Comma separated list of mission types.
Get coordinate of target.
First unit/group of the set is used.
Defined in:
AUFTRAG
Parameters:
Wrapper.Group#GROUP group
Group.
#number randomradius
Random radius in meters.
#table surfacetypes
Surface types of random zone.
Return value:
Coordinate where the mission is executed.
Get mission name.
Defined in:
AUFTRAG
Return value:
#string:
Mission name, e.g. "Auftrag Nr.1".
Get number of required assets.
Defined in:
AUFTRAG
Return value:
#number:
Numer of required assets.
Get mission objective object.
Could be many things depending on the mission type.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE RefCoordinate
(Optional) Reference coordinate from which the closest target is determined.
#table Coalitions
(Optional) Only consider targets of the given coalition(s).
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 the attach OPS transport of the mission.
Defined in:
AUFTRAG
Return value:
The OPS transport assignment attached to the mission.
Get mission priority.
Defined in:
AUFTRAG
Return value:
#number:
Priority. Smaller is higher.
[LEGION, COMMANDER, CHIEF] Get number of required assets.
Defined in:
AUFTRAG
Return values:
#number:
Min. number of required assets.
#number:
Max. number of required assets.
Get coordinate of target.
Get target damage.
Defined in:
AUFTRAG
Return value:
#number:
Damage in percent.
Get target.
Get distance to target.
Defined in:
AUFTRAG
Parameter:
Core.Point#COORDINATE FromCoord
The coordinate from which the distance is measured.
Return value:
#number:
Distance in meters or 0.
Get heading of target.
Defined in:
AUFTRAG
Return value:
#number:
Heading of target in degrees.
Get target life points.
Defined in:
AUFTRAG
Return value:
#number:
Number of initial life points when mission was planned.
Get initial number of targets.
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.
Get mission type.
Defined in:
AUFTRAG
Return value:
#string:
Mission type, e.g. "BAI".
Check if mission is for aircarft (airplanes and/or helicopters).
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is for aircraft.
Check if mission is for airplanes.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is for airplanes.
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.
The first OPSGROUP has reached the mission execution waypoint and is not executing the mission task.
Defined in:
AUFTRAG
Parameter:
#boolean AllGroups
(Optional) Check that all groups are currently executing the mission.
Return value:
#boolean:
If true, mission is currently executing.
Check if mission is for ground units.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is for ground units.
Check if mission is for helicopters.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is for helicopters.
Check if mission is for naval units.
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, CANCELLED, SUCCESS, FAILED.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is over.
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 a LEGION mission queue.
Defined in:
AUFTRAG
Parameter:
Ops.Legion#LEGION Legion
(Optional) Check if mission is queued at this legion.
Return value:
#boolean:
If true, mission is queued.
Check if mission is ready to be cancelled.
- 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 ready to be pushed.
- Mission push time already passed.
- All push conditions are true.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission groups can push.
Check if mission is REQUESTED.
The mission request out to the WAREHOUSE.
Defined in:
AUFTRAG
Parameter:
Ops.Legion#LEGION Legion
(Optional) Check if mission is requested at this legion.
Return value:
#boolean:
If true, mission is requested.
Check if mission is SCHEDULED.
The first OPSGROUP has been assigned.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is queued.
Check if mission is STARTED.
The first OPSGROUP 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.
Check if mission is "urgent".
Defined in:
AUFTRAG
Return value:
#boolean:
If true, mission is "urgent".
Create a new generic AUFTRAG object.
[GROUND, NAVAL] Create an AIRDEFENSE mission.
Defined in:
AUFTRAG
Parameter:
Core.Zone#ZONE Zone
Zone where the air defense group(s) should be stationed.
Return value:
self
[AIR] Create an ALERT 5 mission.
Aircraft will be spawned uncontrolled and wait for an assignment. You must specify one mission type which is performed. This determines the payload and the DCS mission task which are used when the aircraft is spawned.
Defined in:
AUFTRAG
Parameter:
#string MissionType
Mission type AUFTRAG.Type.XXX. Determines payload and mission task (intercept, ground attack, etc.).
Return value:
self
[GROUND] Create a AMMO SUPPLY mission.
Defined in:
AUFTRAG
Parameter:
Core.Zone#ZONE Zone
The zone, where supply units go.
Return value:
self
[AIR] 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
[OBSOLETE] Create a ARMORATTACK mission.
* Note that this is actually creating a GROUNDATTACK mission!*
Defined in:
AUFTRAG
Parameters:
Ops.Target#TARGET Target
The target to attack. Can be a GROUP, UNIT or STATIC object.
#number Speed
Speed in knots.
#string Formation
The attack formation, e.g. "Wedge", "Vee" etc.
Return value:
self
[GROUND] Create an ARMORED ON GUARD mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Coordinate, where to stand guard.
#string Formation
Formation to take, e.g. "On Road", "Vee" etc.
Return value:
self
[GROUND, NAVAL] Create an ARTY mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Target
Center of the firing solution.
#number Nshots
Number of shots to be fired. Default #nil.
#number Radius
Radius of the shells in meters. Default 100 meters.
#number Altitude
Altitude in meters. Can be used to setup a Barrage. Default #nil.
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
[AIR] Create a AWACS mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
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
[AIR] 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 5000 ft.
Return value:
self
[GROUND, NAVAL] Create an BARRAGE mission.
Assigned groups will move to a random coordinate within a given zone and start firing into the air.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE Zone
The zone where the unit will go.
#number Heading
Heading in degrees. Default random heading [0, 360).
#number Angle
Shooting angle in degrees. Default random [45, 85].
#number Radius
Radius of the shells in meters. Default 100 meters.
#number Altitude
Altitude in meters. Default 500 m.
#number Nshots
Number of shots to be fired. Default is until ammo is empty (#nil).
Return value:
self
[AIR] Create a CARPET BOMBING mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Target
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
[AIR] Create a BOMBING mission.
Flight will drop bombs a specified coordinate. See DCS task bombing.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Target
Target coordinate. Can also be specified as a GROUP, UNIT, STATIC or TARGET object.
#number Altitude
Engage altitude in feet. Default 25000 ft.
Return value:
self
[AIR] Create a BOMBRUNWAY mission.
Defined in:
AUFTRAG
Parameters:
Wrapper.Airbase#AIRBASE Airdrome
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
[AIR] Create a CAP mission.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE_RADIUS ZoneCAP
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.
Core.Point#COORDINATE Coordinate
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
[AIR] Create a CAP mission over a (moving) group.
Defined in:
AUFTRAG
Parameters:
The grp to perform the CAP over.
#number Altitude
Orbit altitude in feet. Default is 6,000 ft.
#number Speed
Orbit speed in knots. Default 250 KIAS.
#number RelHeading
Relative heading [0, 360) of race-track pattern in degrees wrt heading of the carrier. Default is heading of the carrier.
#number Leg
Length of race-track in NM. Default 14 NM.
#number OffsetDist
Relative distance of the first race-track point wrt to the carrier. Default 6 NM.
#number OffsetAngle
Relative angle of the first race-track point wrt. to the carrier. Default 180 (behind the boat).
#number UpdateDistance
Threshold distance in NM before orbit pattern is updated. Default 5 NM.
#table TargetTypes
(Optional) Table of target types. Default {"Air"}.
#number EngageRange
Max range in nautical miles that the escort group(s) will engage enemies. Default 32 NM (60 km).
Return value:
self
[AIR, GROUND, NAVAL] Create a CAPTUREZONE mission.
Group(s) will go to the zone and patrol it randomly.
Defined in:
AUFTRAG
Parameters:
Ops.OpsZone#OPSZONE OpsZone
The OPS zone to capture.
#number Coalition
The coalition which should capture the zone for the mission to be successful.
#number Speed
Speed in knots.
#number Altitude
Altitude in feet. Only for airborne units. Default 2000 feet ASL.
#string Formation
Formation used by ground units during patrol. Default "Off Road".
Return value:
self
[AIR ROTARY] Create a CARGO TRANSPORT mission.
Important Note: The dropoff zone has to be a zone defined in the Mission Editor. This is due to a restriction in the used DCS task, which takes the zone ID as input. Only ME zones have an ID that can be referenced.
Defined in:
AUFTRAG
Parameters:
Wrapper.Static#STATIC StaticCargo
Static cargo object.
Core.Zone#ZONE DropZone
Zone where to drop off the cargo. Has to be a zone defined in the ME!
Return value:
self
[AIR] Create a CAS mission.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE_RADIUS ZoneCAS
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.
Core.Point#COORDINATE Coordinate
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
[AIR] Create a CASENHANCED mission.
Group(s) will go to the zone and patrol it randomly.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE CasZone
The CAS zone.
#number Altitude
Altitude in feet. Only for airborne units. Default 2000 feet ASL.
#number Speed
Speed in knots.
#number RangeMax
Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
Core.Set#SET_ZONE NoEngageZoneSet
Set of zones in which targets are not engaged. Default is nowhere.
#table TargetTypes
Types of target attributes that will be engaged. See DCS enum attributes. Default {"Helicopters", "Ground Units", "Light armed ships"}.
Return value:
self
[AIR] 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=-100, y=0, z=200} for z=200 meters to the right, same alitude (y=0), x=-100 meters behind.
#number EngageMaxDistance
Max engage distance of targets in nautical miles. Default auto 32 NM.
#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
[GROUND] Create an EWR mission.
Defined in:
AUFTRAG
Parameter:
Core.Zone#ZONE Zone
Zone where the Early Warning Radar group(s) should be stationed.
Return value:
self
[AIR, GROUND] Create a FAC mission.
Group(s) will go to the zone and patrol it randomly and act as FAC for detected units.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE FacZone
The FAC zone (or name of zone) where to patrol.
#number Speed
Speed in knots.
#number Altitude
Altitude in feet. Only for airborne units. Default 2000 feet ASL.
#number Frequency
Frequency in MHz.
#number Modulation
Modulation.
Return value:
self
[AIR] Create a FACA mission.
Defined in:
AUFTRAG
Parameters:
Wrapper.Group#GROUP Target
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
[GROUND] Create a FUEL SUPPLY mission.
Defined in:
AUFTRAG
Parameter:
Core.Zone#ZONE Zone
The zone, where supply units go.
Return value:
self
Create a mission to attack a TARGET object.
Defined in:
AUFTRAG
Parameters:
Ops.Target#TARGET Target
The target.
#string MissionType
The mission type.
Return value:
self
[AIR] Create a Ground Controlled CAP (GCICAP) mission.
Flights with this task are considered for A2A INTERCEPT missions by the CHIEF class. They will perform a combat air patrol but not engage by themselfs. They wait for the CHIEF to tell them whom to engage.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to orbit.
#number Altitude
Orbit altitude in feet. Default is y component of Coordinate.
#number Speed
Orbit indicated airspeed in knots at the set altitude ASL. 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
[GROUND] Create a GROUNDATTACK mission.
Ground group(s) will go to a target object and attack.
Defined in:
AUFTRAG
Parameters:
The target to attack. Can be a GROUP, UNIT or STATIC object.
#number Speed
Speed in knots. Default max.
#string Formation
The attack formation, e.g. "Wedge", "Vee" etc. Default ENUMS.Formation.Vehicle.Vee.
Return value:
self
[AIR/HELO] Create a GROUNDESCORT (or FOLLOW) mission.
Helo will escort a ground group and automatically engage certain target types.
Defined in:
AUFTRAG
Parameters:
Wrapper.Group#GROUP EscortGroup
The ground group to escort.
#number OrbitDistance
Orbit to/from the lead unit this many NM. Defaults to 1.5 NM.
#table TargetTypes
Types of targets to engage automatically. Default is {"Ground vehicles"}, i.e. all enemy ground units. Use an empty set {} for a simple "FOLLOW" mission.
Return value:
self
[AIR ROTARY] Create an HOVER mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to hover.
#number Altitude
Hover altitude in feet AGL. Default is 50 feet above ground.
#number Time
Time in seconds to hold the hover. Default 300 seconds.
#number Speed
Speed in knots to fly to the target coordinate. Default 150kn.
#number MissionAlt
Altitude to fly towards the mission in feet AGL. Default 1000ft.
Return value:
self
[AIR] 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
[AIR ROTARY] Create an LANDATCOORDINATE mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to land.
#number OuterRadius
(Optional) Vary the coordinate by this many feet, e.g. get a new random coordinate between OuterRadius and (optionally) avoiding InnerRadius of the coordinate.
#number InnerRadius
(Optional) Vary the coordinate by this many feet, e.g. get a new random coordinate between OuterRadius and (optionally) avoiding InnerRadius of the coordinate.
#number Time
Time in seconds to stay. Default 300 seconds.
#number Speed
Speed in knots to fly to the target coordinate. Default 150kn.
#number MissionAlt
Altitude to fly towards the mission in feet AGL. Default 1000ft.
#boolean CombatLanding
(Optional) If true, set the Combat Landing option.
#number DirectionAfterLand
(Optional) Heading after landing in degrees.
Return value:
self
[GROUND, NAVAL] Create a mission to do NOTHING.
Defined in:
AUFTRAG
Parameter:
Core.Zone#ZONE RelaxZone
Zone where the assets are supposed to do nothing.
Return value:
self
[GROUND, NAVAL] Create an ON GUARD mission.
Defined in:
AUFTRAG
Parameter:
Core.Point#COORDINATE Coordinate
Coordinate, where to stand guard.
Return value:
self
[AIR] Create an ORBIT mission, which can be either a circular orbit or a race-track pattern.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to orbit.
#number Altitude
Orbit altitude in feet above sea level. Default is y component of Coordinate.
#number Speed
Orbit indicated airspeed in knots at the set altitude ASL. 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
[AIR] Create an ORBIT mission, where the aircraft will go in a circle around the specified coordinate.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Position where to orbit around.
#number Altitude
Orbit altitude in feet. Default is y component of Coordinate.
#number Speed
Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
Return value:
self
[AIR] Create an ORBIT mission, where the aircraft will fly a circular or race-track pattern over a given group or unit.
Defined in:
AUFTRAG
Parameters:
Wrapper.Group#GROUP Group
Group where to orbit around. Can also be a UNIT object.
#number Altitude
Orbit altitude in feet. Default is 6,000 ft.
#number Speed
Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
#number Leg
Length of race-track in NM. Default nil.
#number Heading
Heading of race-track pattern in degrees. Default is heading of the group.
DCS#Vec2 OffsetVec2
Offset 2D-vector {x=0, y=0} in NM with respect to the group. Default directly overhead. Can also be given in polar coordinates {r=5, phi=45}.
#number Distance
Threshold distance in NM before orbit pattern is updated. Default 5 NM.
Return value:
self
[AIR] Create an ORBIT mission, where the aircraft will fly a race-track pattern.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to orbit.
#number Altitude
Orbit altitude in feet. Default is y component of Coordinate.
#number Speed
Orbit indicated airspeed in knots at the set altitude ASL. 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
[AIR, GROUND, NAVAL] Create a PATROLZONE mission.
Group(s) will go to the zone and patrol it randomly.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE Zone
The patrol zone.
#number Speed
Speed in knots.
#number Altitude
Altitude in feet. Only for airborne units. Default 2000 feet ASL.
#string Formation
Formation used by ground units during patrol. Default "Off Road".
Return value:
self
[AIR] Create an enhanced orbit race track mission.
Planes will keep closer to the track.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to start the race track.
#number Altitude
(Optional) Altitude in feet. Defaults to 20,000ft ASL.
#number Speed
(Optional) Speed in knots. Defaults to 300kn TAS.
#number Heading
(Optional) Heading in degrees, 0 to 360. Defaults to 90 degree (East).
#number Leg
(Optional) Leg of the race track in NM. Defaults to 10nm.
#number Formation
(Optional) Formation to take, e.g. ENUMS.Formation.FixedWing.Trail.Close, also see Hoggit Wiki.
Return value:
self
[GROUND] Create a REARMING mission.
Defined in:
AUFTRAG
Parameter:
Core.Zone#ZONE Zone
The zone, where units go and look for ammo supply.
Return value:
self
[AIR, GROUND, NAVAL] Create a RECON mission.
Defined in:
AUFTRAG
Parameters:
Core.Set#SET_ZONE ZoneSet
The recon zones.
#number Speed
Speed in knots.
#number Altitude
Altitude in feet. Only for airborne units. Default 2000 feet ASL.
#boolean Adinfinitum
If true, the group will start over again after reaching the final zone.
#boolean Randomly
If true, the group will select a random zone.
#string Formation
Formation used during recon route.
Return value:
self
[AIRPANE] Create a RECOVERY TANKER mission.
Defined in:
AUFTRAG
Parameters:
Wrapper.Unit#UNIT Carrier
The carrier unit.
#number Altitude
Orbit altitude in feet. Default is 6,000 ft.
#number Speed
Orbit speed in knots. Default 250 KIAS.
#number Leg
Length of race-track in NM. Default 14 NM.
#number RelHeading
Relative heading [0, 360) of race-track pattern in degrees wrt heading of the carrier. Default is heading of the carrier.
#number OffsetDist
Relative distance of the first race-track point wrt to the carrier. Default 6 NM.
#number OffsetAngle
Relative angle of the first race-track point wrt. to the carrier. Default 180 (behind the boat).
#number UpdateDistance
Threshold distance in NM before orbit pattern is updated. Default 5 NM.
Return value:
self
[AIR ROTARY] Create a RESCUE HELO mission.
[AIR] 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 25000 ft.
Return value:
self
[AIR] Create a STRAFING mission.
Assigns a point on the ground for which the AI will do a strafing run with guns or rockets. See DCS task strafing.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Target
Target coordinate. Can also be specified as a GROUP, UNIT, STATIC or TARGET object.
#number Altitude
Engage altitude in feet. Default 1000 ft.
#number Length
The total length of the strafing target in meters. Default nil.
Return value:
self
[AIR] Create a STRIKE mission.
Flight will attack the closest map object to the specified coordinate.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Target
The target coordinate. Can also be given as a GROUP, UNIT, STATIC or TARGET object.
#number Altitude
Engage altitude in feet. Default 2000 ft.
Return value:
self
[AIR] Create a TANKER mission.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Where to orbit.
#number Altitude
Orbit altitude in feet. Default is y component of Coordinate.
#number Speed
Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
#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 (0=boom, 1=probe). This info is only for AIRWINGs so they launch the right tanker type.
Return value:
self
[AIR ROTARY, GROUND] 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 first transport group.
#number PickupRadius
Radius around the pickup coordinate in meters. Default 100 m.
Return value:
self
On after "Cancel" event.
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 "Executing" 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 "Planned" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Queued" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
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 "Scheduled" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Started" event.
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.
Unit lost event.
Remove LEGION from mission.
Set alarm state for this mission.
Defined in:
AUFTRAG
Parameter:
#number Alarmstate
Alarm state 0=Auto, 1=Green, 2=Red.
Return value:
self
Set that (jet) aircraft are generally allowed to use afterburner.
Default is use of afterburner is allowed.
Set that (jet) aircraft are allowed to use afterburner in mission execution phase.
Default is use of afterburner is allowed.
[LEGION, COMMANDER, CHIEF] Set that only alive (spawned) assets are considered.
Defined in:
AUFTRAG
Parameter:
#boolean Switch
If true or nil, only active assets. If false
Return value:
self
Set time how long the mission is executed.
Once this time limit has passed, the mission is cancelled.
Set EPLRS datalink setting for this mission.
Defined in:
AUFTRAG
Parameter:
#boolean OnOffSwitch
If true or nil, EPLRS is on. If false, EPLRS is off.
Return value:
self
Set emission setting for this mission.
Defined in:
AUFTRAG
Parameter:
#boolean OnOffSwitch
If true or nil, emission is on. If false, emission is off.
Return value:
self
Enable markers, which dispay the mission status on the F10 map.
Defined in:
AUFTRAG
Parameter:
#number Coalition
The coaliton side to which the markers are dispayed. Default is to all.
Return value:
self
Set engage altitude.
This is the altitude passed to the DCS task. In the ME it is the tickbox ALTITUDE ABOVE.
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
Enable to automatically engage detected targets.
Defined in:
AUFTRAG
Parameters:
#number RangeMax
Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.
#table TargetTypes
Types of target attributes that will be engaged. See DCS enum attributes. Default "All".
Core.Set#SET_ZONE EngageZoneSet
Set of zones in which targets are engaged. Default is anywhere.
Core.Set#SET_ZONE NoEngageZoneSet
Set of zones in which targets are not engaged. Default is nowhere.
Return value:
self
Set time interval between mission done and success/failure evaluation.
Defined in:
AUFTRAG
Parameter:
#number Teval
Time in seconds before the mission result is evaluated. Default depends on mission type.
Return value:
self
Set formation for this mission.
Set Egress waypoint UID for OPS group.
Defined in:
AUFTRAG
Parameters:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
#number waypointindex
Waypoint UID.
Return value:
self
Set opsgroup mission status.
Defined in:
AUFTRAG
Parameters:
Ops.OpsGroup#OPSGROUP opsgroup
The flight group.
#string status
New status.
Return value:
self
Set mission (ingress) waypoint coordinate for OPS group.
Defined in:
AUFTRAG
Parameters:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
Core.Point#COORDINATE coordinate
Waypoint Coordinate.
Return value:
self
Set mission (ingress) waypoint UID for OPS group.
Defined in:
AUFTRAG
Parameters:
Ops.OpsGroup#OPSGROUP opsgroup
The OPS group.
#number waypointindex
Waypoint UID.
Return value:
self
Set mission waypoint task for OPS group.
Set ICLS beacon channel and Morse code for this mission.
Defined in:
AUFTRAG
Parameters:
#number Channel
ICLS channel.
#string Morse
Morse code. Default "XXX".
#string UnitName
Name of the unit in the group for which acts as ICLS beacon. Default is the first unit in the group.
Return value:
self
Set immortality setting for this mission.
Defined in:
AUFTRAG
Parameter:
#boolean OnOffSwitch
If true or nil, immortal is on. If false, immortal is off.
Return value:
self
Set invisibility setting for this mission.
Defined in:
AUFTRAG
Parameter:
#boolean OnOffSwitch
If true or nil, invisible is on. If false, invisible is off.
Return value:
self
Set LEGION mission status.
Defined in:
AUFTRAG
Parameters:
Ops.Legion#LEGION Legion
The legion.
#string Status
New status.
Return value:
self
Set mission altitude.
This is the altitude of the waypoint create where the DCS task is executed.
Set the mission egress coordinate.
This is the coordinate where the assigned group will go once the mission is finished.
Defined in:
AUFTRAG
Parameters:
Core.Point#COORDINATE Coordinate
Egrees coordinate.
#number Altitude
(Optional) Altitude in feet. Default is y component of coordinate.
Return value:
self
Set max mission range.
Only applies if the AUFTRAG is handled by an AIRWING or CHIEF. This is the max allowed distance from the airbase to the target.
Defined in:
AUFTRAG
Parameter:
#number Range
Max range in NM. Default 100 NM.
Return value:
self
Set mission speed.
That is the speed the group uses to get to the mission waypoint.
Set the mission waypoint coordinate where the mission is executed.
Note that altitude is set via :SetMissionAltitude.
Defined in:
AUFTRAG
Parameter:
Core.Point#COORDINATE Coordinate
Coordinate where the mission is executed.
Return value:
self
Set randomization of the mission waypoint coordinate.
Each assigned group will get a random ingress coordinate, where the mission is executed.
Defined in:
AUFTRAG
Parameter:
#number Radius
Distance in meters. Default #nil.
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
Attach OPS transport to the mission.
Mission assets will be transported before the mission is started at the OPSGROUP level.
Defined in:
AUFTRAG
Parameter:
Ops.OpsTransport#OPSTRANSPORT OpsTransport
The OPS transport assignment attached to the mission.
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.
#number Importance
Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is nil.
Return value:
self
Set that (jet) aircraft are generally not allowed to use afterburner.
Default is use of afterburner is allowed.
Set that (jet) aircraft are not allowed to use afterburner in mission execution phase.
Default is use of afterburner is allowed.
Set mission push time.
This is the time the mission is executed. If the push time is not passed, the group will wait at the mission execution waypoint.
Defined in:
AUFTRAG
Parameter:
#string ClockPush
Time the mission is executed, e.g. "05:00" for 5 am. Can also be given as a #number, where it is interpreted as relative push time in seconds.
Return value:
self
Set Rules of Engagement (ROE) for this mission.
Set Reaction on Threat (ROT) for this mission.
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
[LEGION, COMMANDER, CHIEF] Set that mission assets get reinforced if their number drops below the minimum number of required assets of the mission (c.f. SetRequiredAssets() function).
Note that reinforcement groups are only recruited from the legion (airwing, brigade, fleet) the mission was assigned to. If the legion does not have any more of these assets, no reinforcement can take place, even if the mission is submitted to a COMMANDER or CHIEF.
Defined in:
AUFTRAG
Parameter:
#number Nreinforce
Number of max asset groups used to reinforce.
Return value:
self
[LEGION, COMMANDER, CHIEF] Set how many times the mission is repeated.
Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
Defined in:
AUFTRAG
Parameter:
#number Nrepeat
Number of repeats. Default 0.
Return value:
self
[LEGION, COMMANDER, CHIEF] Set how many times the mission is repeated if it fails.
Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
Defined in:
AUFTRAG
Parameter:
#number Nrepeat
Number of repeats. Default 0.
Return value:
self
[LEGION, COMMANDER, CHIEF] Set how many times the mission is repeated if it was successful.
Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
Defined in:
AUFTRAG
Parameter:
#number Nrepeat
Number of repeats. Default 0.
Return value:
self
[LEGION, COMMANDER, CHIEF] Define how many assets are required to do the job.
Only used if the mission is handled by a LEGION (AIRWING, BRIGADE, ...) or higher level.
Defined in:
AUFTRAG
Parameters:
#number NassetsMin
Minimum number of asset groups. Default 1.
#number NassetsMax
Maximum Number of asset groups. Default is same as NassetsMin.
Return value:
self
[LEGION, COMMANDER, CHIEF] Set required attribute(s) the assets must have.
Defined in:
AUFTRAG
Parameter:
#table Attributes
Generalized attribute(s).
Return value:
self
[LEGION, COMMANDER, CHIEF] Set number of required carrier groups if an OPSTRANSPORT assignment is required.
Defined in:
AUFTRAG
Parameters:
#number NcarriersMin
Number of carriers at least required. Default 1.
#number NcarriersMax
Number of carriers at most used for transportation. Default is same as NcarriersMin.
#table Categories
Group categories.
#table Attributes
Group attributes. See GROUP.Attribute.
#table Properties
DCS attributes.
Return value:
self
[LEGION, COMMANDER, CHIEF] Define how many assets are required that escort the mission assets.
Only used if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
Defined in:
AUFTRAG
Parameters:
#number NescortMin
Minimum number of asset groups. Default 1.
#number NescortMax
Maximum Number of asset groups. Default is same as NassetsMin.
#string MissionType
Mission type assets will be optimized for and payload selected, e.g. AUFTRAG.Type.SEAD. Default nil.
#table TargetTypes
Target Types that will be engaged by the escort group(s). Default {"Air"} for aircraft and {"Ground Units"} for helos. Set, e.g., {"Air Defence"} for SEAD.
#number EngageRange
Max range in nautical miles that the escort group(s) will engage enemies. Default 32 NM (60 km).
Return value:
self
[LEGION, COMMANDER, CHIEF] Set required property or properties the assets must have.
These are DCS attributes.
Defined in:
AUFTRAG
Parameter:
#table Properties
Property or table of properties.
Return value:
self
[LEGION, COMMANDER, CHIEF] Attach OPS transport to the mission.
Mission assets will be transported before the mission is started at the OPSGROUP level.
Defined in:
AUFTRAG
Parameters:
Core.Zone#ZONE DeployZone
Zone where assets are deployed.
#number NcarriersMin
Number of carriers at least required. Default 1.
#number NcarriersMax
Number of carriers at most used for transportation. Default is same as NcarriersMin.
Core.Zone#ZONE DisembarkZone
Zone where assets are disembarked to.
#table Categories
Group categories.
#table Attributes
Generalizes group attributes.
#table Properties
DCS attributes.
Return value:
self
[LEGION, COMMANDER, CHIEF] Set whether assigned assets return to their legion once the mission is over.
This is only applicable to army and navy groups, i.e. aircraft will always return.
Defined in:
AUFTRAG
Parameter:
#boolean Switch
If true, assets will return. If false, assets will not return and stay where it finishes its last mission. If nil, let asset decide.
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".
#string UnitName
Name of the unit in the group for which acts as TACAN beacon. Default is the first unit in the group.
#string Band
Tacan channel mode ("X" or "Y"). Default is "X" for ground/naval and "Y" for aircraft.
Return value:
self
Set that mission assets are teleported to the mission execution waypoint.
Defined in:
AUFTRAG
Parameter:
#boolean Switch
If true or nil, teleporting is on. If false, teleporting is off.
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 verbosity level.
Defined in:
AUFTRAG
Parameter:
#number VerbosityLevel
Level of output (higher=more). Default 0.
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.
Add assets to mission.
Create a mission to attack a group.
Mission type is automatically chosen from the group category.
Defined in:
AUFTRAG
Parameter:
Target object.
Return value:
#string:
Auftrag type, e.g. AUFTRAG.Type.BAI (="BAI").
Get DCS task table for an attack group or unit task.
Defined in:
AUFTRAG
Parameters:
Ops.Target#TARGET Target
Target data.
#table DCStasks
DCS DCS tasks table to which the task is added.
Return value:
The DCS task table.
Get coordinate which was set as mission waypoint coordinate.
Defined in:
AUFTRAG
Return value:
Coordinate where the mission is executed or #nil.
Get request from legion this mission requested assets from.
Defined in:
AUFTRAG
Parameter:
Ops.Legion#LEGION Legion
The legion from which to get the request ID.
Return value:
Get request ID from legion this mission requested assets from
Defined in:
AUFTRAG
Parameter:
Ops.Legion#LEGION Legion
The legion from which to get the request ID.
Return value:
#number:
Request ID (if any).
Check if reinforcement is done.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, reinforcing is over.
Check if reinforcement is still ongoing.
Defined in:
AUFTRAG
Return value:
#boolean:
If true, reinforcing is ongoing.
[PRIVATE, AIR, GROUND, NAVAL] Create a mission to relocate all cohort assets to another LEGION.
Defined in:
AUFTRAG
Parameters:
Ops.Legion#LEGION Legion
The new legion.
Ops.Cohort#COHORT Cohort
The cohort to be relocated.
Return value:
self
Set request ID from legion this mission requested assets from
Defined in:
AUFTRAG
Parameters:
Ops.Legion#LEGION Legion
The legion from which to get the request ID.
#number RequestID
Request ID.
Return value:
self
Create target data from a given object.
Defined in:
AUFTRAG
Parameter:
The target GROUP, UNIT, STATIC.
Triggers the FSM event "Cancel" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Done" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Executing" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Failed" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Planned" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Queued" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Repeat" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Requested" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Scheduled" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Started" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Status" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Stop" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
Triggers the FSM event "Success" after a delay.
Defined in:
AUFTRAG
Parameter:
#number delay
Delay in seconds.
On after "AssetDead" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
The asset.
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 "ElementDestroyed" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Ops.OpsGroup#OPSGROUP OpsGroup
The ops group to which the element belongs.
Ops.OpsGroup#OPSGROUP.Element Element
The element that got destroyed.
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.
Ops.OpsGroup#OPSGROUP OpsGroup
The ops group that is dead now.
On after "Planned" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
On after "Queue" event.
Mission is added to the mission queue of a LEGION.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
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 an OPSGROUP.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
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 LEGION and OPSGROUP 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.
On before "Repeat" event.
Defined in:
AUFTRAG
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Field(s)
Name of the class.
DCS task structure.
Number of requested warehouse assets.
Number of required warehouse assets for each assigned legion.
Number of required warehouse assets for each assigned legion.
Max. number of required warehouse assets.
Min. number of required warehouse assets.
Number of assigned groups.
Max number of required carrier assets.
Min number of required carrier assets.
Number of own casualties during mission.
Number of assigned groups that are dead.
Number of elements (units) assigned to mission.
Max. number of required escort assets for each group the mission is assigned to.
Min. number of required escort assets for each group the mission is assigned to.
Number of (enemy) units killed by assets of this mission.
Number of times the mission is repeated.
Number of times mission is repeated if failed.
Number of times mission is repeated if successful.
Time stamp (abs) when mission is executing. Is #nil on start.
Mission abs. time stamp, when mission was over.
Mission push/execute time in abs. seconds.
Mission start time in abs. seconds.
Time stamp (abs) when mission is started.
Mission stop time in abs. seconds.
Alert 5 mission type. This is the mission type, the alerted assets will be able to carry out.
Altitude in meters. Can be used for a Barrage.
Shooting angle in degrees (for Barrage).
Heading in degrees (for Barrage).
Radius in meters.
Number of shots fired.
Warehouse assets assigned for this mission.
Generalized attribute(s) of assets.
Auftragsnummer.
Generalized attribute(s) of transport assets.
DCS attribute(s) of transport assets.
Mission categories.
If all conditions are true, the mission is cancelled.
If all conditions are true, the mission is executed. Before, the group(s) wait at the mission execution waypoint.
Condition(s) that have to be true, before the mission will be started.
If all conditions are true, the mission is cancelled.
Time interval in seconds before the mission result is evaluated after mission is over.
Mission duration in seconds.
Mission execution time in seconds.
Engagement altitude in meters.
Group attack.
Engagement direction in degrees.
Length of engage (carpet or strafing) in meters.
Max engage distance.
Number of times a target is engaged.
Table of target types that are engaged in the engagement zone.
How many weapons are used.
Weapon type used.
Set parameters.
Mission enroute tasks.
Cohorts explicitly requested for providing escorting assets.
Engage range in nautical miles (NM).
Name of the escorted group.
Legions explicitly requested for providing escorting assets.
Escort mission type.
Target types that will be engaged.
FAC datalink enabled.
FAC designation type.
FAC radio frequency in MHz.
FAC radio modulation 0=AM 1=FM.
Group specific data.
Importance.
If true, assets return to their legion (default). If false, they will stay alive.
Assigned legions.
Class id string for output to DCS log file.
Coalition to which the marker is dispayed.
If true, display marker on F10 map with the AUFTRAG status.
Mission altitude in meters.
Mission coordiante fraction. Default is 0.5.
Mission range in meters. Used by LEGION classes (AIRWING, BRIGADE, ...).
Mission speed in km/h.
Mission task. See ENUMS.MissionTask.
Random radius in meters.
Mission name.
Alarm state.
Counter measures.
ECM.
EPLRS datalink.
Emission is on or off.
Formation.
Immortal is on/off.
Invisible is on/off.
ROE.
ROT.
RTB on out-of-ammo.
RTB on out-of-fuel.
Orbit altitude in meters.
Distance threshold in meters for moving orbit targets.
Orbit heading in degrees.
Length of orbit leg in meters.
Orbit speed in m/s.
User specified airwing payloads for this mission. Only these will be considered for the job!
Mission priority.
DCS attribute(s) of assets.
Refuel type (boom or probe) for TANKER missions.
Number of times mission was repeated.
Number of times mission was repeated after a failure.
Number of times mission was repeated after a success.
The ID of the queued warehouse request. Necessary to cancel the request if the mission was cancelled before the request is processed.
User specified cohorts assigned for this mission. Only these will be considered for the job!
User specified legions assigned for this mission. Only these will be considered for the job!
Mission status.
Mission status of the CHIEF.
Mission status of the COMMANDER.
Mission status of all assigned LEGIONs.
Heading of target in degrees.
Groups are teleported to the mission ingress waypoint.
Cohorts explicitly requested for providing transport carrier assets.
Legions explicitly requested for providing transport carrier assets.
Radius in meters for pickup zone. Default 500 m.
Mission type.
If true, DCS task is updated at every status update of the assigned groups.
Mission is urgent. Running missions with lower prio might be cancelled.
Verbosity level.
AUFTRAG class version.
Function(s)
Adds an End 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.
Core.Fsm#FSM_PROCESS Process
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.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
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.
Sets the start state of the FSM.
Add to map.
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.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
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.
Mission capability.
Field(s)
Type of mission.
Number describing the performance level. The higher the better.
Function(s)
Mission category.
Field(s)
Airplanes and helicopters.
Airplanes.
Ground troops.
Helicopter.
Naval grous.
Function(s)
Generic mission condition.
Field(s)
Optional arguments passed to the condition callback function.
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)
Group mission status.
Egress Waypoint UID.
Mission (ingress) Waypoint UID.
Function(s)
Mission status of an assigned group.
Field(s)
Mission was cancelled.
Mission task of the Ops group is done.
Ops group is executing this mission.
Ops group has paused this mission, e.g. for refuelling.
Mission is scheduled in a FLIGHGROUP queue waiting to be started.
Ops group started this mission but it is not executed yet.
Function(s)
Special task description.
Field(s)
Air defense.
Alert 5 task.
Ammo Supply.
On guard with armor.
Barrage.
Capture OPS zone.
Early Warning Radar.
Ferry mission.
AI formation task.
Fuel Supply.
Ground attack.
Hover.
Nothing.
On guard.
Patrol Racetrack.
Patrol zone task.
Rearming.
Recon task.
Recovery tanker.
Relocate cohort.
Function(s)
Mission status.
Field(s)
Mission was cancelled.
Mission is over.
Mission is being executed.
Mission failed.
Mission is at the early planning stage and has not been added to any queue.
Mission is queued at a LEGION.
Mission assets were requested from the warehouse.
Mission is scheduled in an OPSGROUP queue waiting to be started.
Mission has started but is not executed yet.
Mission was a success.
Function(s)
Mission success.
Field(s)
Target was damaged.
Target was destroyed.
Target was engaged.
Group did survive.
Function(s)
Target data.
Field(s)
Total life points.
Inital life points.
Target name.
Number of initial targets.
Target type: "Group", "Unit", "Static", "Coordinate", "Airbase", "SetGroup", "SetUnit".
Function(s)
Target type.
Field(s)
Target is an AIRBASE.
Target is a COORDINATE.
Target is a GROUP object.
Target is a SET of GROUPs.
Target is a SET of UNITs.
Target is a STATIC object.
Target is a UNIT object.
Function(s)
Mission types.
Field(s)
Air defense.
Alert 5.
Ammo supply.
Anti-ship mission.
Armor attack.
On guard - with armored groups.
Fire at point.
AWACS mission.
Battlefield Air Interdiction.
Barrage.
Carpet bombing.
Bombing mission.
Bomb runway of an airbase.
Combat Air Patrol.
Capture zone mission.
Cargo transport.
Close Air Support.
Enhanced CAS.
Escort mission.
Early Warning Radar.
Forward AirController mission.
Forward AirController airborne mission.
Ferry mission.
Fuel supply.
Similar to CAP but no auto engage targets.
Ground attack.
Ground escort mission.
Hover.
Intercept mission.
Land at coordinate.
Nothing.
On guard.
Ops transport.
Orbit mission.
Patrol Racetrack.
Patrol a zone.
Rearming mission.
Recon mission.
Recovery tanker.
Relocate a cohort from one legion to another.
Rescue helo.
Suppression/destruction of enemy air defences.
Strafing run.
Strike mission.
Tanker mission.
Troop transport mission.