Module Ops.Auftrag

self

AUFTRAG:AddConditionFailure(ConditionFunction, ...)

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

AUFTRAG:AddConditionPush(ConditionFunction, ...)

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

AUFTRAG:AddConditionStart(ConditionFunction, ...)

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

AUFTRAG:AddConditionSuccess(ConditionFunction, ...)

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

AUFTRAG:AddLegion(Legion)

Add LEGION to mission.

Defined in:

AUFTRAG

Parameter:

Ops.Legion#LEGION Legion

The legion.

Return value:

self

AUFTRAG:AddOpsGroup(OpsGroup)

Add a Ops group to the mission.

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP OpsGroup

The OPSGROUP object.

Return value:

self

AUFTRAG:AddRequiredPayload(Payload)

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

AUFTRAG:AddTransportCarriers(Carriers)

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

AUFTRAG:AssignCohort(Cohort)

[LEGION, COMMANDER, CHIEF] Assign a legion cohort to the mission.

Only these cohorts will be considered for the job.

Defined in:

AUFTRAG

Parameter:

Ops.Cohort#COHORT Cohort

The cohort.

Return value:

self

AUFTRAG:AssignEscortCohort(Cohort)

[LEGION, COMMANDER, CHIEF] Assign an escort cohort.

Defined in:

AUFTRAG

Parameter:

Ops.Cohort#Cohort Cohort

The cohort.

AUFTRAG:AssignEscortLegion(Legion)

[LEGION, COMMANDER, CHIEF] Add an escort Legion.

Defined in:

AUFTRAG

Parameter:

Ops.Legion#LEGION Legion

The legion.

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

Defined in:

AUFTRAG

Parameter:

Ops.Legion#LEGION Legion

The legion.

Return value:

self

AUFTRAG:AssignSquadrons(Squadrons)

[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

AUFTRAG:AssignTransportCohort(Cohort)

[LEGION, COMMANDER, CHIEF] Assign a transport cohort.

Defined in:

AUFTRAG

Parameter:

Ops.Cohort#Cohort Cohort

The cohort.

AUFTRAG:AssignTransportLegion(Legion)

[LEGION, COMMANDER, CHIEF] Assign a transport Legion.

Defined in:

AUFTRAG

Parameter:

Ops.Legion#LEGION Legion

The legion.

AUFTRAG:Cancel()

Triggers the FSM event "Cancel".

Defined in:

AUFTRAG

AUFTRAG:CheckGroupsDone()

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.

AUFTRAG.CheckMissionCapability(MissionTypes, Capabilities, All)

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.

AUFTRAG.CheckMissionCapabilityAll(MissionTypes, Capabilities)

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.

AUFTRAG.CheckMissionCapabilityAny(MissionTypes, Capabilities)

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.

AUFTRAG.CheckMissionType(MissionType, PossibleTypes)

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.

AUFTRAG:CountMissionTargets()

Count alive mission targets.

Defined in:

AUFTRAG

Return value:

#number:

Number of alive target units.

AUFTRAG:CountOpsGroups()

Count alive OPS groups assigned for this mission.

Defined in:

AUFTRAG

Return value:

#number:

Number of alive OPS groups.

AUFTRAG:CountOpsGroupsInStatus(Status)

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.

AUFTRAG:DelAsset(Asset)

Delete asset from mission.

Defined in:

AUFTRAG

Parameter:

Functional.Warehouse#WAREHOUSE.Assetitem Asset

The asset to be removed.

Return value:

self

AUFTRAG:DelOpsGroup(OpsGroup)

Remove an Ops group from the mission.

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP OpsGroup

The OPSGROUP object.

Return value:

self

AUFTRAG:Done()

Triggers the FSM event "Done".

Defined in:

AUFTRAG

AUFTRAG:EvalConditionsAll(Conditions)

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.

AUFTRAG:EvalConditionsAny(Conditions)

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.

AUFTRAG:Evaluate()

Evaluate mission outcome - success or failure.

Defined in:

AUFTRAG

Return value:

Functional.Warehouse#WAREHOUSE.Assetitem:

self

AUFTRAG:Executing()

Triggers the FSM event "Executing".

Defined in:

AUFTRAG

AUFTRAG:Failed()

Triggers the FSM event "Failed".

Defined in:

AUFTRAG

AUFTRAG:GetAssetByName(Name)

Get asset by its spawn group name.

Defined in:

AUFTRAG

Parameter:

#string Name

Asset spawn group name.

Return value:

Asset.

AUFTRAG:GetAssetDataByName(AssetName)

Get asset data table.

Defined in:

AUFTRAG

Parameter:

#string AssetName

Name of the asset.

Return value:

#AUFTRAG.GroupData:

Group data or nil if OPS group does not exist.

AUFTRAG:GetCasualties()

Get casualties, i.e. number of own units that died during this mission.

Defined in:

AUFTRAG

Return value:

#number:

Number of dead units.

AUFTRAG:GetDCSMissionTask()

Get DCS task table for the given mission.

Defined in:

AUFTRAG

Return value:

DCS#Task:

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

AUFTRAG:GetGroupData(opsgroup)

Get flight data table.

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP opsgroup

The flight group.

Return value:

#AUFTRAG.GroupData:

Flight data or nil if opsgroup does not exist.

AUFTRAG:GetGroupEgressWaypointUID(opsgroup)

Get Egress waypoint UID of OPS group.

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP opsgroup

The OPS group.

Return value:

#number:

Waypoint UID.

AUFTRAG:GetGroupStatus(opsgroup)

Get ops group mission status.

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP opsgroup

The OPS group.

Return value:

#string:

The group status.

AUFTRAG:GetGroupWaypointCoordinate(opsgroup)

Get mission (ingress) waypoint coordinate of OPS group

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP opsgroup

The OPS group.

Return value:

Ops.OpsGroup#OPSGROUP.Task:

Waypoint Coordinate.

AUFTRAG:GetGroupWaypointIndex(opsgroup)

Get mission (ingress) waypoint UID of OPS group.

Defined in:

AUFTRAG

Parameter:

Ops.OpsGroup#OPSGROUP opsgroup

The OPS group.

Return value:

#number:

Waypoint UID.

AUFTRAG:GetGroupWaypointTask(opsgroup)

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.

AUFTRAG:GetImportance()

Get mission importance.

Defined in:

AUFTRAG

Return value:

#number:

Importance. Smaller is higher.

AUFTRAG:GetKills()

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.

AUFTRAG:GetLegionStatus(Legion)

Get LEGION mission status.

Defined in:

AUFTRAG

Parameter:

Ops.Legion#LEGION Legion

The legion.

Return value:

#string:

status Current status.

AUFTRAG:GetMissionEgressCoord()

Get the mission egress coordinate if this was defined.

Defined in:

AUFTRAG

Return value:

Coordinate Coordinate or nil.

AUFTRAG:GetMissionTaskforMissionType(MissionType)

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.

AUFTRAG:GetMissionTypesText(MissionTypes)

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.

AUFTRAG:GetMissionWaypointCoord(group, randomradius, surfacetypes)

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:

Wrapper.Positionable#POSITIONABLE:

Coordinate where the mission is executed.

AUFTRAG:GetName()

Get mission name.

Defined in:

AUFTRAG

Return value:

#string:

Mission name, e.g. "Auftrag Nr.1".

AUFTRAG:GetNumberOfRequiredAssets()

Get number of required assets.

Defined in:

AUFTRAG

Return value:

#number:

Numer of required assets.

AUFTRAG:GetObjective(RefCoordinate, Coalitions)

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.

AUFTRAG:GetOpsGroups()

Get all OPS groups.

Defined in:

AUFTRAG

Return value:

#table:

Table of Ops.OpsGroup#OPSGROUP or {}.

AUFTRAG:GetOpsTransport()

Get the attach OPS transport of the mission.

Defined in:

AUFTRAG

Return value:

Ops.OpsTransport#OPSTRANSPORT:

The OPS transport assignment attached to the mission.

AUFTRAG:GetPriority()

Get mission priority.

Defined in:

AUFTRAG

Return value:

#number:

Priority. Smaller is higher.

AUFTRAG:GetRequiredAssets()

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

AUFTRAG:GetTargetCoordinate()

Get coordinate of target.

Defined in:

AUFTRAG

Return value:

The target coordinate or nil.

AUFTRAG:GetTargetDamage()

Get target damage.

Defined in:

AUFTRAG

Return value:

#number:

Damage in percent.

AUFTRAG:GetTargetData()

Get target.

Defined in:

AUFTRAG

Return value:

Ops.Target#TARGET:

The target object. Could be many things.

AUFTRAG:GetTargetDistance(FromCoord)

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.

AUFTRAG:GetTargetHeading()

Get heading of target.

Defined in:

AUFTRAG

Return value:

#number:

Heading of target in degrees.

AUFTRAG:GetTargetInitialLife()

Get target life points.

Defined in:

AUFTRAG

Return value:

#number:

Number of initial life points when mission was planned.

AUFTRAG:GetTargetInitialNumber()

Get initial number of targets.

Defined in:

AUFTRAG

Return value:

#number:

Number of initial life points when mission was planned.

AUFTRAG:GetTargetLife()

Get target life points.

Defined in:

AUFTRAG

Return value:

#number:

Life points of target.

AUFTRAG:GetTargetName()

Get name of the target.

Defined in:

AUFTRAG

Return value:

#string:

Name of the target or "N/A".

AUFTRAG:GetTargetType()

Get type of target.

Defined in:

AUFTRAG

Return value:

#string:

The target type.

AUFTRAG:GetTargetVec2()

Get 2D vector of target.

Defined in:

AUFTRAG

Return value:

DCS#VEC2:

The target 2D vector or nil.

AUFTRAG:GetType()

Get mission type.

Defined in:

AUFTRAG

Return value:

#string:

Mission type, e.g. "BAI".

AUFTRAG:IsAircraft()

Check if mission is for aircarft (airplanes and/or helicopters).

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is for aircraft.

AUFTRAG:IsAirplane()

Check if mission is for airplanes.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is for airplanes.

AUFTRAG:IsCancelled()

Check if mission was cancelled.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission was cancelled.

AUFTRAG:IsDone()

Check if mission is done.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is done.

AUFTRAG:IsExecuting(AllGroups)

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.

AUFTRAG:IsGround()

Check if mission is for ground units.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is for ground units.

AUFTRAG:IsHelicopters()

Check if mission is for helicopters.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is for helicopters.

AUFTRAG:IsNaval()

Check if mission is for naval units.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is for naval units.

AUFTRAG:IsNotOver()

Check if mission is NOT over.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is NOT over yet.

AUFTRAG:IsOver()

Check if mission is over.

This could be state DONE, CANCELLED, SUCCESS, FAILED.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is over.

AUFTRAG:IsPlanned()

Check if mission is PLANNED.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is in the planning state.

AUFTRAG:IsQueued(Legion)

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.

AUFTRAG:IsReadyToCancel()

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.

AUFTRAG:IsReadyToGo()

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.

AUFTRAG:IsReadyToPush()

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.

AUFTRAG:IsRequested(Legion)

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.

AUFTRAG:IsScheduled()

Check if mission is SCHEDULED.

The first OPSGROUP has been assigned.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is queued.

AUFTRAG:IsStarted()

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.

AUFTRAG:IsSuccess()

Check if mission was a success.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission was successful.

AUFTRAG:IsUrgent()

Check if mission is "urgent".

Defined in:

AUFTRAG

Return value:

#boolean:

If true, mission is "urgent".

AUFTRAG:New(Type)

Create a new generic AUFTRAG object.

Defined in:

AUFTRAG

Parameter:

#string Type

Mission type.

Return value:

self

AUFTRAG:NewAIRDEFENSE(Zone)

[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

AUFTRAG:NewALERT5(MissionType)

[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

AUFTRAG:NewAMMOSUPPLY(Zone)

[GROUND] Create a AMMO SUPPLY mission.

Defined in:

AUFTRAG

Parameter:

Core.Zone#ZONE Zone

The zone, where supply units go.

Return value:

self

AUFTRAG:NewANTISHIP(Target, Altitude)

[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

AUFTRAG:NewARMORATTACK(Target, Speed, Formation)

[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

AUFTRAG:NewARMOREDGUARD(Coordinate, Formation)

[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

AUFTRAG:NewARTY(Target, Nshots, Radius, Altitude)

[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

AUFTRAG:NewAUTO(EngageGroup)

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

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

[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

AUFTRAG:NewBAI(Target, Altitude)

[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

AUFTRAG:NewBARRAGE(Zone, Heading, Angle, Radius, Altitude, Nshots)

[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

AUFTRAG:NewBOMBCARPET(Target, Altitude, CarpetLength)

[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

AUFTRAG:NewBOMBING(Target, Altitude)

[AIR] Create a BOMBING mission.

Flight will drop bombs a specified coordinate.

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

AUFTRAG:NewBOMBRUNWAY(Airdrome, Altitude)

[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

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

[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

AUFTRAG:NewCAPGROUP(Grp, Altitude, Speed, RelHeading, Leg, OffsetDist, OffsetAngle, UpdateDistance, TargetTypes, EngageRange)

[AIR] Create a CAP mission over a (moving) group.

Defined in:

AUFTRAG

Parameters:

Wrapper.Group#GROUP Grp

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

AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation)

[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

AUFTRAG:NewCARGOTRANSPORT(StaticCargo, DropZone)

[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

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

[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

AUFTRAG:NewCASENHANCED(CasZone, Altitude, Speed, RangeMax, NoEngageZoneSet, TargetTypes)

[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

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

[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

AUFTRAG:NewEWR(Zone)

[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

AUFTRAG:NewFAC(FacZone, Speed, Altitude, Frequency, Modulation)

[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

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

[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

AUFTRAG:NewFUELSUPPLY(Zone)

[GROUND] Create a FUEL SUPPLY mission.

Defined in:

AUFTRAG

Parameter:

Core.Zone#ZONE Zone

The zone, where supply units go.

Return value:

self

AUFTRAG:NewFromTarget(Target, MissionType)

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

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

[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

AUFTRAG:NewGROUNDATTACK(Target, Speed, Formation)

[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

AUFTRAG:NewGROUNDESCORT(EscortGroup, OrbitDistance, TargetTypes)

[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

AUFTRAG:NewHOVER(Coordinate, Altitude, Time, Speed, MissionAlt)

[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

AUFTRAG:NewINTERCEPT(Target)

[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

AUFTRAG:NewLANDATCOORDINATE(Coordinate, OuterRadius, InnerRadius, Time, Speed, MissionAlt)

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

Return value:

self

AUFTRAG:NewNOTHING(RelaxZone)

[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

AUFTRAG:NewONGUARD(Coordinate)

[GROUND, NAVAL] Create an ON GUARD mission.

Defined in:

AUFTRAG

Parameter:

Core.Point#COORDINATE Coordinate

Coordinate, where to stand guard.

Return value:

self

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

[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

AUFTRAG:NewORBIT_CIRCLE(Coordinate, Altitude, Speed)

[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

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.

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

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

[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

AUFTRAG:NewPATROLZONE(Zone, Speed, Altitude, Formation)

[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

AUFTRAG:NewPATROL_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg, Formation)

[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

AUFTRAG:NewREARMING(Zone)

[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

AUFTRAG:NewRECON(ZoneSet, Speed, Altitude, Adinfinitum, Randomly, Formation)

[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

AUFTRAG:NewRECOVERYTANKER(Carrier, Altitude, Speed, Leg, RelHeading, OffsetDist, OffsetAngle, UpdateDistance)

[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

AUFTRAG:NewRESCUEHELO(Carrier)

[AIR ROTARY] Create a RESCUE HELO mission.

Defined in:

AUFTRAG

Parameter:

Wrapper.Unit#UNIT Carrier

The carrier unit.

Return value:

self

AUFTRAG:NewSEAD(Target, Altitude)

[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

AUFTRAG:NewSTRIKE(Target, Altitude)

[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

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

[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

AUFTRAG:NewTROOPTRANSPORT(TransportGroupSet, DropoffCoordinate, PickupCoordinate, PickupRadius)

[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

AUFTRAG:OnAfterCancel(From, Event, To)

On after "Cancel" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterDone(From, Event, To)

On after "Done" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterExecuting(From, Event, To)

On after "Executing" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterFailed(From, Event, To)

On after "Failed" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterPlanned(From, Event, To)

On after "Planned" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterQueued(From, Event, To)

On after "Queued" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterRepeat(From, Event, To)

On after "Repeat" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterRequested(From, Event, To)

On after "Requested" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterScheduled(From, Event, To)

On after "Scheduled" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterStarted(From, Event, To)

On after "Started" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnAfterSuccess(From, Event, To)

On after "Success" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:OnEventUnitLost(EventData)

Unit lost event.

Defined in:

AUFTRAG

Parameter:

Core.Event#EVENTDATA EventData

Event data.

AUFTRAG:Planned()

Triggers the FSM event "Planned".

Defined in:

AUFTRAG

AUFTRAG:Queued()

Triggers the FSM event "Queued".

Defined in:

AUFTRAG

AUFTRAG:RemoveLegion(Legion)

Remove LEGION from mission.

Defined in:

AUFTRAG

Parameter:

Ops.Legion#LEGION Legion

The legion.

Return value:

self

AUFTRAG:Repeat()

Triggers the FSM event "Repeat".

Defined in:

AUFTRAG

AUFTRAG:Requested()

Triggers the FSM event "Requested".

Defined in:

AUFTRAG

AUFTRAG:Scheduled()

Triggers the FSM event "Scheduled".

Defined in:

AUFTRAG

AUFTRAG:SetAlarmstate(Alarmstate)

Set alarm state for this mission.

Defined in:

AUFTRAG

Parameter:

#number Alarmstate

Alarm state 0=Auto, 1=Green, 2=Red.

Return value:

self

AUFTRAG:SetAllowAfterburner()

Set that (jet) aircraft are generally allowed to use afterburner.

Default is use of afterburner is allowed.

Defined in:

AUFTRAG

Return value:

self

AUFTRAG:SetAllowAfterburnerExecutePhase()

Set that (jet) aircraft are allowed to use afterburner in mission execution phase.

Default is use of afterburner is allowed.

Defined in:

AUFTRAG

Return value:

self

AUFTRAG:SetAssetsStayAlive(Switch)

[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

AUFTRAG:SetDuration(Duration)

Set time how long the mission is executed.

Once this time limit has passed, the mission is cancelled.

Defined in:

AUFTRAG

Parameter:

#number Duration

Duration in seconds.

Return value:

self

AUFTRAG:SetEPLRS(OnOffSwitch)

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

AUFTRAG:SetEmission(OnOffSwitch)

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

AUFTRAG:SetEnableMarkers(Coalition)

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

AUFTRAG:SetEngageAltitude(Altitude)

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

AUFTRAG:SetEngageAsGroup(Switch)

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

AUFTRAG:SetEngageDetected(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)

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

AUFTRAG:SetEvaluationTime(Teval)

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

AUFTRAG:SetFormation(Formation)

Set formation for this mission.

Defined in:

AUFTRAG

Parameter:

#number Formation

Formation.

Return value:

self

AUFTRAG:SetGroupEgressWaypointUID(opsgroup, waypointindex)

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

AUFTRAG:SetGroupStatus(opsgroup, status)

Set opsgroup mission status.

Defined in:

AUFTRAG

Parameters:

Ops.OpsGroup#OPSGROUP opsgroup

The flight group.

#string status

New status.

Return value:

self

AUFTRAG:SetGroupWaypointCoordinate(opsgroup, coordinate)

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

AUFTRAG:SetGroupWaypointIndex(opsgroup, waypointindex)

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

AUFTRAG:SetGroupWaypointTask(opsgroup, task)

Set mission waypoint task for OPS group.

Defined in:

AUFTRAG

Parameters:

Ops.OpsGroup#OPSGROUP opsgroup

The OPS group.

Ops.OpsGroup#OPSGROUP.Task task

Waypoint task.

AUFTRAG:SetICLS(Channel, Morse, UnitName)

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

AUFTRAG:SetImmortal(OnOffSwitch)

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

AUFTRAG:SetInvisible(OnOffSwitch)

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

AUFTRAG:SetLegionStatus(Legion, Status)

Set LEGION mission status.

Defined in:

AUFTRAG

Parameters:

Ops.Legion#LEGION Legion

The legion.

#string Status

New status.

Return value:

self

AUFTRAG:SetMissionAltitude(Altitude)

Set mission altitude.

This is the altitude of the waypoint create where the DCS task is executed.

Defined in:

AUFTRAG

Parameter:

#string Altitude

Altitude in feet.

Return value:

self

AUFTRAG:SetMissionEgressCoord(Coordinate, Altitude)

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

AUFTRAG:SetMissionRange(Range)

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

AUFTRAG:SetMissionSpeed(Speed)

Set mission speed.

That is the speed the group uses to get to the mission waypoint.

Defined in:

AUFTRAG

Parameter:

#string Speed

Mission speed in knots.

Return value:

self

AUFTRAG:SetMissionWaypointCoord(Coordinate)

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

AUFTRAG:SetMissionWaypointRandomization(Radius)

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

AUFTRAG:SetName(Name)

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

AUFTRAG:SetOpsTransport(OpsTransport)

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

AUFTRAG:SetPriority(Prio, Urgent, Importance)

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

AUFTRAG:SetProhibitAfterburner()

Set that (jet) aircraft are generally not allowed to use afterburner.

Default is use of afterburner is allowed.

Defined in:

AUFTRAG

Return value:

self

AUFTRAG:SetProhibitAfterburnerExecutePhase()

Set that (jet) aircraft are not allowed to use afterburner in mission execution phase.

Default is use of afterburner is allowed.

Defined in:

AUFTRAG

Return value:

self

AUFTRAG:SetPushTime(ClockPush)

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

AUFTRAG:SetROE(roe)

Set Rules of Engagement (ROE) for this mission.

Defined in:

AUFTRAG

Parameter:

#string roe

Mission ROE.

Return value:

self

AUFTRAG:SetROT(rot)

Set Reaction on Threat (ROT) for this mission.

Defined in:

AUFTRAG

Parameter:

#string rot

Mission ROT.

Return value:

self

AUFTRAG:SetRadio(Frequency, Modulation)

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

AUFTRAG:SetReinforce(Nreinforce)

[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

AUFTRAG:SetRepeat(Nrepeat)

[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

AUFTRAG:SetRepeatOnFailure(Nrepeat)

[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

AUFTRAG:SetRepeatOnSuccess(Nrepeat)

[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

AUFTRAG:SetRequiredAssets(NassetsMin, NassetsMax)

[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

AUFTRAG:SetRequiredAttribute(Attributes)

[LEGION, COMMANDER, CHIEF] Set required attribute(s) the assets must have.

Defined in:

AUFTRAG

Parameter:

#table Attributes

Generalized attribute(s).

Return value:

self

AUFTRAG:SetRequiredCarriers(NcarriersMin, NcarriersMax, Categories, Attributes, Properties)

[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

AUFTRAG:SetRequiredEscorts(NescortMin, NescortMax, MissionType, TargetTypes, EngageRange)

[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

AUFTRAG:SetRequiredProperty(Properties)

[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

AUFTRAG:SetRequiredTransport(DeployZone, NcarriersMin, NcarriersMax, DisembarkZone, Categories, Attributes, Properties)

[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

AUFTRAG:SetReturnToLegion(Switch)

[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

AUFTRAG:SetTACAN(Channel, Morse, UnitName, Band)

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

AUFTRAG:SetTeleport(Switch)

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

AUFTRAG:SetTime(ClockStart, ClockStop)

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

AUFTRAG:SetVerbosity(VerbosityLevel)

Set verbosity level.

Defined in:

AUFTRAG

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

AUFTRAG:SetWeaponExpend(WeaponExpend)

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

AUFTRAG:SetWeaponType(WeaponType)

Set weapon type used for the engagement.

Defined in:

AUFTRAG

Parameter:

#number WeaponType

Weapon type. Default is ENUMS.WeaponFlag.Auto.

Return value:

self

AUFTRAG:Started()

Triggers the FSM event "Started".

Defined in:

AUFTRAG

AUFTRAG:Status()

Triggers the FSM event "Status".

Defined in:

AUFTRAG

AUFTRAG:Stop()

Triggers the FSM event "Stop".

Defined in:

AUFTRAG

AUFTRAG:Success()

Triggers the FSM event "Success".

Defined in:

AUFTRAG

AUFTRAG:UpdateMarker()

Update mission F10 map marker.

Defined in:

AUFTRAG

Return value:

self

AUFTRAG:_AddAssets(Assets)

Add assets to mission.

Defined in:

AUFTRAG

Parameter:

#table Assets

List of assets.

Return value:

self

AUFTRAG:_DetermineAuftragType(Target)

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

AUFTRAG:_GetDCSAttackTask(Target, DCStasks)

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:

DCS#Task:

The DCS task table.

AUFTRAG:_GetMissionWaypointCoordSet()

Get coordinate which was set as mission waypoint coordinate.

Defined in:

AUFTRAG

Return value:

Functional.Warehouse#WAREHOUSE.PendingItem:

Coordinate where the mission is executed or #nil.

AUFTRAG:_GetRequest(Legion)

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:

Request.

AUFTRAG:_GetRequestID(Legion)

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

AUFTRAG:_IsNotReinforcing()

Check if reinforcement is done.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, reinforcing is over.

AUFTRAG:_IsReinforcing()

Check if reinforcement is still ongoing.

Defined in:

AUFTRAG

Return value:

#boolean:

If true, reinforcing is ongoing.

AUFTRAG:_NewRELOCATECOHORT(Legion, Cohort)

[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

AUFTRAG:_SetLogID()

Set log ID string.

Defined in:

AUFTRAG

Return value:

self

AUFTRAG:_SetRequestID(Legion, RequestID)

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

AUFTRAG:_TargetFromObject(Object)

Create target data from a given object.

Defined in:

AUFTRAG

Parameter:

Wrapper.Positionable#POSITIONABLE Object

The target GROUP, UNIT, STATIC.

AUFTRAG:__Cancel(delay)

Triggers the FSM event "Cancel" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Done(delay)

Triggers the FSM event "Done" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Executing(delay)

Triggers the FSM event "Executing" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Failed(delay)

Triggers the FSM event "Failed" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Planned(delay)

Triggers the FSM event "Planned" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Queued(delay)

Triggers the FSM event "Queued" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Repeat(delay)

Triggers the FSM event "Repeat" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Requested(delay)

Triggers the FSM event "Requested" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Scheduled(delay)

Triggers the FSM event "Scheduled" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Started(delay)

Triggers the FSM event "Started" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

AUFTRAG:__Success(delay)

Triggers the FSM event "Success" after a delay.

Defined in:

AUFTRAG

Parameter:

#number delay

Delay in seconds.

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

On after "AssetDead" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Functional.Warehouse#WAREHOUSE.Assetitem Asset

The asset.

AUFTRAG:onafterAssign(From, Event, To)

On after "Assign" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterCancel(From, Event, To)

On after "Cancel" event.

Cancells the mission.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterDone(From, Event, To)

On after "Done" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterElementDestroyed(From, Event, To, OpsGroup, Element)

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.

AUFTRAG:onafterExecuting(From, Event, To)

On after "Execute" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterFailed(From, Event, To)

On after "Failed" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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

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.

AUFTRAG:onafterPlanned(From, Event, To)

On after "Planned" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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

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

AUFTRAG:onafterRepeat(From, Event, To)

On after "Repeat" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterRequested(From, Event, To)

On after "Requested" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterScheduled(From, Event, To)

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.

AUFTRAG:onafterStarted(From, Event, To)

On after "Start" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterStatus(From, Event, To)

On after "Status" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onafterStop(From, Event, To)

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.

AUFTRAG:onafterSuccess(From, Event, To)

On after "Success" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

AUFTRAG:onbeforeRepeat(From, Event, To)

On before "Repeat" event.

Defined in:

AUFTRAG

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#AUFTRAG.Category AUFTRAG.Category

#string AUFTRAG.ClassName

Name of the class.

#table AUFTRAG.DCStask

DCS task structure.

#AUFTRAG.GroupStatus AUFTRAG.GroupStatus

#number AUFTRAG.Nassets

Number of requested warehouse assets.

#table AUFTRAG.NassetsLegMax

Number of required warehouse assets for each assigned legion.

#table AUFTRAG.NassetsLegMin

Number of required warehouse assets for each assigned legion.

#number AUFTRAG.NassetsMax

Max. number of required warehouse assets.

#number AUFTRAG.NassetsMin

Min. number of required warehouse assets.

#number AUFTRAG.Nassigned

Number of assigned groups.

#number AUFTRAG.NcarriersMax

Max number of required carrier assets.

#number AUFTRAG.NcarriersMin

Min number of required carrier assets.

#number AUFTRAG.Ncasualties

Number of own casualties during mission.

#number AUFTRAG.Ndead

Number of assigned groups that are dead.

#number AUFTRAG.Nelements

Number of elements (units) assigned to mission.

#number AUFTRAG.NescortMax

Max. number of required escort assets for each group the mission is assigned to.

#number AUFTRAG.NescortMin

Min. number of required escort assets for each group the mission is assigned to.

#number AUFTRAG.Ngroups

#number AUFTRAG.Nkills

Number of (enemy) units killed by assets of this mission.

#number AUFTRAG.Nrepeat

Number of times the mission is repeated.

#number AUFTRAG.NrepeatFailure

Number of times mission is repeated if failed.

#number AUFTRAG.NrepeatSuccess

Number of times mission is repeated if successful.

#AUFTRAG.SpecialTask AUFTRAG.SpecialTask

#AUFTRAG.TargetType AUFTRAG.TargetType

#number AUFTRAG.Texecuting

Time stamp (abs) when mission is executing. Is #nil on start.

#number AUFTRAG.Tover

Mission abs. time stamp, when mission was over.

#number AUFTRAG.Tpush

Mission push/execute time in abs. seconds.

AUFTRAG.TrackAltitude

AUFTRAG.TrackFormation

AUFTRAG.TrackPoint1

AUFTRAG.TrackPoint2

AUFTRAG.TrackSpeed

#number AUFTRAG.Tstart

Mission start time in abs. seconds.

#number AUFTRAG.Tstarted

Time stamp (abs) when mission is started.

#number AUFTRAG.Tstop

Mission stop time in abs. seconds.

#AUFTRAG.Type AUFTRAG.Type

#string AUFTRAG.alert5MissionType

Alert 5 mission type. This is the mission type, the alerted assets will be able to carry out.

#number AUFTRAG.artyAltitude

Altitude in meters. Can be used for a Barrage.

#number AUFTRAG.artyAngle

Shooting angle in degrees (for Barrage).

#number AUFTRAG.artyHeading

Heading in degrees (for Barrage).

#number AUFTRAG.artyRadius

Radius in meters.

#number AUFTRAG.artyShots

Number of shots fired.

AUFTRAG.assetStayAlive

#table AUFTRAG.assets

Warehouse assets assigned for this mission.

#table AUFTRAG.attributes

Generalized attribute(s) of assets.

#number AUFTRAG.auftragsnummer

Auftragsnummer.

#table AUFTRAG.carrierAttributes

Generalized attribute(s) of transport assets.

AUFTRAG.carrierCategories

#table AUFTRAG.carrierProperties

DCS attribute(s) of transport assets.

#table AUFTRAG.categories

Mission categories.

Ops.Chief#CHIEF AUFTRAG.chief

The CHIEF managing this mission.

Ops.Commander#COMMANDER AUFTRAG.commander

The COMMANDER managing this mission.

#table AUFTRAG.conditionFailure

If all conditions are true, the mission is cancelled.

#boolean AUFTRAG.conditionFailureSet

#table AUFTRAG.conditionPush

If all conditions are true, the mission is executed. Before, the group(s) wait at the mission execution waypoint.

#table AUFTRAG.conditionStart

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

#table AUFTRAG.conditionSuccess

If all conditions are true, the mission is cancelled.

#boolean AUFTRAG.conditionSuccessSet

#number AUFTRAG.dTevaluate

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

#number AUFTRAG.duration

Mission duration in seconds.

#number AUFTRAG.durationExe

Mission execution time in seconds.

#number AUFTRAG.engageAltitude

Engagement altitude in meters.

#boolean AUFTRAG.engageAsGroup

Group attack.

#number AUFTRAG.engageDirection

Engagement direction in degrees.

#number AUFTRAG.engageMaxDistance

Max engage distance.

#number AUFTRAG.engageQuantity

Number of times a target is engaged.

AUFTRAG.engageRange

Ops.Target#TARGET AUFTRAG.engageTarget

Target data to engage.

#table AUFTRAG.engageTargetTypes

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

#number AUFTRAG.engageWeaponExpend

How many weapons are used.

#number AUFTRAG.engageWeaponType

Weapon type used.

Core.Zone#ZONE_RADIUS AUFTRAG.engageZone

Circular engagement zone.

AUFTRAG.engagedetectedEngageZones

AUFTRAG.engagedetectedNoEngageZones

#boolean AUFTRAG.engagedetectedOn

Set parameters.

AUFTRAG.engagedetectedRmax

AUFTRAG.engagedetectedTypes

#table AUFTRAG.enrouteTasks

Mission enroute tasks.

#table AUFTRAG.escortCohorts

Cohorts explicitly requested for providing escorting assets.

#number AUFTRAG.escortEngageRange

Engage range in nautical miles (NM).

Wrapper.Group#GROUP AUFTRAG.escortGroup

The group to be escorted.

#string AUFTRAG.escortGroupName

Name of the escorted group.

#table AUFTRAG.escortLegions

Legions explicitly requested for providing escorting assets.

#string AUFTRAG.escortMissionType

Escort mission type.

#table AUFTRAG.escortTargetTypes

Target types that will be engaged.

DCS#Vec3 AUFTRAG.escortVec3

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

#boolean AUFTRAG.facDatalink

FAC datalink enabled.

#number AUFTRAG.facDesignation

FAC designation type.

#number AUFTRAG.facFreq

FAC radio frequency in MHz.

#number AUFTRAG.facModu

FAC radio modulation 0=AM 1=FM.

#boolean AUFTRAG.failurecondition

#table AUFTRAG.groupdata

Group specific data.

AUFTRAG.hoverAltitude

AUFTRAG.hoverTime

Ops.OpsGroup#OPSGROUP.Beacon AUFTRAG.icls

ICLS setting.

#number AUFTRAG.importance

Importance.

#boolean AUFTRAG.legionReturn

If true, assets return to their legion (default). If false, they will stay alive.

#table AUFTRAG.legions

Assigned legions.

#string AUFTRAG.lid

Class id string for output to DCS log file.

Wrapper.Marker#MARKER AUFTRAG.marker

F10 map marker.

#number AUFTRAG.markerCoaliton

Coalition to which the marker is dispayed.

#boolean AUFTRAG.markerOn

If true, display marker on F10 map with the AUFTRAG status.

#number AUFTRAG.missionAltitude

Mission altitude in meters.

Core.Point#COORDINATE AUFTRAG.missionEgressCoord

Mission egress waypoint coordinate.

#number AUFTRAG.missionFraction

Mission coordiante fraction. Default is 0.5.

#number AUFTRAG.missionRange

Mission range in meters. Used by LEGION classes (AIRWING, BRIGADE, ...).

#number AUFTRAG.missionSpeed

Mission speed in km/h.

#string AUFTRAG.missionTask

Mission task. See ENUMS.MissionTask.

Core.Point#COORDINATE AUFTRAG.missionWaypointCoord

Mission waypoint coordinate.

#number AUFTRAG.missionWaypointRadius

Random radius in meters.

#string AUFTRAG.name

Mission name.

Ops.Operation#OPERATION AUFTRAG.operation

Operation this mission is part of.

Ops.OpsTransport#OPSTRANSPORT AUFTRAG.opstransport

OPS transport assignment.

#number AUFTRAG.optionAlarm

Alarm state.

#number AUFTRAG.optionCM

Counter measures.

#number AUFTRAG.optionECM

ECM.

#boolean AUFTRAG.optionEPLRS

EPLRS datalink.

#boolean AUFTRAG.optionEmission

Emission is on or off.

#number AUFTRAG.optionFormation

Formation.

#boolean AUFTRAG.optionImmortal

Immortal is on/off.

#boolean AUFTRAG.optionInvisible

Invisible is on/off.

#number AUFTRAG.optionROE

ROE.

#number AUFTRAG.optionROT

ROT.

#number AUFTRAG.optionRTBammo

RTB on out-of-ammo.

#number AUFTRAG.optionRTBfuel

RTB on out-of-fuel.

#number AUFTRAG.orbitAltitude

Orbit altitude in meters.

#number AUFTRAG.orbitDeltaR

Distance threshold in meters for moving orbit targets.

#number AUFTRAG.orbitHeading

Orbit heading in degrees.

#number AUFTRAG.orbitLeg

Length of orbit leg in meters.

DCS#Vec2 AUFTRAG.orbitOffsetVec2

2D offset vector.

#number AUFTRAG.orbitSpeed

Orbit speed in m/s.

DCS#Vec2 AUFTRAG.orbitVec2

2D orbit vector.

Ops.Airwing#AIRWING.PatrolData AUFTRAG.patroldata

Patrol data.

#table AUFTRAG.payloads

User specified airwing payloads for this mission. Only these will be considered for the job!

#number AUFTRAG.prio

Mission priority.

#boolean AUFTRAG.prohibitAB

#boolean AUFTRAG.prohibitABExecute

#table AUFTRAG.properties

DCS attribute(s) of assets.

Ops.OpsGroup#OPSGROUP.Radio AUFTRAG.radio

Radio freq and modulation.

#number AUFTRAG.refuelSystem

Refuel type (boom or probe) for TANKER missions.

AUFTRAG.reinforce

#number AUFTRAG.repeated

Number of times mission was repeated.

#number AUFTRAG.repeatedFailure

Number of times mission was repeated after a failure.

#number AUFTRAG.repeatedSuccess

Number of times mission was repeated after a success.

#table AUFTRAG.requestID

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

#table AUFTRAG.specialCohorts

User specified cohorts assigned for this mission. Only these will be considered for the job!

#table AUFTRAG.specialLegions

User specified legions assigned for this mission. Only these will be considered for the job!

#string AUFTRAG.status

Mission status.

#string AUFTRAG.statusChief

Mission status of the CHIEF.

#string AUFTRAG.statusCommander

Mission status of the COMMANDER.

#table AUFTRAG.statusLegion

Mission status of all assigned LEGIONs.

#boolean AUFTRAG.successcondition

Ops.OpsGroup#OPSGROUP.Beacon AUFTRAG.tacan

TACAN setting.

#number AUFTRAG.targetHeading

Heading of target in degrees.

#boolean AUFTRAG.teleport

Groups are teleported to the mission ingress waypoint.

#table AUFTRAG.transportCohorts

Cohorts explicitly requested for providing transport carrier assets.

Core.Zone#ZONE AUFTRAG.transportDeployZone

Deploy zone of an OPSTRANSPORT.

Core.Zone#ZONE AUFTRAG.transportDisembarkZone

Disembark zone of an OPSTRANSPORT.

Core.Point#COORDINATE AUFTRAG.transportDropoff

Coordinate where to drop off the cargo.

Core.Set#SET_GROUP AUFTRAG.transportGroupSet

Groups to be transported.

#table AUFTRAG.transportLegions

Legions explicitly requested for providing transport carrier assets.

Core.Point#COORDINATE AUFTRAG.transportPickup

Coordinate where to pickup the cargo.

#number AUFTRAG.transportPickupRadius

Radius in meters for pickup zone. Default 500 m.

#string AUFTRAG.type

Mission type.

#boolean AUFTRAG.updateDCSTask

If true, DCS task is updated at every status update of the assigned groups.

#boolean AUFTRAG.urgent

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

#number AUFTRAG.verbose

Verbosity level.

#string AUFTRAG.version

AUFTRAG class version.

Function(s)

AUFTRAG:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

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

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:

Core.Fsm#FSM_PROCESS:

The SubFSM.

AUFTRAG:AddScore(State, ScoreText, Score)

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

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

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

AUFTRAG:AddTransition(From, Event, To)

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.

AUFTRAG:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

AUFTRAG:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

AUFTRAG:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

AUFTRAG:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

AUFTRAG:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

AUFTRAG:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

AUFTRAG:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

AUFTRAG:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

AUFTRAG:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

AUFTRAG:Is(State)

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

AUFTRAG:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

AUFTRAG:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

AUFTRAG:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

AUFTRAG:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

AUFTRAG:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

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

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.

AUFTRAG:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

AUFTRAG:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

AUFTRAG:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

AUFTRAG:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

AUFTRAG:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

AUFTRAG:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

AUFTRAG:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

AUFTRAG:can(e)

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.

AUFTRAG:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

AUFTRAG:is(State, state)

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#AUFTRAG.Category AUFTRAG.Category

#string AUFTRAG.ClassName

Name of the class.

#table AUFTRAG.DCStask

DCS task structure.

#AUFTRAG.GroupStatus AUFTRAG.GroupStatus

#number AUFTRAG.Nassets

Number of requested warehouse assets.

#table AUFTRAG.NassetsLegMax

Number of required warehouse assets for each assigned legion.

#table AUFTRAG.NassetsLegMin

Number of required warehouse assets for each assigned legion.

#number AUFTRAG.NassetsMax

Max. number of required warehouse assets.

#number AUFTRAG.NassetsMin

Min. number of required warehouse assets.

#number AUFTRAG.Nassigned

Number of assigned groups.

#number AUFTRAG.NcarriersMax

Max number of required carrier assets.

#number AUFTRAG.NcarriersMin

Min number of required carrier assets.

#number AUFTRAG.Ncasualties

Number of own casualties during mission.

#number AUFTRAG.Ndead

Number of assigned groups that are dead.

#number AUFTRAG.Nelements

Number of elements (units) assigned to mission.

#number AUFTRAG.NescortMax

Max. number of required escort assets for each group the mission is assigned to.

#number AUFTRAG.NescortMin

Min. number of required escort assets for each group the mission is assigned to.

#number AUFTRAG.Ngroups

#number AUFTRAG.Nkills

Number of (enemy) units killed by assets of this mission.

#number AUFTRAG.Nrepeat

Number of times the mission is repeated.

#number AUFTRAG.NrepeatFailure

Number of times mission is repeated if failed.

#number AUFTRAG.NrepeatSuccess

Number of times mission is repeated if successful.

#AUFTRAG.SpecialTask AUFTRAG.SpecialTask

#AUFTRAG.TargetType AUFTRAG.TargetType

#number AUFTRAG.Texecuting

Time stamp (abs) when mission is executing. Is #nil on start.

#number AUFTRAG.Tover

Mission abs. time stamp, when mission was over.

#number AUFTRAG.Tpush

Mission push/execute time in abs. seconds.

AUFTRAG.TrackAltitude

AUFTRAG.TrackFormation

AUFTRAG.TrackPoint1

AUFTRAG.TrackPoint2

AUFTRAG.TrackSpeed

#number AUFTRAG.Tstart

Mission start time in abs. seconds.

#number AUFTRAG.Tstarted

Time stamp (abs) when mission is started.

#number AUFTRAG.Tstop

Mission stop time in abs. seconds.

#AUFTRAG.Type AUFTRAG.Type

#string AUFTRAG.alert5MissionType

Alert 5 mission type. This is the mission type, the alerted assets will be able to carry out.

#number AUFTRAG.artyAltitude

Altitude in meters. Can be used for a Barrage.

#number AUFTRAG.artyAngle

Shooting angle in degrees (for Barrage).

#number AUFTRAG.artyHeading

Heading in degrees (for Barrage).

#number AUFTRAG.artyRadius

Radius in meters.

#number AUFTRAG.artyShots

Number of shots fired.

AUFTRAG.assetStayAlive

#table AUFTRAG.assets

Warehouse assets assigned for this mission.

#table AUFTRAG.attributes

Generalized attribute(s) of assets.

#number AUFTRAG.auftragsnummer

Auftragsnummer.

#table AUFTRAG.carrierAttributes

Generalized attribute(s) of transport assets.

AUFTRAG.carrierCategories

#table AUFTRAG.carrierProperties

DCS attribute(s) of transport assets.

#table AUFTRAG.categories

Mission categories.

Ops.Chief#CHIEF AUFTRAG.chief

The CHIEF managing this mission.

Ops.Commander#COMMANDER AUFTRAG.commander

The COMMANDER managing this mission.

#table AUFTRAG.conditionFailure

If all conditions are true, the mission is cancelled.

#boolean AUFTRAG.conditionFailureSet

#table AUFTRAG.conditionPush

If all conditions are true, the mission is executed. Before, the group(s) wait at the mission execution waypoint.

#table AUFTRAG.conditionStart

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

#table AUFTRAG.conditionSuccess

If all conditions are true, the mission is cancelled.

#boolean AUFTRAG.conditionSuccessSet

#number AUFTRAG.dTevaluate

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

#number AUFTRAG.duration

Mission duration in seconds.

#number AUFTRAG.durationExe

Mission execution time in seconds.

#number AUFTRAG.engageAltitude

Engagement altitude in meters.

#boolean AUFTRAG.engageAsGroup

Group attack.

#number AUFTRAG.engageDirection

Engagement direction in degrees.

#number AUFTRAG.engageMaxDistance

Max engage distance.

#number AUFTRAG.engageQuantity

Number of times a target is engaged.

AUFTRAG.engageRange

Ops.Target#TARGET AUFTRAG.engageTarget

Target data to engage.

#table AUFTRAG.engageTargetTypes

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

#number AUFTRAG.engageWeaponExpend

How many weapons are used.

#number AUFTRAG.engageWeaponType

Weapon type used.

Core.Zone#ZONE_RADIUS AUFTRAG.engageZone

Circular engagement zone.

AUFTRAG.engagedetectedEngageZones

AUFTRAG.engagedetectedNoEngageZones

#boolean AUFTRAG.engagedetectedOn

Set parameters.

AUFTRAG.engagedetectedRmax

AUFTRAG.engagedetectedTypes

#table AUFTRAG.enrouteTasks

Mission enroute tasks.

#table AUFTRAG.escortCohorts

Cohorts explicitly requested for providing escorting assets.

#number AUFTRAG.escortEngageRange

Engage range in nautical miles (NM).

Wrapper.Group#GROUP AUFTRAG.escortGroup

The group to be escorted.

#string AUFTRAG.escortGroupName

Name of the escorted group.

#table AUFTRAG.escortLegions

Legions explicitly requested for providing escorting assets.

#string AUFTRAG.escortMissionType

Escort mission type.

#table AUFTRAG.escortTargetTypes

Target types that will be engaged.

DCS#Vec3 AUFTRAG.escortVec3

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

#boolean AUFTRAG.facDatalink

FAC datalink enabled.

#number AUFTRAG.facDesignation

FAC designation type.

#number AUFTRAG.facFreq

FAC radio frequency in MHz.

#number AUFTRAG.facModu

FAC radio modulation 0=AM 1=FM.

#boolean AUFTRAG.failurecondition

#table AUFTRAG.groupdata

Group specific data.

AUFTRAG.hoverAltitude

AUFTRAG.hoverTime

Ops.OpsGroup#OPSGROUP.Beacon AUFTRAG.icls

ICLS setting.

#number AUFTRAG.importance

Importance.

#boolean AUFTRAG.legionReturn

If true, assets return to their legion (default). If false, they will stay alive.

#table AUFTRAG.legions

Assigned legions.

#string AUFTRAG.lid

Class id string for output to DCS log file.

Wrapper.Marker#MARKER AUFTRAG.marker

F10 map marker.

#number AUFTRAG.markerCoaliton

Coalition to which the marker is dispayed.

#boolean AUFTRAG.markerOn

If true, display marker on F10 map with the AUFTRAG status.

#number AUFTRAG.missionAltitude

Mission altitude in meters.

Core.Point#COORDINATE AUFTRAG.missionEgressCoord

Mission egress waypoint coordinate.

#number AUFTRAG.missionFraction

Mission coordiante fraction. Default is 0.5.

#number AUFTRAG.missionRange

Mission range in meters. Used by LEGION classes (AIRWING, BRIGADE, ...).

#number AUFTRAG.missionSpeed

Mission speed in km/h.

#string AUFTRAG.missionTask

Mission task. See ENUMS.MissionTask.

Core.Point#COORDINATE AUFTRAG.missionWaypointCoord

Mission waypoint coordinate.

#number AUFTRAG.missionWaypointRadius

Random radius in meters.

#string AUFTRAG.name

Mission name.

Ops.Operation#OPERATION AUFTRAG.operation

Operation this mission is part of.

Ops.OpsTransport#OPSTRANSPORT AUFTRAG.opstransport

OPS transport assignment.

#number AUFTRAG.optionAlarm

Alarm state.

#number AUFTRAG.optionCM

Counter measures.

#number AUFTRAG.optionECM

ECM.

#boolean AUFTRAG.optionEPLRS

EPLRS datalink.

#boolean AUFTRAG.optionEmission

Emission is on or off.

#number AUFTRAG.optionFormation

Formation.

#boolean AUFTRAG.optionImmortal

Immortal is on/off.

#boolean AUFTRAG.optionInvisible

Invisible is on/off.

#number AUFTRAG.optionROE

ROE.

#number AUFTRAG.optionROT

ROT.

#number AUFTRAG.optionRTBammo

RTB on out-of-ammo.

#number AUFTRAG.optionRTBfuel

RTB on out-of-fuel.

#number AUFTRAG.orbitAltitude

Orbit altitude in meters.

#number AUFTRAG.orbitDeltaR

Distance threshold in meters for moving orbit targets.

#number AUFTRAG.orbitHeading

Orbit heading in degrees.

#number AUFTRAG.orbitLeg

Length of orbit leg in meters.

DCS#Vec2 AUFTRAG.orbitOffsetVec2

2D offset vector.

#number AUFTRAG.orbitSpeed

Orbit speed in m/s.

DCS#Vec2 AUFTRAG.orbitVec2

2D orbit vector.

Ops.Airwing#AIRWING.PatrolData AUFTRAG.patroldata

Patrol data.

#table AUFTRAG.payloads

User specified airwing payloads for this mission. Only these will be considered for the job!

#number AUFTRAG.prio

Mission priority.

#boolean AUFTRAG.prohibitAB

#boolean AUFTRAG.prohibitABExecute

#table AUFTRAG.properties

DCS attribute(s) of assets.

Ops.OpsGroup#OPSGROUP.Radio AUFTRAG.radio

Radio freq and modulation.

#number AUFTRAG.refuelSystem

Refuel type (boom or probe) for TANKER missions.

AUFTRAG.reinforce

#number AUFTRAG.repeated

Number of times mission was repeated.

#number AUFTRAG.repeatedFailure

Number of times mission was repeated after a failure.

#number AUFTRAG.repeatedSuccess

Number of times mission was repeated after a success.

#table AUFTRAG.requestID

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

#table AUFTRAG.specialCohorts

User specified cohorts assigned for this mission. Only these will be considered for the job!

#table AUFTRAG.specialLegions

User specified legions assigned for this mission. Only these will be considered for the job!

#string AUFTRAG.status

Mission status.

#string AUFTRAG.statusChief

Mission status of the CHIEF.

#string AUFTRAG.statusCommander

Mission status of the COMMANDER.

#table AUFTRAG.statusLegion

Mission status of all assigned LEGIONs.

#boolean AUFTRAG.successcondition

Ops.OpsGroup#OPSGROUP.Beacon AUFTRAG.tacan

TACAN setting.

#number AUFTRAG.targetHeading

Heading of target in degrees.

#boolean AUFTRAG.teleport

Groups are teleported to the mission ingress waypoint.

#table AUFTRAG.transportCohorts

Cohorts explicitly requested for providing transport carrier assets.

Core.Zone#ZONE AUFTRAG.transportDeployZone

Deploy zone of an OPSTRANSPORT.

Core.Zone#ZONE AUFTRAG.transportDisembarkZone

Disembark zone of an OPSTRANSPORT.

Core.Point#COORDINATE AUFTRAG.transportDropoff

Coordinate where to drop off the cargo.

Core.Set#SET_GROUP AUFTRAG.transportGroupSet

Groups to be transported.

#table AUFTRAG.transportLegions

Legions explicitly requested for providing transport carrier assets.

Core.Point#COORDINATE AUFTRAG.transportPickup

Coordinate where to pickup the cargo.

#number AUFTRAG.transportPickupRadius

Radius in meters for pickup zone. Default 500 m.

#string AUFTRAG.type

Mission type.

#boolean AUFTRAG.updateDCSTask

If true, DCS task is updated at every status update of the assigned groups.

#boolean AUFTRAG.urgent

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

#number AUFTRAG.verbose

Verbosity level.

#string AUFTRAG.version

AUFTRAG class version.

Function(s)

AUFTRAG:ClearState(Object, StateName)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

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

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

AUFTRAG:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

AUFTRAG:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

AUFTRAG:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

AUFTRAG:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

AUFTRAG:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

AUFTRAG:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

AUFTRAG:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

AUFTRAG:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

AUFTRAG:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

AUFTRAG:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

AUFTRAG:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

AUFTRAG:GetEventPriority()

Get the Class Core.Event processing Priority.

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

Defined in:

Return value:

#number:

The Core.Event processing Priority.

AUFTRAG:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

AUFTRAG:GetState(Object, Key)

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

AUFTRAG:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

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

Return value:

AUFTRAG:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:Inherit(Child, Parent)

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

AUFTRAG:IsInstanceOf(ClassName)

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

Examples:

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

AUFTRAG:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

AUFTRAG:New()

BASE constructor.

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

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

Defined in:

Return value:

AUFTRAG:OnEvent(EventData)

Occurs when an Event for an object is triggered.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventBDA(EventData)

BDA.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventBaseCaptured(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventCrash(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventDead(EventData)

Occurs when an object is dead.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventDetailedFailure(EventData)

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

Will update this page when new information become available.

initiator: The unit that had the failure.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventEjection(EventData)

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

initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventKill(EventData)

Occurs on the death of a unit.

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventLand(EventData)

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

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventLandingAfterEjection(EventData)

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

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventLandingQualityMark(EventData)

Landing quality mark.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventMissionEnd(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventMissionStart(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventParatrooperLanding(EventData)

Weapon add.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventPlayerEnterAircraft(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventPlayerLeaveUnit(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventRefueling(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventScore(EventData)

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

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventShootingStart(EventData)

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventTakeoff(EventData)

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

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventTriggerZone(EventData)

Trigger zone.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

AUFTRAG:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

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

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#string:

The Schedule ID of the planned schedule.

AUFTRAG:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

AUFTRAG:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

AUFTRAG:SetState(Object, Key, Value)

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

AUFTRAG:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

AUFTRAG:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

AUFTRAG:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

AUFTRAG:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

AUFTRAG:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

AUFTRAG:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

AUFTRAG:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

AUFTRAG:TraceOnOff(TraceOnOff)

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


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

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

AUFTRAG:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

AUFTRAG:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AUFTRAG:_Serialize(Arguments)

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

AUFTRAG:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

AUFTRAG:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: