Banner Image

Module Ops.FlightGroup

Ops - Enhanced Airborne Group.

Main Features:

  • Monitor flight status of elements and/or the entire group
  • Monitor fuel and ammo status
  • Conveniently set radio freqencies, TACAN, ROE etc
  • Order helos to land at specifc coordinates
  • Dynamically add and remove waypoints
  • Sophisticated task queueing system (know when DCS tasks start and end)
  • Convenient checks when the group enters or leaves a zone
  • Detection events for new, known and lost units
  • Simple LASER and IR-pointer setup
  • Compatible with AUFTRAG class
  • Many additional events that the mission designer can hook into

Example Missions:

Demo missions can be found on GitHub.


Author: funkyfranky


Global(s)

Global FLIGHTGROUP

To invent an airplane is nothing; to build one is something; to fly is everything. -- Otto Lilienthal


The FLIGHTGROUP Concept

Events

This class introduces a lot of additional events that will be handy in many situations.

#FLIGHTGROUP FLIGHTGROUP

To invent an airplane is nothing; to build one is something; to fly is everything. -- Otto Lilienthal


The FLIGHTGROUP Concept

Events

This class introduces a lot of additional events that will be handy in many situations.

Certain events like landing, takeoff etc. are triggered for each element and also have a corresponding event when the whole group reaches this state.

Spawning

Parking

Taxiing

Takeoff

Airborne

Landed

Arrived

Dead

Fuel

Ammo

Detected Units

Check In Zone

Passing Waypoint

Tasking

The FLIGHTGROUP class significantly simplifies the monitoring of DCS tasks. Two types of tasks can be set

* **Scheduled Tasks**
* **Waypoint Tasks**

Scheduled Tasks

Waypoint Tasks

Examples

Here are some examples to show how things are done.

1. Spawn

Type(s)

Fields and Methods inherited from FLIGHTGROUP Description

FLIGHTGROUP:AddTaskEnrouteEngageTargetsInZone(ZoneRadius, TargetTypes, Priority)

Add an enroute task to attack targets in a certain circular zone.

FLIGHTGROUP:AddWaypoint(Coordinate, Speed, AfterWaypointWithID, Altitude, Updateroute)

Add an AIR waypoint to the flight plan.

FLIGHTGROUP:AddWaypointLanding(Airbase, Speed, AfterWaypointWithID, Altitude, Updateroute)

Add an LANDING waypoint to the flight plan.

FLIGHTGROUP.Attribute

FLIGHTGROUP:CanAirToAir(ExcludeGuns)

Check if flight can do air-to-air attacks.

FLIGHTGROUP:CanAirToGround(ExcludeGuns)

Check if flight can do air-to-ground tasks.

FLIGHTGROUP:ClearToLand(Delay)

Clear the group for landing when it is holding.

FLIGHTGROUP:FindNearestAirbase(Radius)

Find the nearest friendly airbase (same or neutral coalition).

FLIGHTGROUP:FindNearestTanker(Radius)

Find the nearest tanker.

FLIGHTGROUP:GetAirwing()

Get airwing the flight group belongs to.

FLIGHTGROUP:GetAirwingName()

Get name of airwing the flight group belongs to.

FLIGHTGROUP:GetClosestAirbase()

Search unoccupied parking spots at the airbase for all flight elements.

FLIGHTGROUP:GetDestinationFromWaypoints()

Check if a unit is and element of the flightgroup.

FLIGHTGROUP:GetFlightControl()

Get the FLIGHTCONTROL controlling this flight group.

FLIGHTGROUP:GetFuelMin()

Get min fuel of group.

FLIGHTGROUP:GetHoldingTime()

Get holding time.

FLIGHTGROUP:GetHomebaseFromWaypoints()

Check if a unit is and element of the flightgroup.

FLIGHTGROUP:GetKills()

Get number of kills of this group.

FLIGHTGROUP:GetParking(airbase)

Search unoccupied parking spots at the airbase for all flight elements.

FLIGHTGROUP:GetParkingSpot(element, maxdist, airbase)

Returns the parking spot of the element.

FLIGHTGROUP:GetParkingTime()

Get parking time.

FLIGHTGROUP:GetPlayerElement()

Get player element.

FLIGHTGROUP:GetPlayerName()

Get player element.

FLIGHTGROUP:GetSquadron()

Get squadron the flight group belongs to.

FLIGHTGROUP:GetSquadronName()

Get squadron name the flight group belongs to.

FLIGHTGROUP:InitWaypoints()

Initialize Mission Editor waypoints.

FLIGHTGROUP:IsAirborne(Element)

Check if flight is airborne or cruising.

FLIGHTGROUP:IsArrived(Element)

Check if flight has arrived at its destination parking spot.

FLIGHTGROUP:IsCruising()

Check if flight is airborne or cruising.

FLIGHTGROUP:IsFuelCritical()

Check if flight is critical on fuel.

FLIGHTGROUP:IsFuelGood()

Check if flight is good on fuel (not below low or even critical state).

FLIGHTGROUP:IsFuelLow()

Check if flight is low on fuel.

FLIGHTGROUP:IsGoing4Fuel()

Check if flight is going for fuel.

FLIGHTGROUP:IsHolding()

Check if flight is holding and waiting for landing clearance.

FLIGHTGROUP:IsInbound()

Check if flight is inbound and traveling to holding pattern.

FLIGHTGROUP:IsLanded(Element)

Check if flight has landed and is now taxiing to its parking spot.

FLIGHTGROUP:IsLandedAt()

Check if helo(!) flight has landed at a specific point.

FLIGHTGROUP:IsLanding(Element)

Check if flight is landing.

FLIGHTGROUP:IsLandingAir(wp)

Check if the final waypoint is in the air.

FLIGHTGROUP:IsLandingAirbase(wp)

Check if the final waypoint is at an airbase.

FLIGHTGROUP:IsLandingAt()

Check if helo(!) flight is ordered to land at a specific point.

FLIGHTGROUP:IsParking(Element)

Check if flight is parking.

FLIGHTGROUP:IsTakeoffAir()

Check if this is an air start.

FLIGHTGROUP:IsTakeoffCold()

Check if this is a cold start.

FLIGHTGROUP:IsTakeoffHot()

Check if this is a hot start.

FLIGHTGROUP:IsTakeoffRunway()

Check if this is a runway start.

FLIGHTGROUP:IsTaxiing(Element)

Check if is taxiing to the runway.

FLIGHTGROUP:New(group)

Create a new FLIGHTGROUP object and start the FSM.

FLIGHTGROUP:OnAfterAirborne(From, Event, To)

FSM Function OnAfterAirborne.

FLIGHTGROUP:OnAfterArrived(From, Event, To)

FSM Function OnAfterArrived.

FLIGHTGROUP:OnAfterCruise(From, Event, To)

FSM Function OnAfterCruise.

FLIGHTGROUP:OnAfterDead(From, Event, To)

FSM Function OnAfterDead.

FLIGHTGROUP:OnAfterDisengage(From, Event, To, TargetUnitSet)

FSM Function OnAfterDisengage.

FLIGHTGROUP:OnAfterElementAirborne(From, Event, To, Element)

FSM Function OnAfterElementAirborne.

FLIGHTGROUP:OnAfterElementArrived(From, Event, To, Element, airbase, Parking)

FSM Function OnAfterElementArrived.

FLIGHTGROUP:OnAfterElementDead(From, Event, To, Element)

FSM Function OnAfterElementDead.

FLIGHTGROUP:OnAfterElementDestroyed(From, Event, To, Element)

FSM Function OnAfterElementDestroyed.

FLIGHTGROUP:OnAfterElementEngineOn(From, Event, To, Element)

FSM Function OnAfterElementEngineOn.

FLIGHTGROUP:OnAfterElementLanded(From, Event, To, Element, airbase)

FSM Function OnAfterElementLanded.

FLIGHTGROUP:OnAfterElementParking(From, Event, To, Element, Spot)

FSM Function OnAfterElementParking.

FLIGHTGROUP:OnAfterElementSpawned(From, Event, To, Element)

FSM Function OnAfterElementSpawned.

FLIGHTGROUP:OnAfterElementTakeoff(From, Event, To, Element, airbase)

FSM Function OnAfterElementTakeoff.

FLIGHTGROUP:OnAfterElementTaxiing(From, Event, To, Element)

FSM Function OnAfterElementTaxiing.

FLIGHTGROUP:OnAfterEngageTarget(From, Event, To, Target)

FSM Function OnAfterEngageTarget.

FLIGHTGROUP:OnAfterFuelCritical(From, Event, To)

FSM Function OnAfterFuelCritical.

FLIGHTGROUP:OnAfterFuelLow(From, Event, To)

FSM Function OnAfterFuelLow.

FLIGHTGROUP:OnAfterLandAt(From, Event, To, TargetUnitSet)

FSM Function OnAfterLandAt.

FLIGHTGROUP:OnAfterLandAtAirbase(From, Event, To, airbase)

FSM Function OnAfterLandAtAirbase.

FLIGHTGROUP:OnAfterLanded(From, Event, To, airbase)

FSM Function OnAfterLanded.

FLIGHTGROUP:OnAfterLandedAt(From, Event, To)

FSM Function OnAfterLandedAt.

FLIGHTGROUP:OnAfterLanding(From, Event, To)

FSM Function OnAfterLanding.

FLIGHTGROUP:OnAfterOutOfMissilesAA(From, Event, To)

FSM Function OnAfterOutOfMissilesAA.

FLIGHTGROUP:OnAfterOutOfMissilesAG(From, Event, To)

FSM Function OnAfterOutOfMissilesAG.

FLIGHTGROUP:OnAfterParking(From, Event, To)

FSM Function OnAfterParking.

FLIGHTGROUP:OnAfterRTB(From, Event, To, airbase, SpeedTo, SpeedHold, SpeedLand)

FSM Function OnAfterRTB.

FLIGHTGROUP:OnAfterRefuel(From, Event, To, Coordinate)

FSM Function OnAfterRefuel.

FLIGHTGROUP:OnAfterRefueled(From, Event, To)

FSM Function OnAfterRefueled.

FLIGHTGROUP:OnAfterSpawned(From, Event, To)

FSM Function OnAfterSpawned.

FLIGHTGROUP:OnAfterTakeoff(From, Event, To)

FSM Function OnAfterTakeoff.

FLIGHTGROUP:OnAfterTaxiing(From, Event, To)

FSM Function OnAfterTaxiing.

FLIGHTGROUP:OnAfterUpdateRoute(From, Event, To, n, N)

FSM Function OnAfterUpdateRoute.

FLIGHTGROUP:OnAfterWait(From, Event, To, Duration, Altitude, Speed)

FSM Function OnAfterWait.

FLIGHTGROUP:OnBeforeLandAt(From, Event, To, Coordinate, Duration)

FSM Function OnBeforeLandAt.

FLIGHTGROUP:OnBeforeLandAtAirbase(From, Event, To, airbase)

FSM Function OnBeforeLandAtAirbase.

FLIGHTGROUP:OnBeforeRTB(From, Event, To, airbase, SpeedTo, SpeedHold)

FSM Function OnBeforeRTB.

FLIGHTGROUP:OnBeforeUpdateRoute(From, Event, To, n, N)

FSM Function OnBeforeUpdateRoute.

FLIGHTGROUP:OnBeforeWait(From, Event, To, Duration, Altitude, Speed)

FSM Function OnBeforeWait.

FLIGHTGROUP:OnEventCrash(EventData)

Flightgroup event function handling the crash of a unit.

FLIGHTGROUP:OnEventEngineShutdown(EventData)

Flightgroup event function handling the crash of a unit.

FLIGHTGROUP:OnEventEngineStartup(EventData)

Flightgroup event function handling the crash of a unit.

FLIGHTGROUP:OnEventLanding(EventData)

Flightgroup event function handling the crash of a unit.

FLIGHTGROUP:OnEventTakeOff(EventData)

Flightgroup event function handling the crash of a unit.

FLIGHTGROUP:OnEventUnitLost(EventData)

Flightgroup event function handling the crash of a unit.

FLIGHTGROUP.PlayerSkill

FLIGHTGROUP.Players

FLIGHTGROUP players.

FLIGHTGROUP.RTBRecallCount

Number that counts RTB calls.

FLIGHTGROUP.RadioMessage

FLIGHTGROUP:SetAirboss(airboss)

Set the AIRBOSS controlling this flight group.

FLIGHTGROUP:SetAllowAfterburner()

Set if aircraft is allowed to use afterburner.

FLIGHTGROUP:SetDespawnAfterHolding()

Enable that the group is despawned after holding.

FLIGHTGROUP:SetDespawnAfterLanding()

Enable that the group is despawned after landing.

FLIGHTGROUP:SetDestinationbase(DestinationAirbase)

Set the destination airbase.

FLIGHTGROUP:SetFlightControl(flightcontrol)

Set the FLIGHTCONTROL controlling this flight group.

FLIGHTGROUP:SetFuelCriticalRTB(switch)

Set if critical fuel threshold is reached, flight goes RTB.

FLIGHTGROUP:SetFuelCriticalThreshold(threshold)

Set fuel critical threshold.

FLIGHTGROUP:SetFuelLowRTB(switch)

Set if low fuel threshold is reached, flight goes RTB.

FLIGHTGROUP:SetFuelLowRefuel(switch)

Set if low fuel threshold is reached, flight tries to refuel at the neares tanker.

FLIGHTGROUP:SetFuelLowThreshold(threshold)

Set low fuel threshold.

FLIGHTGROUP:SetHomebase(HomeAirbase)

Set the homebase.

FLIGHTGROUP:SetJettisonEmptyTanks(Switch)

Set if aircraft is allowed to drop empty fuel tanks - set to true to allow, and false to forbid it.

FLIGHTGROUP:SetJettisonWeapons(Switch)

Set if aircraft is allowed to drop weapons to escape danger - set to true to allow, and false to forbid it.

FLIGHTGROUP:SetOutOfAAMRTB(switch)

Set if flight is out of Air-Air-Missiles, flight goes RTB.

FLIGHTGROUP:SetOutOfAGMRTB(switch)

Set if flight is out of Air-Ground-Missiles, flight goes RTB.

FLIGHTGROUP:SetProhibitAfterburner()

Set if aircraft is not allowed to use afterburner.

FLIGHTGROUP:SetReadyForTakeoff(ReadyTO, Delay)

Set if group is ready for taxi/takeoff if controlled by a FLIGHTCONTROL.

FLIGHTGROUP:SetVTOL()

Set if aircraft is VTOL capable.

FLIGHTGROUP:StartUncontrolled(delay)

Start an uncontrolled group.

FLIGHTGROUP:Status()

Status update.

FLIGHTGROUP.Tholding

Abs. mission time stamp when the group reached the holding point.

FLIGHTGROUP.Tparking

Abs. mission time stamp when the group was spawned uncontrolled and is parking.

FLIGHTGROUP.Twaiting

FLIGHTGROUP:_CheckGroupDone(delay, waittime)

Check if flight is done, i.e.

FLIGHTGROUP:_CheckStuck(Despawn)

Check if group got stuck.

FLIGHTGROUP._ClearedToLand(group, flightgroup)

Function called when flight has reached the holding point.

FLIGHTGROUP:_CreateMenuAtcHelp(rootmenu)

Create player menu.

FLIGHTGROUP._FinishedRefuelling(group, flightgroup)

Function called when flight finished refuelling.

FLIGHTGROUP._FinishedWaiting(group, flightgroup)

Function called when flight finished waiting.

FLIGHTGROUP:_GetAttribute()

Get the generalized attribute of a group.

FLIGHTGROUP:_GetDistToParking(Spot, Coordinate)

Get distance to parking spot.

FLIGHTGROUP:_GetObjectSize(DCSobject)

Size of the bounding box of a DCS object derived from the DCS descriptor table.

FLIGHTGROUP:_GetOnboardNumber(unitname)

Get onboard number.

FLIGHTGROUP:_GetPlayerData()

Get player data.

FLIGHTGROUP:_GetPlayerUnitAndName(_unitName)

Returns the unit of a player and the player name.

FLIGHTGROUP:_GetTerminal(_attribute, _category)

Get the proper terminal type based on generalized attribute of the group.

FLIGHTGROUP:_InitGroup(Template)

Initialize group parameters.

FLIGHTGROUP:_InitPlayerData(PlayerName)

Init player data.

FLIGHTGROUP:_IsHuman(group)

Checks if a group has a human player.

FLIGHTGROUP:_IsHumanUnit(unit)

Checks if a human player sits in the unit.

FLIGHTGROUP:_LandAtAirbase(airbase, SpeedTo, SpeedHold, SpeedLand)

Land at an airbase.

FLIGHTGROUP:_MarkParking()

Player mark parking.

FLIGHTGROUP:_MenuNotImplemented(groupname)

Player menu not implemented.

FLIGHTGROUP._OnFinal(group, flightgroup)

Function called when flight is on final.

FLIGHTGROUP:_PlayerMyStatus()

Player status.

FLIGHTGROUP:_PlayerSkill(Skill)

Player set skill.

FLIGHTGROUP:_PlayerSubtitles()

Player set subtitles.

FLIGHTGROUP._ReachedHolding(group, flightgroup)

Function called when flight has reached the holding point.

FLIGHTGROUP:_SetElementParkingAt(Element, Spot)

Set parking spot of element.

FLIGHTGROUP:_SetElementParkingFree(Element)

Set parking spot of element to free

FLIGHTGROUP:_UpdateMenu(delay)

Update menu.

FLIGHTGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

FLIGHTGROUP.actype

Type name of the aircraft.

FLIGHTGROUP.ai

If true, flight is purely AI. If false, flight contains at least one human player.

FLIGHTGROUP.airboss

The airboss handling this group.

FLIGHTGROUP.ammo

Ammunition data. Number of Guns, Rockets, Bombs, Missiles.

FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

FLIGHTGROUP.controlstatus

Flight control status.

FLIGHTGROUP.currbase

FLIGHTGROUP.dTwait

FLIGHTGROUP.despawnAfterHolding

If true, group is despawned after reaching the holding point.

FLIGHTGROUP.despawnAfterLanding

If true, group is despawned after landed at an airbase.

FLIGHTGROUP.destbase

FLIGHTGROUP.flaghold

Flag for holding.

FLIGHTGROUP.flightcontrol

The flightcontrol handling this group.

FLIGHTGROUP.fuelcritical

Fuel critical switch.

FLIGHTGROUP.fuelcriticalrtb

RTB on critical fuel switch.

FLIGHTGROUP.fuelcriticalthresh

Critical fuel threshold in percent.

FLIGHTGROUP.fuellow

Fuel low switch.

FLIGHTGROUP.fuellowrefuel

FLIGHTGROUP.fuellowrtb

RTB on low fuel switch.

FLIGHTGROUP.fuellowthresh

Low fuel threshold in percent.

FLIGHTGROUP.groupinitialized

FLIGHTGROUP.holdtime

Time [s] flight is holding before going on final. Set to nil for indefinitely.

FLIGHTGROUP.homebase

FLIGHTGROUP.isAI

FLIGHTGROUP.isDead

FLIGHTGROUP.isDestroyed

FLIGHTGROUP.isHelo

FLIGHTGROUP.isLandingAtAirbase

FLIGHTGROUP.isLateActivated

FLIGHTGROUP.isMobile

FLIGHTGROUP.isReadyTO

Flight is ready for takeoff. This is for FLIGHTCONTROL.

FLIGHTGROUP.isUncontrolled

FLIGHTGROUP.isVTOL

FLIGHTGROUP.jettisonEmptyTanks

Allow (true) or disallow (false) AI to jettison empty fuel tanks.

FLIGHTGROUP.jettisonWeapons

Allow (true) or disallow (false) AI to jettison weapons if in danger.

FLIGHTGROUP.lid

FLIGHTGROUP.menu

F10 radio menu.

FLIGHTGROUP:onafterAirborne(From, Event, To)

On after "Airborne" event.

FLIGHTGROUP:onafterArrived(From, Event, To)

On after "Arrived" event.

FLIGHTGROUP:onafterCruise(From, Event, To)

On after "Cruising" event.

FLIGHTGROUP:onafterDead(From, Event, To)

On after "Dead" event.

FLIGHTGROUP:onafterDisengage(From, Event, To, TargetUnitSet)

On after "Disengage" event.

FLIGHTGROUP:onafterElementAirborne(From, Event, To, Element)

On after "ElementAirborne" event.

FLIGHTGROUP:onafterElementArrived(From, Event, To, Element, airbase, Parking)

On after "ElementArrived" event.

FLIGHTGROUP:onafterElementDead(From, Event, To, Element)

On after "ElementDead" event.

FLIGHTGROUP:onafterElementDestroyed(From, Event, To, Element)

On after "ElementDestroyed" event.

FLIGHTGROUP:onafterElementEngineOn(From, Event, To, Element)

On after "ElementEngineOn" event.

FLIGHTGROUP:onafterElementLanded(From, Event, To, Element, airbase)

On after "ElementLanded" event.

FLIGHTGROUP:onafterElementParking(From, Event, To, Element, Spot)

On after "ElementParking" event.

FLIGHTGROUP:onafterElementSpawned(From, Event, To, Element)

On after "ElementSpawned" event.

FLIGHTGROUP:onafterElementTakeoff(From, Event, To, Element, airbase)

On after "ElementTakeoff" event.

FLIGHTGROUP:onafterElementTaxiing(From, Event, To, Element)

On after "ElementTaxiing" event.

FLIGHTGROUP:onafterEngageTarget(From, Event, To, Target)

On after "EngageTarget" event.

FLIGHTGROUP:onafterFuelCritical(From, Event, To)

On after "FuelCritical" event.

FLIGHTGROUP:onafterFuelLow(From, Event, To)

On after "FuelLow" event.

FLIGHTGROUP:onafterHolding(From, Event, To)

On after "Holding" event.

FLIGHTGROUP:onafterLandAt(From, Event, To, Coordinate, Duration)

On after "LandAt" event.

FLIGHTGROUP:onafterLandAtAirbase(From, Event, To, airbase)

On after "LandAtAirbase" event.

FLIGHTGROUP:onafterLanded(From, Event, To, airbase)

On after "Landed" event.

FLIGHTGROUP:onafterLandedAt(From, Event, To)

On after "LandedAt" event.

FLIGHTGROUP:onafterLanding(From, Event, To)

On after "Landing" event.

FLIGHTGROUP:onafterOutOfMissilesAA(From, Event, To)

On after "OutOfMissilesAA" event.

FLIGHTGROUP:onafterOutOfMissilesAG(From, Event, To)

On after "OutOfMissilesAG" event.

FLIGHTGROUP:onafterParking(From, Event, To)

On after "Parking" event.

FLIGHTGROUP:onafterRTB(From, Event, To, airbase, SpeedTo, SpeedHold, SpeedLand)

On after "RTB" event.

FLIGHTGROUP:onafterRefuel(From, Event, To, Coordinate)

On after "Refuel" event.

FLIGHTGROUP:onafterRefueled(From, Event, To)

On after "Refueled" event.

FLIGHTGROUP:onafterSpawned(From, Event, To)

On after "Spawned" event.

FLIGHTGROUP:onafterTakeoff(From, Event, To, airbase)

On after "Takeoff" event.

FLIGHTGROUP:onafterTaxiing(From, Event, To)

On after "Taxiing" event.

FLIGHTGROUP:onafterUpdateRoute(From, Event, To, n, N)

On after "UpdateRoute" event.

FLIGHTGROUP:onafterWait(From, Event, To, Duration, Altitude, Speed)

On after "Wait" event.

FLIGHTGROUP:onbeforeLandAt(From, Event, To, Coordinate, Duration)

On before "LandAt" event.

FLIGHTGROUP:onbeforeLandAtAirbase(From, Event, To, airbase)

On before "LandAtAirbase" event.

FLIGHTGROUP:onbeforeRTB(From, Event, To, airbase, SpeedTo, SpeedHold)

On before "RTB" event.

FLIGHTGROUP:onbeforeUpdateRoute(From, Event, To, n, N)

On before "UpdateRoute" event.

FLIGHTGROUP:onbeforeWait(From, Event, To, Duration, Altitude, Speed)

On before "Wait" event.

FLIGHTGROUP.outofAAMrtb

FLIGHTGROUP.outofAGMrtb

FLIGHTGROUP.prohibitAB

Disallow (true) or allow (false) AI to use the afterburner.

FLIGHTGROUP.rangemax

Max range in meters.

FLIGHTGROUP.refueltype

The refueling system type (0=boom, 1=probe), if the group can refuel from a tanker.

FLIGHTGROUP.speedCruise

FLIGHTGROUP.speedMax

FLIGHTGROUP.speedWp

FLIGHTGROUP.stack

Holding stack.

FLIGHTGROUP.stuckTimestamp

FLIGHTGROUP.stuckVec3

FLIGHTGROUP.tacan

FLIGHTGROUP.tankertype

The refueling system type (0=boom, 1=probe), if the group is a tanker.

FLIGHTGROUP.timerCheckZone

FLIGHTGROUP.timerQueueUpdate

FLIGHTGROUP.timerStatus

FLIGHTGROUP.version

FLIGHTGROUP class version.

FLIGHTGROUP.waypoints

FLIGHTGROUP.waypoints0

Fields and Methods inherited from OPSGROUP Description

FLIGHTGROUP:Activate(delay)

Activate a late activated group.

FLIGHTGROUP:AddCheckZone(CheckZone)

Add a zone that triggers and event if the group enters or leaves any of the zones.

FLIGHTGROUP:AddMission(Mission)

Add mission to queue.

FLIGHTGROUP:AddOpsTransport(OpsTransport)

Create a cargo transport assignment.

FLIGHTGROUP:AddTask(task, clock, description, prio, duration)

Add a scheduled task.

FLIGHTGROUP:AddTaskEnroute(task)

Add an enroute task.

FLIGHTGROUP:AddTaskWaypoint(task, Waypoint, description, prio, duration)

Add a waypoint task.

FLIGHTGROUP:AddWeaponRange(RangeMin, RangeMax, BitType)

Add a weapon range for ARTY auftrag.

FLIGHTGROUP:AddWeightCargo(UnitName, Weight)

Add weight to the internal cargo of an element of the group.

FLIGHTGROUP.Astar

path finding.

FLIGHTGROUP:CanCargo(Cargo)

Check if the group can in principle be carrier of a cargo group.

FLIGHTGROUP:CancelAllMissions()

Cancel all missions in mission queue that are not already done or cancelled.

FLIGHTGROUP.CargoStatus

FLIGHTGROUP.CarrierStatus

FLIGHTGROUP:CheckTaskDescriptionUnique(description)

Check if task description is unique.

FLIGHTGROUP.ClassName

Name of the class.

FLIGHTGROUP:ClearTasks()

Clear DCS tasks.

FLIGHTGROUP:ClearWaypoints(IndexMin, IndexMax)

Clear waypoints.

FLIGHTGROUP:CountElements(States)

Count elements of the group.

FLIGHTGROUP:CountRemainingMissison()

Count remaining missons.

FLIGHTGROUP:CountRemainingTasks()

Count the number of tasks that still pending in the queue.

FLIGHTGROUP:CountRemainingTransports()

Count remaining cargo transport assignments.

FLIGHTGROUP:CountTasksWaypoint(uid, id)

Count remaining waypoint tasks.

FLIGHTGROUP:Deactivate(delay)

Deactivate the group.

FLIGHTGROUP:DelOpsTransport(CargoTransport)

Delete a cargo transport assignment from the cargo queue.

FLIGHTGROUP:Despawn(Delay, NoEventRemoveUnit)

Despawn the group.

FLIGHTGROUP:DespawnElement(Element, Delay, NoEventRemoveUnit)

Despawn an element/unit of the group.

FLIGHTGROUP:DespawnUnit(UnitName, Delay, NoEventRemoveUnit)

Despawn a unit of the group.

FLIGHTGROUP:Destroy(Delay)

Destroy group.

FLIGHTGROUP:DestroyUnit(UnitName, Delay)

Destroy a unit of the group.

FLIGHTGROUP.ElementStatus

FLIGHTGROUP:FindCarrierForCargo(Weight)

Find carrier for cargo by evaluating the free cargo bay storage.

FLIGHTGROUP:Get2DDistance(Coordinate)

Get 2D distance to a coordinate.

FLIGHTGROUP:GetAlarmstate()

Get current Alarm State of the group.

FLIGHTGROUP:GetAltitude()

Set current altitude.

FLIGHTGROUP:GetAmmo0()

Get inital amount of ammunition.

FLIGHTGROUP:GetAmmoElement(element)

Get the number of shells a unit or group currently has.

FLIGHTGROUP:GetAmmoTot()

Get total amount of ammunition of the whole group.

FLIGHTGROUP:GetAmmoUnit(unit, display)

Get the number of shells a unit or group currently has.

FLIGHTGROUP:GetAttribute()

Get generalized attribute.

FLIGHTGROUP:GetBeaconTACAN()

Get current TACAN parameters.

FLIGHTGROUP:GetCallsignName(ShortCallsign, Keepnumber, CallsignTranslations)

Get callsign of the first element alive.

FLIGHTGROUP:GetCargoGroups(CarrierName)

Get all groups currently loaded as cargo.

FLIGHTGROUP:GetCargoOpsGroups()

Get OPSGROUPs in the cargo bay.

FLIGHTGROUP:GetCoalition()

Get coalition.

FLIGHTGROUP:GetCoordinate(NewObject, UnitName)

Get current coordinate of the group.

FLIGHTGROUP:GetCoordinateInRange(TargetCoord, WeaponBitType, RefCoord)

Get a coordinate, which is in weapon range.

FLIGHTGROUP:GetCruiseAltitude()

Get default cruise speed.

FLIGHTGROUP:GetDCSGroup()

Get DCS GROUP object.

FLIGHTGROUP:GetDCSObject()

Get DCS group object.

FLIGHTGROUP:GetDCSUnit(UnitNumber)

Get DCS GROUP object.

FLIGHTGROUP:GetDCSUnits()

Get DCS units.

FLIGHTGROUP:GetDetectedGroups()

Get set of detected groups.

FLIGHTGROUP:GetDetectedUnits()

Get set of detected units.

FLIGHTGROUP:GetDistanceToWaypoint(indx)

Get distance to waypoint.

FLIGHTGROUP:GetEPLRS()

Get current EPLRS state.

FLIGHTGROUP:GetElementAlive()

Get the first element of a group, which is alive.

FLIGHTGROUP:GetElementByName(unitname)

Get the element of a group.

FLIGHTGROUP:GetElementZoneBoundingBox(UnitName)

Get the bounding box of the element.

FLIGHTGROUP:GetElementZoneLoad(UnitName)

Get the loading zone of the element.

FLIGHTGROUP:GetElementZoneUnload(UnitName)

Get the unloading zone of the element.

FLIGHTGROUP:GetEmission()

Get current emission state.

FLIGHTGROUP:GetExpectedSpeed()

Returns the currently expected speed.

FLIGHTGROUP:GetFreeCargobay(UnitName, IncludeReserved)

Get free cargo bay weight.

FLIGHTGROUP:GetFreeCargobayMax(Currently)

Get max weight of cargo (group) this group can load.

FLIGHTGROUP:GetFreeCargobayRelative(UnitName, IncludeReserved)

Get relative free cargo bay in percent.

FLIGHTGROUP:GetGroup()

Get MOOSE GROUP object.

FLIGHTGROUP:GetHeading(UnitName)

Get current heading of the group or (optionally) of a specific unit of the group.

FLIGHTGROUP:GetHighestThreat()

Get highest threat.

FLIGHTGROUP:GetLaserCode()

Get LASER code.

FLIGHTGROUP:GetLaserCoordinate()

Get current LASER coordinate, i.e.

FLIGHTGROUP:GetLaserTarget()

Get current target of the LASER.

FLIGHTGROUP:GetLifePoints(Element)

Returns the absolute total life points of the group.

FLIGHTGROUP:GetMissionByID(id)

Get mission by its id (auftragsnummer).

FLIGHTGROUP:GetMissionByTaskID(taskid)

Get mission by its task id.

FLIGHTGROUP:GetMissionCurrent()

Get current mission.

FLIGHTGROUP:GetName()

Get the group name.

FLIGHTGROUP:GetNelements(status)

Get number of elements alive.

FLIGHTGROUP:GetNextWaypointCoordinate(cyclic)

Get coordinate of next waypoint of the group.

FLIGHTGROUP:GetOpsTransportByUID(uid)

Get cargo transport assignment from the cargo queue by its unique ID.

FLIGHTGROUP:GetOrientation(UnitName)

Get current orientation of the group.

FLIGHTGROUP:GetOrientationX(UnitName)

Get current "X" orientation of the first unit in the group.

FLIGHTGROUP:GetROE()

Get current ROE of the group.

FLIGHTGROUP:GetROT()

Get current ROT of the group.

FLIGHTGROUP:GetRadio()

Get current Radio frequency and modulation.

FLIGHTGROUP:GetSpeedCruise()

Get default cruise speed.

FLIGHTGROUP:GetSpeedToWaypoint(indx)

Returns a non-zero speed to the next waypoint (even if the waypoint speed is zero).

FLIGHTGROUP:GetTACAN()

Get current TACAN parameters.

FLIGHTGROUP:GetTaskByID(id, status)

Get task by its id.

FLIGHTGROUP:GetTaskCurrent()

Get the currently executed task if there is any.

FLIGHTGROUP:GetTasksWaypoint(id)

Get the unfinished waypoint tasks

FLIGHTGROUP:GetThreat(ThreatLevelMin, ThreatLevelMax)

Get highest detected threat.

FLIGHTGROUP:GetTimeToWaypoint(indx)

Get time to waypoint based on current velocity.

FLIGHTGROUP:GetUnit(UnitNumber)

Get MOOSE UNIT object.

FLIGHTGROUP:GetUsedCargobayRelative(UnitName, IncludeReserved)

Get relative used (loaded) cargo bay in percent.

FLIGHTGROUP:GetVec2(UnitName)

Get current 2D position vector of the group.

FLIGHTGROUP:GetVec3(UnitName)

Get current 3D position vector of the group.

FLIGHTGROUP:GetVelocity(UnitName)

Get current velocity of the group.

FLIGHTGROUP:GetWaypoint(indx)

Get waypoint.

FLIGHTGROUP:GetWaypointByID(uid)

Get the waypoint from its unique ID.

FLIGHTGROUP:GetWaypointByIndex(index)

Get the waypoint from its index.

FLIGHTGROUP:GetWaypointCoordinate(index)

Get waypoint coordinates.

FLIGHTGROUP:GetWaypointCurrent()

Get current waypoint.

FLIGHTGROUP:GetWaypointCurrentUID()

Get current waypoint UID.

FLIGHTGROUP:GetWaypointFinal()

Get final waypoint.

FLIGHTGROUP:GetWaypointID(indx)

Get unique ID of waypoint given its index.

FLIGHTGROUP:GetWaypointIndex(uid)

Get the waypoint index (its position in the current waypoints table).

FLIGHTGROUP:GetWaypointIndexAfterID(uid)

Get waypoint index after waypoint with given ID.

FLIGHTGROUP:GetWaypointIndexCurrent()

Get current waypoint index.

FLIGHTGROUP:GetWaypointIndexNext(cyclic, i)

Get next waypoint index.

FLIGHTGROUP:GetWaypointNext(cyclic)

Get next waypoint.

FLIGHTGROUP:GetWaypointSpeed(indx)

Get waypoint speed.

FLIGHTGROUP:GetWaypointUID(waypoint)

Get unique ID of waypoint.

FLIGHTGROUP:GetWaypointUIDFromIndex(index)

Get the waypoint UID from its index, i.e.

FLIGHTGROUP:GetWaypoints()

Get the waypoints.

FLIGHTGROUP:GetWeaponData(BitType)

Get weapon data.

FLIGHTGROUP:GetWeightCargo(UnitName, IncludeReserved)

Get weight of the internal cargo the group is carriing right now.

FLIGHTGROUP:GetWeightCargoMax(UnitName)

Get max weight of the internal cargo the group can carry.

FLIGHTGROUP:GetWeightTotal(UnitName, IncludeReserved)

Get total weight of the group including cargo.

FLIGHTGROUP.GroupStatus

FLIGHTGROUP:HasLoS(Coordinate, Element, OffsetElement, OffsetCoordinate)

Check if an element of the group has line of sight to a coordinate.

FLIGHTGROUP:HasPassedFinalWaypoint()

Check if this group has passed its final waypoint.

FLIGHTGROUP:HasTaskController()

Returns true if the DCS controller currently has a task.

FLIGHTGROUP:InWeaponRange(TargetCoord, WeaponBitType, RefCoord)

Check if a given coordinate is in weapon range.

FLIGHTGROUP:IsActive()

Check if group is activated.

FLIGHTGROUP:IsAlive()

Check if group is alive.

FLIGHTGROUP:IsArmygroup()

Check if this is a ARMYGROUP.

FLIGHTGROUP:IsAwaitingLift(Transport)

Check if awaiting a transport lift.

FLIGHTGROUP:IsBoarding(CarrierGroupName)

Check if the group is currently boarding a carrier.

FLIGHTGROUP:IsBusy()

Check if the group is currently busy doing something.

FLIGHTGROUP:IsCargo(CheckTransport)

Check if the group is assigned as cargo.

FLIGHTGROUP:IsCarrier()

Check if the group is a carrier.

FLIGHTGROUP:IsDead()

Check if group is dead.

FLIGHTGROUP:IsDestroyed()

Check if group was destroyed.

FLIGHTGROUP:IsEngaging()

Check if the group is engaging another unit or group.

FLIGHTGROUP:IsExist()

Check if group is exists.

FLIGHTGROUP:IsFlightgroup()

Check if this is a FLIGHTGROUP.

FLIGHTGROUP:IsInUtero()

Check if group is in state in utero.

FLIGHTGROUP:IsInZone(Zone)

Check if group is currently inside a zone.

FLIGHTGROUP:IsLasing()

Check if the group has currently switched a LASER on.

FLIGHTGROUP:IsLateActivated()

Check if this group is currently "late activated" and needs to be "activated" to appear in the mission.

FLIGHTGROUP:IsLoaded(CarrierGroupName)

Check if the group is currently loaded into a carrier.

FLIGHTGROUP:IsLoading()

Check if the group is loading cargo.

FLIGHTGROUP:IsMissionInQueue(Mission)

Check if a given mission is already in the queue.

FLIGHTGROUP:IsMissionTypeInQueue(MissionType)

Check if a given mission type is already in the queue.

FLIGHTGROUP:IsNavygroup()

Check if this is a NAVYGROUP.

FLIGHTGROUP:IsNotCargo(CheckTransport)

Check if the group is not cargo.

FLIGHTGROUP:IsNotCarrier()

Check if the group is not a carrier yet.

FLIGHTGROUP:IsOnMission(MissionUID)

Check if group is currently on a mission.

FLIGHTGROUP:IsOutOfAmmo()

Check if the group is completely out of ammo.

FLIGHTGROUP:IsOutOfBombs()

Check if the group is out of bombs.

FLIGHTGROUP:IsOutOfGuns()

Check if the group is out of guns.

FLIGHTGROUP:IsOutOfMissiles()

Check if the group is out of missiles.

FLIGHTGROUP:IsOutOfTorpedos()

Check if the group is out of torpedos.

FLIGHTGROUP:IsPickingup()

Check if the group is picking up cargo.

FLIGHTGROUP:IsRearming()

Check if the group is currently rearming or on its way to the rearming place.

FLIGHTGROUP:IsRetreated()

Check if the group is retreated (has reached its retreat zone).

FLIGHTGROUP:IsRetreating()

Check if the group is currently retreating or retreated.

FLIGHTGROUP:IsReturning()

Check if the group is currently returning to a zone.

FLIGHTGROUP:IsSpawned()

Check if group is in state spawned.

FLIGHTGROUP:IsStopped()

Check if FSM is stopped.

FLIGHTGROUP:IsTargetDetected(TargetObject)

Check if target is detected.

FLIGHTGROUP:IsTransporting()

Check if the group is transporting cargo.

FLIGHTGROUP:IsUncontrolled()

Check if this group is currently "uncontrolled" and needs to be "started" to begin its route.

FLIGHTGROUP:IsUnloading()

Check if the group is unloading cargo.

FLIGHTGROUP:IsWaiting()

Check if group is currently waiting.

FLIGHTGROUP:KnowTarget(TargetObject, KnowType, KnowDist, Delay)

Set detection on or off.

FLIGHTGROUP:MarkWaypoints(Duration)

Mark waypoints on F10 map.

FLIGHTGROUP:MissionCancel(Mission)

Triggers the FSM event "MissionCancel".

FLIGHTGROUP:MissionDone(Mission)

Triggers the FSM event "MissionDone".

FLIGHTGROUP:MissionExecute(Mission)

Triggers the FSM event "MissionExecute".

FLIGHTGROUP:MissionStart(Mission)

Triggers the FSM event "MissionStart".

FLIGHTGROUP.Ndestroyed

Number of destroyed units.

FLIGHTGROUP:New(group)

Create a new OPSGROUP class object.

FLIGHTGROUP:NewTaskScheduled(task, clock, description, prio, duration)

Create a scheduled task.

FLIGHTGROUP.Nhit

Number of hits taken.

FLIGHTGROUP.Nkills

Number kills of this groups.

FLIGHTGROUP:OnAfterDetectedGroup(From, Event, To, Group)

On After "DetectedGroup" event.

FLIGHTGROUP:OnAfterDetectedGroupKnown(From, Event, To, Group)

On After "DetectedGroupKnown" event.

FLIGHTGROUP:OnAfterDetectedGroupLost(From, Event, To, Group)

On After "DetectedGroupLost" event.

FLIGHTGROUP:OnAfterDetectedGroupNew(From, Event, To, Group)

On After "DetectedGroupNew" event.

FLIGHTGROUP:OnAfterDetectedUnit(From, Event, To, Unit)

On After "DetectedUnit" event.

FLIGHTGROUP:OnAfterDetectedUnitKnown(From, Event, To, Unit)

On After "DetectedUnitKnown" event.

FLIGHTGROUP:OnAfterDetectedUnitLost(From, Event, To, Unit)

On After "DetectedUnitLost" event.

FLIGHTGROUP:OnAfterDetectedUnitNew(From, Event, To, Unit)

On After "DetectedUnitNew" event.

FLIGHTGROUP:OnAfterHoverEnd(From, Event, To)

On after "HoverEnd" event.

FLIGHTGROUP:OnAfterHoverStart(From, Event, To)

On after "HoverStart" event.

FLIGHTGROUP:OnAfterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

FLIGHTGROUP:OnAfterMissionDone(From, Event, To, Mission)

On after "MissionDone" event.

FLIGHTGROUP:OnAfterMissionExecute(From, Event, To, Mission)

On after "MissionExecute" event.

FLIGHTGROUP:OnAfterMissionStart(From, Event, To, Mission)

On after "MissionStart" event.

FLIGHTGROUP:OnAfterTransportCancel(From, Event, To, Transport)

On after "TransportCancel" event.

FLIGHTGROUP:OnEventBirth(EventData)

Event function handling the birth of a unit.

FLIGHTGROUP:OnEventDead(EventData)

Event function handling the dead of a unit.

FLIGHTGROUP:OnEventHit(EventData)

Event function handling the hit of a unit.

FLIGHTGROUP:OnEventKill(EventData)

Event function handling the event that a unit achieved a kill.

FLIGHTGROUP:OnEventPlayerLeaveUnit(EventData)

Event function handling when a unit is removed from the game.

FLIGHTGROUP:OnEventRemoveUnit(EventData)

Event function handling when a unit is removed from the game.

FLIGHTGROUP:PushTask(DCSTask)

Push DCS task.

FLIGHTGROUP:RadioTransmission(Text, Delay, SayCallsign, Frequency)

Send a radio transmission via SRS Text-To-Speech.

FLIGHTGROUP:RedWeightCargo(UnitName, Weight)

Reduce weight to the internal cargo of an element of the group.

FLIGHTGROUP:RemoveMission(Mission)

Remove mission from queue.

FLIGHTGROUP:RemoveTask(Task)

Remove task from task queue.

FLIGHTGROUP:RemoveWaypoint(wpindex)

Remove a waypoint.

FLIGHTGROUP:RemoveWaypointByID(uid)

Remove a waypoint with a ceratin UID.

FLIGHTGROUP:RemoveWaypointMarkers(Delay)

Remove waypoints markers on the F10 map.

FLIGHTGROUP:ReturnToLegion(Delay)

Return group back to the legion it belongs to.

FLIGHTGROUP:Route(waypoints, delay)

Route group along waypoints.

FLIGHTGROUP:RouteToMission(mission, delay)

Route group to mission.

FLIGHTGROUP:SelfDestruction(Delay, ExplosionPower, ElementName)

Self destruction of group.

FLIGHTGROUP:SetAltitude(Altitude, Keep, RadarAlt)

Set current altitude.

FLIGHTGROUP:SetCargoBayLimit(Weight, UnitName)

Set max weight that each unit of the group can handle.

FLIGHTGROUP:SetCarrierLoaderAllAspect(Length, Width)

Set that this carrier is an all aspect loader.

FLIGHTGROUP:SetCarrierLoaderBack(Length, Width)

Set that this carrier is a back loader.

FLIGHTGROUP:SetCarrierLoaderFront(Length, Width)

Set that this carrier is a front loader.

FLIGHTGROUP:SetCarrierLoaderPort(Length, Width)

Set that this carrier is a port (left side) loader.

FLIGHTGROUP:SetCarrierLoaderStarboard(Length, Width)

Set that this carrier is a starboard (right side) loader.

FLIGHTGROUP:SetCarrierUnloaderAllAspect(Length, Width)

Set that this carrier is an all aspect unloader.

FLIGHTGROUP:SetCarrierUnloaderBack(Length, Width)

Set that this carrier is a back unloader.

FLIGHTGROUP:SetCarrierUnloaderFront(Length, Width)

Set that this carrier is a front unloader.

FLIGHTGROUP:SetCarrierUnloaderPort(Length, Width)

Set that this carrier is a port (left side) unloader.

FLIGHTGROUP:SetCarrierUnloaderStarboard(Length, Width)

Set that this carrier is a starboard (right side) unloader.

FLIGHTGROUP:SetCheckZones(CheckZonesSet)

Define a SET of zones that trigger and event if the group enters or leaves any of the zones.

FLIGHTGROUP:SetDefaultAlarmstate(alarmstate)

Set the default Alarm State for the group.

FLIGHTGROUP:SetDefaultAltitude(Altitude)

Set default cruise altitude.

FLIGHTGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)

Set default callsign.

FLIGHTGROUP:SetDefaultEPLRS(OnOffSwitch)

Set the default EPLRS for the group.

FLIGHTGROUP:SetDefaultEmission(OnOffSwitch)

Set the default emission state for the group.

FLIGHTGROUP:SetDefaultFormation(Formation)

Set default formation.

FLIGHTGROUP:SetDefaultICLS(Channel, Morse, UnitName, OffSwitch)

Set default ICLS parameters.

FLIGHTGROUP:SetDefaultImmortal(OnOffSwitch)

Set the default immortal for the group.

FLIGHTGROUP:SetDefaultInvisible(OnOffSwitch)

Set the default invisible for the group.

FLIGHTGROUP:SetDefaultROE(roe)

Set the default ROE for the group.

FLIGHTGROUP:SetDefaultROT(rot)

Set the default ROT for the group.

FLIGHTGROUP:SetDefaultRadio(Frequency, Modulation, OffSwitch)

Set default Radio frequency and modulation.

FLIGHTGROUP:SetDefaultSpeed(Speed)

Set default cruise speed.

FLIGHTGROUP:SetDefaultTACAN(Channel, Morse, UnitName, Band, OffSwitch)

Set default TACAN parameters.

FLIGHTGROUP:SetDetection(Switch)

Set detection on or off.

FLIGHTGROUP:SetEngageDetectedOff()

Disable to automatically engage detected targets.

FLIGHTGROUP:SetEngageDetectedOn(RangeMax, TargetTypes, EngageZoneSet, NoEngageZoneSet)

Enable to automatically engage detected targets.

FLIGHTGROUP:SetLaser(Code, CheckLOS, IROff, UpdateTime)

Set LASER parameters.

FLIGHTGROUP:SetLaserTarget(Target)

Set LASER target.

FLIGHTGROUP:SetRearmOnOutOfAmmo()

Set that group is going to rearm once it runs out of ammo.

FLIGHTGROUP:SetRetreatOnOutOfAmmo()

Set that group is retreating once it runs out of ammo.

FLIGHTGROUP:SetReturnOnOutOfAmmo()

Set that group is return to legion once it runs out of ammo.

FLIGHTGROUP:SetReturnToLegion(Switch)

[GROUND, NAVAL] Set whether this group should return to its legion once all mission etc are finished.

FLIGHTGROUP:SetSRS(PathToSRS, Gender, Culture, Voice, Port, PathToGoogleKey, Label, Volume)

Use SRS Simple-Text-To-Speech for transmissions.

FLIGHTGROUP:SetSpeed(Speed, Keep, AltCorrected)

Set current speed.

FLIGHTGROUP:SetTask(DCSTask)

Set DCS task.

FLIGHTGROUP:SetVerbosity(VerbosityLevel)

Set verbosity level.

FLIGHTGROUP:Status()

Triggers the FSM event "Status".

FLIGHTGROUP:Stop()

Triggers the FSM event "Stop".

FLIGHTGROUP:SwitchAlarmstate(alarmstate)

Set current Alarm State of the group.

FLIGHTGROUP:SwitchCallsign(CallsignName, CallsignNumber)

Switch to a specific callsign.

FLIGHTGROUP:SwitchEPLRS(OnOffSwitch)

Switch EPLRS datalink on or off.

FLIGHTGROUP:SwitchEmission(OnOffSwitch)

Switch emission on or off.

FLIGHTGROUP:SwitchFormation(Formation)

Switch to a specific formation.

FLIGHTGROUP:SwitchICLS(Channel, Morse, UnitName)

Activate/switch ICLS beacon settings.

FLIGHTGROUP:SwitchImmortal(OnOffSwitch)

Switch immortality on or off.

FLIGHTGROUP:SwitchInvisible(OnOffSwitch)

Switch invisibility on or off.

FLIGHTGROUP:SwitchROE(roe)

Set current ROE for the group.

FLIGHTGROUP:SwitchROT(rot)

Set ROT for the group.

FLIGHTGROUP:SwitchRadio(Frequency, Modulation)

Turn radio on or switch frequency/modulation.

FLIGHTGROUP:SwitchTACAN(Channel, Morse, UnitName, Band)

Activate/switch TACAN beacon settings.

FLIGHTGROUP.TaskStatus

FLIGHTGROUP.TaskType

FLIGHTGROUP:Teleport(Coordinate, Delay, NoPauseMission)

Teleport the group to a different location.

FLIGHTGROUP.Tloading

FLIGHTGROUP.Tpickingup

FLIGHTGROUP.TpositionUpdate

FLIGHTGROUP:TransportCancel(Transport)

Triggers the FSM event "TransportCancel".

FLIGHTGROUP.Ttransporting

FLIGHTGROUP.Tunloading

FLIGHTGROUP:TurnOffICLS()

Deactivate ICLS beacon.

FLIGHTGROUP:TurnOffRadio()

Turn radio off.

FLIGHTGROUP:TurnOffTACAN()

Deactivate TACAN beacon.

FLIGHTGROUP.Twaiting

Abs. mission time stamp when the group was ordered to wait.

FLIGHTGROUP:_AddCargobay(CargoGroup, CarrierElement, Reserved)

Add OPSGROUP to cargo bay of a carrier.

FLIGHTGROUP:_AddCargobayStorage(CarrierElement, CargoUID, StorageType, StorageAmount, StorageWeight)

Add warehouse storage to cargo bay of a carrier.

FLIGHTGROUP:_AddElementByName(unitname)

Add a unit/element to the OPS group.

FLIGHTGROUP:_AddMyCargoBay(MyCargo, CarrierElement)

Add storage to cargo bay of a carrier.

FLIGHTGROUP:_AddMyLift(Transport)

Check if awaiting a transport.

FLIGHTGROUP:_AddWaypoint(waypoint, wpnumber)

Initialize Mission Editor waypoints.

FLIGHTGROUP:_AllSameStatus(unitname, status)

Check if all elements of the group have the same status (or are dead).

FLIGHTGROUP:_AllSimilarStatus(status)

Check if all elements of the group have the same status (or are dead).

FLIGHTGROUP:_CheckAmmoFull()

Check ammo is full.

FLIGHTGROUP:_CheckAmmoStatus()

Check ammo status.

FLIGHTGROUP:_CheckCargoTransport()

Check cargo transport assignments.

FLIGHTGROUP:_CheckDamage()

Check damage.

FLIGHTGROUP:_CheckDelivered(CargoTransport)

Check if all cargo of this transport assignment was delivered.

FLIGHTGROUP:_CheckDetectedUnits()

Check detected units.

FLIGHTGROUP:_CheckGoPickup(CargoTransport)

Check if all cargo of this transport assignment was delivered.

FLIGHTGROUP:_CheckGroupDone(delay)

Check if passed the final waypoint and, if necessary, update route.

FLIGHTGROUP:_CheckInZones()

Check if group is in zones.

FLIGHTGROUP:_CheckStuck()

Check if group got stuck.

FLIGHTGROUP:_CoordinateFromObject(Object)

Get coordinate from an object.

FLIGHTGROUP:_CountPausedMissions()

Count paused mission.

FLIGHTGROUP:_CreateMyCargo(CargoUID, OpsGroup, StorageType, StorageAmount, StorageWeight)

Add OPSGROUP to cargo bay of a carrier.

FLIGHTGROUP:_CreateWaypoint(Waypoint, waypoint)

Enhance waypoint table.

FLIGHTGROUP:_DelCargobay(CargoGroup)

Remove OPSGROUP from cargo bay of a carrier.

FLIGHTGROUP:_DelCargobayElement(Element, MyCargo)

Remove OPSGROUP from cargo bay of a carrier.

FLIGHTGROUP:_DelMyLift(Transport)

Remove my lift.

FLIGHTGROUP:_GetCargobay(CargoGroup)

Get cargo bay item.

FLIGHTGROUP:_GetCargobayElement(Element, CargoUID)

Remove OPSGROUP from cargo bay of a carrier.

FLIGHTGROUP:_GetDetectedTarget()

Get target group.

FLIGHTGROUP:_GetElementZoneLoader(Element, Zone, Loader)

Get/update the (un-)loading zone of the element.

FLIGHTGROUP:_GetMyCargoBayFromUID(uid)

Get cargo bay data from a cargo data id.

FLIGHTGROUP:_GetMyCarrier()

Get my carrier.

FLIGHTGROUP:_GetMyCarrierElement()

Get my carrier element.

FLIGHTGROUP:_GetMyCarrierGroup()

Get my carrier group.

FLIGHTGROUP:_GetNextCargoTransport()

Get cargo transport from cargo queue.

FLIGHTGROUP:_GetNextMission()

Get next mission.

FLIGHTGROUP:_GetNextTask()

Get next task in queue.

FLIGHTGROUP:_GetPausedMission()

Get paused mission.

FLIGHTGROUP:_GetROEName(roe)

Get name of ROE corresponding to the numerical value.

FLIGHTGROUP:_GetTemplate(Copy)

Get the template of the group.

FLIGHTGROUP:_GetWeightStorage(Storage, Total, Reserved, Amount)

Get weight of warehouse storage to transport.

FLIGHTGROUP:_InitWaypoints(WpIndexMin, WpIndexMax)

Initialize Mission Editor waypoints.

FLIGHTGROUP:_IsElement(unitname)

Check if a unit is an element of the flightgroup.

FLIGHTGROUP:_IsInCargobay(OpsGroup)

Check if a group is in the cargo bay.

FLIGHTGROUP:_IsMyCarrierReserved()

Is my carrier reserved.

FLIGHTGROUP:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

FLIGHTGROUP:_NewCargoStatus(Status)

Set (new) cargo status.

FLIGHTGROUP:_NewCarrierStatus(Status)

Set (new) carrier status.

FLIGHTGROUP:_PassedFinalWaypoint(final, comment)

Set passed final waypoint value.

FLIGHTGROUP._PassingWaypoint(opsgroup, uid)

Function called when a group is passing a waypoint.

FLIGHTGROUP:_PrintTaskAndMissionStatus()

Print info on mission and task status to DCS log file.

FLIGHTGROUP:_QueueUpdate()

On after "QueueUpdate" event.

FLIGHTGROUP:_RemoveMissionWaypoints(Mission, Silently)

On after "MissionDone" event.

FLIGHTGROUP:_RemoveMyCarrier()

Remove my carrier.

FLIGHTGROUP:_RemovePausedMission(AuftragsNummer)

Remove paused mission from the table.

FLIGHTGROUP:_Respawn(Delay, Template, Reset)

Respawn the group.

FLIGHTGROUP:_SandwitchDCSTask(DCSTask, Task, SetTask, Delay)

Sandwitch DCS task in stop condition and push the task to the group.

FLIGHTGROUP:_SetElementStatusAll(status)

Set status for all elements (except dead ones).

FLIGHTGROUP:_SetLegion(Legion)

Set legion this ops group belongs to.

FLIGHTGROUP:_SetMissionOptions(mission)

Set mission specific options for ROE, Alarm state, etc.

FLIGHTGROUP:_SetMyCarrier(CarrierGroup, CarrierElement, Reserved)

Set my carrier.

FLIGHTGROUP:_SetTemplate(Template)

Set the template of the group.

FLIGHTGROUP:_SetWaypointTasks(Waypoint)

Set tasks at this waypoint

FLIGHTGROUP:_SimpleTaskFunction(Function, uid)

Simple task function.

FLIGHTGROUP:_SortCargo(Cargos)

On after "Loading" event.

FLIGHTGROUP:_SortTaskQueue()

Sort task queue.

FLIGHTGROUP:_SwitchICLS(Icls)

Activate/switch ICLS beacon settings.

FLIGHTGROUP:_SwitchTACAN(Tacan)

Activate/switch TACAN beacon settings.

FLIGHTGROUP._TaskDone(group, opsgroup, task)

Function called when a task is done.

FLIGHTGROUP._TaskExecute(group, opsgroup, task)

Function called when a task is executed.

FLIGHTGROUP:_TransferCargo(CargoGroup, CarrierGroup, CarrierElement)

Transfer cargo from to another carrier.

FLIGHTGROUP:_UpdateLaser()

Update laser point.

FLIGHTGROUP:_UpdatePosition()

Check if all elements of the group have the same status (or are dead).

FLIGHTGROUP:_UpdateStatus(element, newstatus, airbase)

Check if all elements of the group have the same status or are dead.

FLIGHTGROUP:_UpdateTask(Task, Mission)

Update (DCS) task.

FLIGHTGROUP:_UpdateWaypointTasks(n)

Initialize Mission Editor waypoints.

FLIGHTGROUP:__MissionCancel(delay, Mission)

Triggers the FSM event "MissionCancel" after a delay.

FLIGHTGROUP:__MissionDone(delay, Mission)

Triggers the FSM event "MissionDone" after a delay.

FLIGHTGROUP:__MissionExecute(delay, Mission)

Triggers the FSM event "MissionExecute" after a delay.

FLIGHTGROUP:__MissionStart(delay, Mission)

Triggers the FSM event "MissionStart" after a delay.

FLIGHTGROUP:__Status(delay)

Triggers the FSM event "Status" after a delay.

FLIGHTGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

FLIGHTGROUP:__TransportCancel(delay, Transport)

Triggers the FSM event "TransportCancel" after a delay.

FLIGHTGROUP.actype

FLIGHTGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

FLIGHTGROUP.altitudeCruise

FLIGHTGROUP.ammo

Initial ammount of ammo.

FLIGHTGROUP.attribute

Generalized attribute.

FLIGHTGROUP.callsign

Current callsign settings.

FLIGHTGROUP.callsignAlias

Callsign alias.

FLIGHTGROUP.callsignDefault

Default callsign settings.

FLIGHTGROUP.callsignName

Callsign name.

FLIGHTGROUP.cargoBay

Table containing OPSGROUP loaded into this group.

FLIGHTGROUP.cargoStatus

Cargo status of this group acting as cargo.

FLIGHTGROUP.cargoTZC

Transport zone combo (pickup, deploy etc.) currently used.

FLIGHTGROUP.cargoTransport

Current cargo transport assignment.

FLIGHTGROUP.cargoTransportUID

Unique ID of the transport assignment this cargo group is associated with.

FLIGHTGROUP.cargoqueue

Table containing cargo groups to be transported.

FLIGHTGROUP.carrier

Carrier the group is loaded into as cargo.

FLIGHTGROUP.carrierGroup

Carrier group transporting this group as cargo.

FLIGHTGROUP.carrierLoader

Carrier loader parameters.

FLIGHTGROUP.carrierStatus

Carrier status of this group acting as cargo carrier.

FLIGHTGROUP.carrierUnloader

Carrier unloader parameters.

FLIGHTGROUP.category

FLIGHTGROUP.ceiling

FLIGHTGROUP.checkzones

Set of zones.

FLIGHTGROUP.cohort

Cohort the group belongs to.

FLIGHTGROUP.controller

The DCS controller of the group.

FLIGHTGROUP.coordinate

Current coordinate.

FLIGHTGROUP.currbase

The current airbase of the flight group, i.e. where it is currently located or landing at.

FLIGHTGROUP.currentmission

The ID (auftragsnummer) of the currently assigned AUFTRAG.

FLIGHTGROUP.currentwp

Current waypoint index. This is the index of the last passed waypoint.

FLIGHTGROUP.dTpositionUpdate

FLIGHTGROUP.dTwait

Time to wait in seconds. Default nil (for ever).

FLIGHTGROUP.dcsgroup

The DCS group object.

FLIGHTGROUP.descriptors

FLIGHTGROUP.destbase

The destination base of the flight group.

FLIGHTGROUP.destzone

The destination zone of the flight group. Set when final waypoint is in air.

FLIGHTGROUP.detectedgroups

Set of detected groups.

FLIGHTGROUP.detectedunits

Set of detected units.

FLIGHTGROUP.detectionOn

If true, detected units of the group are analyzed.

FLIGHTGROUP.elements

Table of elements, i.e. units of the group.

FLIGHTGROUP.engagedetectedEngageZones

Set of zones in which targets are engaged. Default is anywhere.

FLIGHTGROUP.engagedetectedNoEngageZones

Set of zones in which targets are not engaged. Default is nowhere.

FLIGHTGROUP.engagedetectedOn

If true, auto engage detected targets.

FLIGHTGROUP.engagedetectedRmax

Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.

FLIGHTGROUP.engagedetectedTypes

Types of target attributes that will be engaged. See DCS enum attributes. Default "All".

FLIGHTGROUP.group

Group object.

FLIGHTGROUP.groupinitialized

If true, group parameters were initialized.

FLIGHTGROUP.groupname

Name of the group.

FLIGHTGROUP.heading

Heading of the group at last status check.

FLIGHTGROUP.headingLast

Backup of last heading to monitor changes.

FLIGHTGROUP.homebase

The home base of the flight group.

FLIGHTGROUP.homezone

The home zone of the flight group. Set when spawn happens in air.

FLIGHTGROUP.icls

Current ICLS settings.

FLIGHTGROUP.iclsDefault

Default ICLS settings.

FLIGHTGROUP.inzones

Set of zones in which the group is currently in.

FLIGHTGROUP.isAI

If true, group is purely AI.

FLIGHTGROUP.isArmygroup

Is an ARMYGROUP.

FLIGHTGROUP.isDead

If true, the whole group is dead.

FLIGHTGROUP.isDestroyed

If true, the whole group was destroyed.

FLIGHTGROUP.isEPLRS

FLIGHTGROUP.isFlightgroup

Is a FLIGHTGROUP.

FLIGHTGROUP.isHelo

If true, this is a helicopter group.

FLIGHTGROUP.isLandingAtAirbase

FLIGHTGROUP.isLateActivated

Is the group late activated.

FLIGHTGROUP.isMobile

If true, group is mobile (speed > 1 m/s)

FLIGHTGROUP.isNavygroup

Is a NAVYGROUP.

FLIGHTGROUP.isSubmarine

If true, this is a submarine group.

FLIGHTGROUP.isTrain

FLIGHTGROUP.isUncontrolled

Is the group uncontrolled.

FLIGHTGROUP.isVTOL

If true, this is capable of Vertical TakeOff and Landing (VTOL).

FLIGHTGROUP.ispathfinding

If true, group is on pathfinding route.

FLIGHTGROUP.legion

Legion the group belongs to.

FLIGHTGROUP.legionReturn

FLIGHTGROUP.lid

Class id string for output to DCS log file.

FLIGHTGROUP.life

FLIGHTGROUP.missionqueue

Queue of missions.

FLIGHTGROUP.msrs

MOOSE SRS wrapper.

FLIGHTGROUP.mycarrier

Carrier group for this group.

FLIGHTGROUP.mylifts

FLIGHTGROUP:onafterBoard(From, Event, To, CarrierGroup, Carrier)

On after "Board" event.

FLIGHTGROUP:onafterDamaged(From, Event, To)

On after "Damaged" event.

FLIGHTGROUP:onafterDead(From, Event, To)

On after "Dead" event.

FLIGHTGROUP:onafterDelivered(From, Event, To, CargoTransport)

On after "Delivered" event.

FLIGHTGROUP:onafterDestroyed(From, Event, To)

On after "Destroyed" event.

FLIGHTGROUP:onafterDetectedGroup(From, Event, To, Group)

On after "DetectedGroup" event.

FLIGHTGROUP:onafterDetectedGroupNew(From, Event, To, Group)

On after "DetectedGroupNew" event.

FLIGHTGROUP:onafterDetectedUnit(From, Event, To, Unit)

On after "DetectedUnit" event.

FLIGHTGROUP:onafterDetectedUnitNew(From, Event, To, Unit)

On after "DetectedUnitNew" event.

FLIGHTGROUP:onafterElementDamaged(From, Event, To, Element)

On after "ElementDamaged" event.

FLIGHTGROUP:onafterElementDead(From, Event, To, Element)

On after "ElementDead" event.

FLIGHTGROUP:onafterElementDestroyed(From, Event, To, Element)

On after "ElementDestroyed" event.

FLIGHTGROUP:onafterElementHit(From, Event, To, Element, Enemy)

On after "ElementHit" event.

FLIGHTGROUP:onafterElementInUtero(From, Event, To, Element)

On after "ElementInUtero" event.

FLIGHTGROUP:onafterEnterZone(From, Event, To, Zone)

On after "EnterZone" event.

FLIGHTGROUP:onafterGotoWaypoint(From, Event, To, UID, Speed)

On after "GotoWaypoint" event.

FLIGHTGROUP:onafterHit(From, Event, To, Enemy)

On after "Hit" event.

FLIGHTGROUP:onafterInUtero(From, Event, To)

On after "InUtero" event.

FLIGHTGROUP:onafterLaserCode(From, Event, To, Code)

On after "LaserCode" event.

FLIGHTGROUP:onafterLaserGotLOS(From, Event, To)

On after "LaserGotLOS" event.

FLIGHTGROUP:onafterLaserLostLOS(From, Event, To)

On after "LaserLostLOS" event.

FLIGHTGROUP:onafterLaserOff(From, Event, To)

On after "LaserOff" event.

FLIGHTGROUP:onafterLaserOn(From, Event, To, Target)

On after "LaserOn" event.

FLIGHTGROUP:onafterLaserPause(From, Event, To)

On after "LaserPause" event.

FLIGHTGROUP:onafterLaserResume(From, Event, To)

On after "LaserResume" event.

FLIGHTGROUP:onafterLeaveZone(From, Event, To, Zone)

On after "LeaveZone" event.

FLIGHTGROUP:onafterLoad(From, Event, To, CargoGroup, Carrier)

On after "Load" event.

FLIGHTGROUP:onafterLoading(From, Event, To)

On after "Loading" event.

FLIGHTGROUP:onafterLoadingDone(From, Event, To)

On after "LoadingDone" event.

FLIGHTGROUP:onafterMissionCancel(From, Event, To, Mission)

On after "MissionCancel" event.

FLIGHTGROUP:onafterMissionDone(From, Event, To, Mission)

On after "MissionDone" event.

FLIGHTGROUP:onafterMissionExecute(From, Event, To, Mission)

On after "MissionExecute" event.

FLIGHTGROUP:onafterMissionStart(From, Event, To, Mission)

On after "MissionStart" event.

FLIGHTGROUP:onafterOutOfAmmo(From, Event, To)

On after "OutOfAmmo" event.

FLIGHTGROUP:onafterPassedFinalWaypoint(From, Event, To)

On after "PassedFinalWaypoint" event.

FLIGHTGROUP:onafterPassingWaypoint(From, Event, To, Waypoint)

On after "PassingWaypoint" event.

FLIGHTGROUP:onafterPauseMission(From, Event, To)

On after "PauseMission" event.

FLIGHTGROUP:onafterPickup(From, Event, To)

On after "Pickup" event.

FLIGHTGROUP:onafterRespawn(From, Event, To, Template)

On after "Respawn" event.

FLIGHTGROUP:onafterStop(From, Event, To)

On after "Stop" event.

FLIGHTGROUP:onafterTaskCancel(From, Event, To, Task)

On after "TaskCancel" event.

FLIGHTGROUP:onafterTaskDone(From, Event, To, Task)

On after "TaskDone" event.

FLIGHTGROUP:onafterTaskExecute(From, Event, To, Task)

On after "TaskExecute" event.

FLIGHTGROUP:onafterTransport(From, Event, To)

On after "Transport" event.

FLIGHTGROUP:onafterTransportCancel(From, Event, To, The, Transport)

On after "TransportCancel" event.

FLIGHTGROUP:onafterUnload(From, Event, To, OpsGroup, Coordinate, Activated, Heading)

On after "Unload" event.

FLIGHTGROUP:onafterUnloaded(From, Event, To, OpsGroupCargo)

On after "Unloaded" event.

FLIGHTGROUP:onafterUnloading(From, Event, To)

On after "Unloading" event.

FLIGHTGROUP:onafterUnloadingDone(From, Event, To)

On after "UnloadingDone" event.

FLIGHTGROUP:onafterUnpauseMission(From, Event, To)

On after "UnpauseMission" event.

FLIGHTGROUP:onafterWait(From, Event, To, Duration)

On after "Wait" event.

FLIGHTGROUP:onbeforeBoard(From, Event, To, CarrierGroup, Carrier)

On before "Board" event.

FLIGHTGROUP:onbeforeDead(From, Event, To)

On before "Dead" event.

FLIGHTGROUP:onbeforeElementSpawned(From, Event, To, Element)

On before "ElementSpawned" event.

FLIGHTGROUP:onbeforeLaserOff(From, Event, To)

On before "LaserOff" event.

FLIGHTGROUP:onbeforeLaserOn(From, Event, To, Target)

On before "LaserOn" event.

FLIGHTGROUP:onbeforeLaserResume(From, Event, To)

On before "LaserResume" event.

FLIGHTGROUP:onbeforeMissionStart(From, Event, To, Mission)

On before "MissionStart" event.

FLIGHTGROUP:onbeforeStop(From, Event, To)

On before "Stop" event.

FLIGHTGROUP:onbeforeTaskDone(From, Event, To, Task)

On before "TaskDone" event.

FLIGHTGROUP:onbeforeTaskExecute(From, Event, To, Task)

On before "TaskExecute" event.

FLIGHTGROUP:onbeforeTransport(From, Event, To)

On before "Transport" event.

FLIGHTGROUP:onbeforeUnload(From, Event, To, OpsGroup, Coordinate, Heading)

On before "Unload" event.

FLIGHTGROUP:onbeforeWait(From, Event, To, Duration)

On before "Wait" event.

FLIGHTGROUP.option

Current optional settings.

FLIGHTGROUP.optionDefault

Default option settings.

FLIGHTGROUP.orientX

Orientation at last status check.

FLIGHTGROUP.orientXLast

Backup of last orientation to monitor changes.

FLIGHTGROUP.outofAmmo

FLIGHTGROUP.outofBombs

FLIGHTGROUP.outofGuns

FLIGHTGROUP.outofMissiles

FLIGHTGROUP.outofMissilesAA

FLIGHTGROUP.outofMissilesAG

FLIGHTGROUP.outofMissilesAS

FLIGHTGROUP.outofRockets

FLIGHTGROUP.outofTorpedos

FLIGHTGROUP.passedfinalwp

Group has passed the final waypoint.

FLIGHTGROUP.pausedmissions

Paused missions.

FLIGHTGROUP.position

Position of the group at last status check.

FLIGHTGROUP.positionLast

Backup of last position vec to monitor changes.

FLIGHTGROUP.radio

Current radio settings.

FLIGHTGROUP.radioDefault

Default radio settings.

FLIGHTGROUP.radioQueue

Radio queue.

FLIGHTGROUP.rangemax

FLIGHTGROUP.rearmOnOutOfAmmo

If true, group will go to rearm once it runs out of ammo.

FLIGHTGROUP.reconindecies

FLIGHTGROUP.refueltype

FLIGHTGROUP.retreatOnOutOfAmmo

FLIGHTGROUP.rtzOnOutOfAmmo

FLIGHTGROUP.scheduleIDDespawn

FLIGHTGROUP.speed

FLIGHTGROUP.speedCruise

Cruising speed in km/h.

FLIGHTGROUP.speedMax

Max speed in km/h.

FLIGHTGROUP.speedWp

Speed to the next waypoint in m/s.

FLIGHTGROUP.spot

Laser and IR spot.

FLIGHTGROUP.stuckDespawn

If true, group gets despawned after beeing stuck for a certain time.

FLIGHTGROUP.stuckTimestamp

Time stamp [sec], when the group got stuck.

FLIGHTGROUP.stuckVec3

Position where the group got stuck.

FLIGHTGROUP.tacan

Current TACAN settings.

FLIGHTGROUP.tacanDefault

Default TACAN settings.

FLIGHTGROUP.tankertype

FLIGHTGROUP.taskcounter

Running number of task ids.

FLIGHTGROUP.taskcurrent

ID of current task. If 0, there is no current task assigned.

FLIGHTGROUP.taskenroute

Enroute task of the group.

FLIGHTGROUP.taskpaused

Paused tasks.

FLIGHTGROUP.taskqueue

Queue of tasks.

FLIGHTGROUP.template

Template table of the group.

FLIGHTGROUP.timerCheckZone

Timer for check zones.

FLIGHTGROUP.timerQueueUpdate

Timer for queue updates.

FLIGHTGROUP.timerStatus

Timer for status update.

FLIGHTGROUP.traveldist

Distance traveled in meters. This is a lower bound.

FLIGHTGROUP.travelds

FLIGHTGROUP.traveltime

Time.

FLIGHTGROUP.useMEtasks

If true, use tasks set in the ME. Default false.

FLIGHTGROUP.useSRS

Use SRS for transmissions.

FLIGHTGROUP.velocity

FLIGHTGROUP.velocityLast

FLIGHTGROUP.verbose

Verbosity level. 0=silent.

FLIGHTGROUP.version

OpsGroup version.

FLIGHTGROUP.waypoints

Table of waypoints.

FLIGHTGROUP.waypoints0

Table of initial waypoints.

FLIGHTGROUP.weaponData

Weapon data table with key=BitType.

FLIGHTGROUP.wpcounter

Running number counting waypoints.

Fields and Methods inherited from FSM Description

FLIGHTGROUP:AddEndState(State)

Adds an End state.

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

FLIGHTGROUP:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

FLIGHTGROUP:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

FLIGHTGROUP.CallScheduler

FLIGHTGROUP.Events

FLIGHTGROUP:GetCurrentState()

Get current state.

FLIGHTGROUP:GetEndStates()

Returns the End states.

FLIGHTGROUP:GetProcess(From, Event)

FLIGHTGROUP:GetProcesses()

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

FLIGHTGROUP:GetScores()

Returns a table with the scores defined.

FLIGHTGROUP:GetStartState()

Returns the start state of the FSM.

FLIGHTGROUP:GetState()

Get current state.

FLIGHTGROUP:GetSubs()

Returns a table with the Subs defined.

FLIGHTGROUP:GetTransitions()

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

FLIGHTGROUP:Is(State)

Check if FSM is in state.

FLIGHTGROUP:LoadCallBacks(CallBackTable)

Load call backs.

FLIGHTGROUP:New()

Creates a new FSM object.

FLIGHTGROUP.Scores

FLIGHTGROUP:SetProcess(From, Event, Fsm)

FLIGHTGROUP:SetStartState(State)

Sets the start state of the FSM.

FLIGHTGROUP._EndStates

FLIGHTGROUP._EventSchedules

FLIGHTGROUP._Processes

FLIGHTGROUP._Scores

FLIGHTGROUP._StartState

FLIGHTGROUP._Transitions

FLIGHTGROUP:_add_to_map(Map, Event)

Add to map.

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

Call handler.

FLIGHTGROUP:_create_transition(EventName)

Create transition.

FLIGHTGROUP:_delayed_transition(EventName)

Delayed transition.

FLIGHTGROUP:_eventmap(Events, EventStructure)

Event map.

FLIGHTGROUP:_gosub(ParentFrom, ParentEvent)

Go sub.

FLIGHTGROUP:_handler(EventName, ...)

Handler.

FLIGHTGROUP:_isendstate(Current)

Is end state.

FLIGHTGROUP:_submap(subs, sub, name)

Sub maps.

FLIGHTGROUP:can(e)

Check if can do an event.

FLIGHTGROUP:cannot(e)

Check if cannot do an event.

FLIGHTGROUP.current

FLIGHTGROUP.endstates

FLIGHTGROUP:is(State, state)

Check if FSM is in state.

FLIGHTGROUP.options

FLIGHTGROUP.subs

Fields and Methods inherited from FLIGHTGROUP.Attribute Description

FLIGHTGROUP.Attribute.ATTACKHELO

Attack helicopter.

FLIGHTGROUP.Attribute.AWACS

Airborne Early Warning and Control System.

FLIGHTGROUP.Attribute.BOMBER

Aircraft which can be used for strategic bombing.

FLIGHTGROUP.Attribute.FIGHTER

Fighter, interceptor, ... airplane.

FLIGHTGROUP.Attribute.OTHER

Other aircraft type.

FLIGHTGROUP.Attribute.TANKER

Airplane which can refuel other aircraft.

FLIGHTGROUP.Attribute.TRANSPORTHELO

Helicopter with transport capability. This can be used to transport other assets.

FLIGHTGROUP.Attribute.TRANSPORTPLANE

Airplane with transport capability. This can be used to transport other assets.

FLIGHTGROUP.Attribute.UAV

Unpiloted Aerial Vehicle, e.g. drones.

Fields and Methods inherited from FLIGHTGROUP.PlayerData Description

FLIGHTGROUP.PlayerData.myvoice

FLIGHTGROUP.PlayerData.name

Player name.

FLIGHTGROUP.PlayerData.skill

Skill level.

FLIGHTGROUP.PlayerData.subtitles

Display subtitles.

Fields and Methods inherited from FLIGHTGROUP.PlayerSkill Description

FLIGHTGROUP.PlayerSkill.AVIATOR

Naval aviator. Moderate number of hints but not really zip lip.

FLIGHTGROUP.PlayerSkill.GRADUATE

TOPGUN graduate. For people who know what they are doing. Nearly ziplip.

FLIGHTGROUP.PlayerSkill.INSTRUCTOR

TOPGUN instructor. For people who know what they are doing. Nearly ziplip.

FLIGHTGROUP.PlayerSkill.STUDENT

Flight Student. Shows tips and hints in important phases of the approach.

Fields and Methods inherited from FLIGHTGROUP.RadioMessage Description

FLIGHTGROUP.RadioMessage.AIRBORNE

FLIGHTGROUP.RadioMessage.TAXIING

Fields and Methods inherited from FLIGHTGROUP.RadioText Description

FLIGHTGROUP.RadioText.enhanced

FLIGHTGROUP.RadioText.normal

FLIGHTGROUP class.

Field(s)

#table FLIGHTGROUP.Players

FLIGHTGROUP players.

#number FLIGHTGROUP.RTBRecallCount

Number that counts RTB calls.

#number FLIGHTGROUP.Tholding

Abs. mission time stamp when the group reached the holding point.

#number FLIGHTGROUP.Tparking

Abs. mission time stamp when the group was spawned uncontrolled and is parking.

#string FLIGHTGROUP.actype

Type name of the aircraft.

#boolean FLIGHTGROUP.ai

If true, flight is purely AI. If false, flight contains at least one human player.

Ops.Airboss#AIRBOSS FLIGHTGROUP.airboss

The airboss handling this group.

Ops.OpsGroup#OPSGROUP.Ammo FLIGHTGROUP.ammo

Ammunition data. Number of Guns, Rockets, Bombs, Missiles.

#number FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

#string FLIGHTGROUP.controlstatus

Flight control status.

FLIGHTGROUP.currbase

Set current airbase.

#boolean FLIGHTGROUP.despawnAfterHolding

If true, group is despawned after reaching the holding point.

#boolean FLIGHTGROUP.despawnAfterLanding

If true, group is despawned after landed at an airbase.

FLIGHTGROUP.destbase

Set the destination base.

OPS.FlightControl#FLIGHTCONTROL FLIGHTGROUP.flightcontrol

The flightcontrol handling this group.

#boolean FLIGHTGROUP.fuelcritical

Fuel critical switch.

#boolean FLIGHTGROUP.fuelcriticalrtb

RTB on critical fuel switch.

#number FLIGHTGROUP.fuelcriticalthresh

Critical fuel threshold in percent.

#boolean FLIGHTGROUP.fuellow

Fuel low switch.

#boolean FLIGHTGROUP.fuellowrtb

RTB on low fuel switch.

#number FLIGHTGROUP.fuellowthresh

Low fuel threshold in percent.

#boolean FLIGHTGROUP.groupinitialized

Init done.

#number FLIGHTGROUP.holdtime

Time [s] flight is holding before going on final. Set to nil for indefinitely.

#boolean FLIGHTGROUP.isDead

Not dead or destroyed yet.

FLIGHTGROUP.isHelo

Helo group.

#boolean FLIGHTGROUP.isReadyTO

Flight is ready for takeoff. This is for FLIGHTCONTROL.

#boolean FLIGHTGROUP.jettisonEmptyTanks

Allow (true) or disallow (false) AI to jettison empty fuel tanks.

#boolean FLIGHTGROUP.jettisonWeapons

Allow (true) or disallow (false) AI to jettison weapons if in danger.

FLIGHTGROUP.lid

Set some string id for output to DCS.log file.

#table FLIGHTGROUP.menu

F10 radio menu.

#boolean FLIGHTGROUP.prohibitAB

Disallow (true) or allow (false) AI to use the afterburner.

#number FLIGHTGROUP.rangemax

Max range in meters.

#number FLIGHTGROUP.refueltype

The refueling system type (0=boom, 1=probe), if the group can refuel from a tanker.

FLIGHTGROUP.speedCruise

Cruise speed: 70% of max speed but within limit.

FLIGHTGROUP.speedMax

Max speed in km/h.

#number FLIGHTGROUP.tankertype

The refueling system type (0=boom, 1=probe), if the group is a tanker.

FLIGHTGROUP.timerCheckZone

Start check zone timer.

FLIGHTGROUP.timerQueueUpdate

Start queue update timer.

FLIGHTGROUP.timerStatus

Start the status monitoring.

#string FLIGHTGROUP.version

FLIGHTGROUP class version.

#table FLIGHTGROUP.waypoints

Waypoints

FLIGHTGROUP.waypoints0

Template waypoints.

Function(s)

Add an enroute task to attack targets in a certain circular zone.

Defined in:

FLIGHTGROUP

Parameters:

The circular zone, where to engage targets.

#table TargetTypes

(Optional) The target types, passed as a table, i.e. mind the curly brackets {}. Default {"Air"}.

#number Priority

(Optional) Priority. Default 0.

Add an AIR waypoint to the flight plan.

Defined in:

FLIGHTGROUP

Parameters:

The coordinate of the waypoint. Use COORDINATE:SetAltitude(altitude) to define the altitude.

#number Speed

Speed in knots. Default is cruise speed.

#number AfterWaypointWithID

Insert waypoint after waypoint given ID. Default is to insert as last waypoint.

#number Altitude

Altitude in feet. Default is y-component of Coordinate. Note that these altitudes are wrt to sea level (barometric altitude).

#boolean Updateroute

If true or nil, call UpdateRoute. If false, no call.

Return value:

Add an LANDING waypoint to the flight plan.

Defined in:

FLIGHTGROUP

Parameters:

The airbase where the group should land.

#number Speed

Speed in knots. Default 350 kts.

#number AfterWaypointWithID

Insert waypoint after waypoint given ID. Default is to insert as last waypoint.

#number Altitude

Altitude in feet. Default is y-component of Coordinate. Note that these altitudes are wrt to sea level (barometric altitude).

#boolean Updateroute

If true or nil, call UpdateRoute. If false, no call.

Return value:

Check if flight can do air-to-air attacks.

Defined in:

FLIGHTGROUP

Parameter:

#boolean ExcludeGuns

If true, exclude available gun shells.

Return value:

#boolean:

true if has air-to-ground weapons.

Check if flight can do air-to-ground tasks.

Defined in:

FLIGHTGROUP

Parameter:

#boolean ExcludeGuns

If true, exclude gun

Return value:

#boolean:

true if has air-to-ground weapons.

Clear the group for landing when it is holding.

Defined in:

FLIGHTGROUP

Parameter:

#number Delay

Delay in seconds before landing clearance is given.

Return value:

self

Find the nearest friendly airbase (same or neutral coalition).

Defined in:

FLIGHTGROUP

Parameter:

#number Radius

Search radius in NM. Default 50 NM.

Return value:

Closest tanker group #nil.

Find the nearest tanker.

Defined in:

FLIGHTGROUP

Parameter:

#number Radius

Search radius in NM. Default 50 NM.

Return value:

Closest tanker group or nil if no tanker is in the given radius.

Get airwing the flight group belongs to.

Defined in:

FLIGHTGROUP

Return value:

The AIRWING object (if any).

Get name of airwing the flight group belongs to.

Defined in:

FLIGHTGROUP

Return value:

#string:

Name of the airwing or "None" if the flightgroup does not belong to any airwing.

Search unoccupied parking spots at the airbase for all flight elements.

Defined in:

FLIGHTGROUP

Return value:

Closest airbase

Check if a unit is and element of the flightgroup.

Defined in:

FLIGHTGROUP

Return value:

Final destination airbase or #nil.

Get the FLIGHTCONTROL controlling this flight group.

Defined in:

FLIGHTGROUP

Return value:

The FLIGHTCONTROL object.

Get min fuel of group.

This returns the relative fuel amount of the element lowest fuel in the group.

Defined in:

FLIGHTGROUP

Return value:

#number:

Relative fuel in percent.

Get holding time.

Defined in:

FLIGHTGROUP

Return value:

#number:

Holding time in seconds or -1 if flight is not holding.

Check if a unit is and element of the flightgroup.

Defined in:

FLIGHTGROUP

Return value:

Final destination airbase or #nil.

Get number of kills of this group.

Defined in:

FLIGHTGROUP

Return value:

#number:

Number of units killed.

Search unoccupied parking spots at the airbase for all flight elements.

Defined in:

FLIGHTGROUP

Parameter:

The airbase where we search for parking spots.

Return value:

#table:

Table of coordinates and terminal IDs of free parking spots.

Returns the parking spot of the element.

Defined in:

FLIGHTGROUP

Parameters:

Element of the flight group.

#number maxdist

Distance threshold in meters. Default 5 m.

(Optional) The airbase to check for parking. Default is closest airbase to the element.

Return value:

Parking spot or nil if no spot is within distance threshold.

Get parking time.

Defined in:

FLIGHTGROUP

Return value:

#number:

Holding time in seconds or -1 if flight is not holding.

Get player element.

Defined in:

FLIGHTGROUP

Return value:

Get player element.

Defined in:

FLIGHTGROUP

Return value:

#string:

Player name or nil.

Get squadron the flight group belongs to.

Defined in:

FLIGHTGROUP

Return value:

The SQUADRON of this flightgroup or #nil if the flightgroup does not belong to any squadron.

Get squadron name the flight group belongs to.

Defined in:

FLIGHTGROUP

Return value:

#string:

The squadron name or "None" if the flightgroup does not belon to any squadron.

Initialize Mission Editor waypoints.

Defined in:

FLIGHTGROUP

Return value:

self

Check if flight is airborne or cruising.

Defined in:

FLIGHTGROUP

Parameter:

(Optional) Only check status for given element.

Return value:

#boolean:

If true, flight is airborne.

Check if flight has arrived at its destination parking spot.

Defined in:

FLIGHTGROUP

Parameter:

(Optional) Only check status for given element.

Return value:

#boolean:

If true, flight has arrived at its destination and is parking.

Check if flight is airborne or cruising.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is airborne.

Check if flight is critical on fuel.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is critical on fuel.

Check if flight is good on fuel (not below low or even critical state).

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is good on fuel.

Check if flight is low on fuel.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is low on fuel.

Check if flight is going for fuel.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is refueling.

Check if flight is holding and waiting for landing clearance.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is holding.

Check if flight is inbound and traveling to holding pattern.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is holding.

Check if flight has landed and is now taxiing to its parking spot.

Defined in:

FLIGHTGROUP

Parameter:

(Optional) Only check status for given element.

Return value:

#boolean:

If true, flight has landed

Check if helo(!) flight has landed at a specific point.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, has landed somewhere.

Check if flight is landing.

Defined in:

FLIGHTGROUP

Parameter:

(Optional) Only check status for given element.

Return value:

#boolean:

If true, flight is landing, i.e. on final approach.

Check if the final waypoint is in the air.

Defined in:

FLIGHTGROUP

Parameter:

#table wp

Waypoint. Default final waypoint.

Return value:

#boolean:

If true final waypoint is a turning or flyover but not a landing type waypoint.

Check if the final waypoint is at an airbase.

Defined in:

FLIGHTGROUP

Parameter:

#table wp

Waypoint. Default final waypoint.

Return value:

#boolean:

If true, final waypoint is a landing waypoint at an airbase.

Check if helo(!) flight is ordered to land at a specific point.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, group has task to land somewhere.

Check if flight is parking.

Defined in:

FLIGHTGROUP

Parameter:

(Optional) Only check status for given element.

Return value:

#boolean:

If true, flight is parking after spawned.

Check if this is an air start.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

Air start?

Check if this is a cold start.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

Cold start, i.e. engines off when spawned?

Check if this is a hot start.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

Hot start?

Check if this is a runway start.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

Runway start?

Check if is taxiing to the runway.

Defined in:

FLIGHTGROUP

Parameter:

(Optional) Only check status for given element.

Return value:

#boolean:

If true, flight is taxiing after engine start up.

Create a new FLIGHTGROUP object and start the FSM.

Defined in:

FLIGHTGROUP

Parameter:

The group object. Can also be given by its group name as #string.

Return value:

self

FSM Function OnAfterAirborne.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterArrived.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterCruise.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterDead.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterDisengage.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Set#SET_UNIT TargetUnitSet

FSM Function OnAfterElementAirborne.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterElementArrived.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

The airbase, where the element arrived.

The Parking spot the element has.

FSM Function OnAfterElementDead.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterElementDestroyed.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterElementEngineOn.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterElementLanded.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

The airbase if applicable or nil.

FSM Function OnAfterElementParking.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterElementSpawned.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterElementTakeoff.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

The airbase if applicable or nil.

FSM Function OnAfterElementTaxiing.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

FSM Function OnAfterEngageTarget.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#table Target

Target object. Can be a UNIT, STATIC, GROUP, SET_UNIT or SET_GROUP object.

FSM Function OnAfterFuelCritical.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterFuelLow.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterLandAt.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Set#SET_UNIT TargetUnitSet

FSM Function OnAfterLandAtAirbase.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

FSM Function OnAfterLanded.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase the flight landed.

FSM Function OnAfterLandedAt.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterLanding.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterOutOfMissilesAA.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterOutOfMissilesAG.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterParking.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterRTB.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

#number SpeedTo

Speed used for traveling from current position to holding point in knots. Default 75% of max speed.

#number SpeedHold

Holding speed in knots. Default 250 kts.

#number SpeedLand

Landing speed in knots. Default 170 kts.

FSM Function OnAfterRefuel.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The coordinate.

FSM Function OnAfterRefueled.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterSpawned.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterTakeoff.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterTaxiing.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

FSM Function OnAfterUpdateRoute.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Next waypoint index. Default is the one coming after that one that has been passed last.

#number N

Waypoint Max waypoint index to be included in the route. Default is the final waypoint.

FSM Function OnAfterWait.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Duration

Duration how long the group will be waiting in seconds. Default nil (=forever).

#number Altitude

Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.

#number Speed

Speed in knots. Default 250 kts for airplanes and 20 kts for helos.

FSM Function OnBeforeLandAt.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The coordinate where to land. Default is current position.

#number Duration

The duration in seconds to remain on ground. Default 600 sec (10 min).

FSM Function OnBeforeLandAtAirbase.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

FSM Function OnBeforeRTB.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

#number SpeedTo

Speed used for travelling from current position to holding point in knots.

#number SpeedHold

Holding speed in knots.

FSM Function OnBeforeUpdateRoute.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Next waypoint index. Default is the one coming after that one that has been passed last.

#number N

Waypoint Max waypoint index to be included in the route. Default is the final waypoint.

Return value:

#boolean:

Transision allowed?

FSM Function OnBeforeWait.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Duration

Duration how long the group will be waiting in seconds. Default nil (=forever).

#number Altitude

Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.

#number Speed

Speed in knots. Default 250 kts for airplanes and 20 kts for helos.

Flightgroup event function handling the crash of a unit.

Defined in:

FLIGHTGROUP

Parameter:

Event data.

Flightgroup event function handling the crash of a unit.

Defined in:

FLIGHTGROUP

Parameter:

Event data.

Flightgroup event function handling the crash of a unit.

Defined in:

FLIGHTGROUP

Parameter:

Event data.

Flightgroup event function handling the crash of a unit.

Defined in:

FLIGHTGROUP

Parameter:

Event data.

Flightgroup event function handling the crash of a unit.

Defined in:

FLIGHTGROUP

Parameter:

Event data.

Flightgroup event function handling the crash of a unit.

Defined in:

FLIGHTGROUP

Parameter:

Event data.

Set the AIRBOSS controlling this flight group.

Defined in:

FLIGHTGROUP

Parameter:

The AIRBOSS object.

Return value:

self

Set if aircraft is allowed to use afterburner.

Defined in:

FLIGHTGROUP

Return value:

self

Enable that the group is despawned after holding.

This can be useful to avoid DCS taxi issues with other AI or players or jamming taxiways.

Defined in:

FLIGHTGROUP

Return value:

self

Enable that the group is despawned after landing.

This can be useful to avoid DCS taxi issues with other AI or players or jamming taxiways.

Defined in:

FLIGHTGROUP

Return value:

self

Set the destination airbase.

This is where the flight will go, when the final waypoint is reached.

Defined in:

FLIGHTGROUP

Parameter:

Wrapper.Airbase#AIRBASE DestinationAirbase

The destination airbase.

Return value:

self

Set the FLIGHTCONTROL controlling this flight group.

Defined in:

FLIGHTGROUP

Parameter:

The FLIGHTCONTROL object.

Return value:

self

Set if critical fuel threshold is reached, flight goes RTB.

Defined in:

FLIGHTGROUP

Parameter:

#boolean switch

If true or nil, flight goes RTB. If false, turn this off.

Return value:

self

Set fuel critical threshold.

Triggers event "FuelCritical" and event function "OnAfterFuelCritical".

Defined in:

FLIGHTGROUP

Parameter:

#number threshold

Fuel threshold in percent. Default 10 %.

Return value:

self

Set if low fuel threshold is reached, flight goes RTB.

Defined in:

FLIGHTGROUP

Parameter:

#boolean switch

If true or nil, flight goes RTB. If false, turn this off.

Return value:

self

Set if low fuel threshold is reached, flight tries to refuel at the neares tanker.

Defined in:

FLIGHTGROUP

Parameter:

#boolean switch

If true or nil, flight goes for refuelling. If false, turn this off.

Return value:

self

Set low fuel threshold.

Triggers event "FuelLow" and calls event function "OnAfterFuelLow".

Defined in:

FLIGHTGROUP

Parameter:

#number threshold

Fuel threshold in percent. Default 25 %.

Return value:

self

Set the homebase.

Defined in:

FLIGHTGROUP

Parameter:

The home airbase.

Return value:

self

Set if aircraft is allowed to drop empty fuel tanks - set to true to allow, and false to forbid it.

Defined in:

FLIGHTGROUP

Parameter:

#boolean Switch

true or false

Return value:

self

Set if aircraft is allowed to drop weapons to escape danger - set to true to allow, and false to forbid it.

Defined in:

FLIGHTGROUP

Parameter:

#boolean Switch

true or false

Return value:

self

Set if flight is out of Air-Air-Missiles, flight goes RTB.

Defined in:

FLIGHTGROUP

Parameter:

#boolean switch

If true or nil, flight goes RTB. If false, turn this off.

Return value:

self

Set if flight is out of Air-Ground-Missiles, flight goes RTB.

Defined in:

FLIGHTGROUP

Parameter:

#boolean switch

If true or nil, flight goes RTB. If false, turn this off.

Return value:

self

Set if aircraft is not allowed to use afterburner.

Defined in:

FLIGHTGROUP

Return value:

self

Set if group is ready for taxi/takeoff if controlled by a FLIGHTCONTROL.

Defined in:

FLIGHTGROUP

Parameters:

#boolean ReadyTO

If true, flight is ready for takeoff.

#number Delay

Delay in seconds before value is set. Default 0 sec.

Return value:

self

Set if aircraft is VTOL capable.

Unfortunately, there is no DCS way to determine this via scripting.

Defined in:

FLIGHTGROUP

Return value:

self

Start an uncontrolled group.

Defined in:

FLIGHTGROUP

Parameter:

#number delay

(Optional) Delay in seconds before the group is started. Default is immediately.

Return value:

self

Status update.

Defined in:

FLIGHTGROUP

Check if flight is done, i.e.

  • passed the final waypoint,
  • no current task
  • no current mission
  • number of remaining tasks is zero
  • number of remaining missions is zero

Defined in:

FLIGHTGROUP

Parameters:

#number delay

Delay in seconds.

#number waittime

Time to wait if group is done.

Check if group got stuck.

This overwrites the OPSGROUP function. Here we only check if stuck whilst taxiing.

Defined in:

FLIGHTGROUP

Parameter:

#boolean Despawn

If true, despawn group if stuck.

Return value:

#number:

Time in seconds the group got stuck or nil if not stuck.

Function called when flight has reached the holding point.

Defined in:

FLIGHTGROUP

Parameters:

Group object.

#FLIGHTGROUP flightgroup

Flight group object.

Create player menu.

Defined in:

FLIGHTGROUP

Parameter:

#table rootmenu

ATC root menu table.

Function called when flight finished refuelling.

Defined in:

FLIGHTGROUP

Parameters:

Group object.

#FLIGHTGROUP flightgroup

Flight group object.

Function called when flight finished waiting.

Defined in:

FLIGHTGROUP

Parameters:

Group object.

#FLIGHTGROUP flightgroup

Flight group object.

Get the generalized attribute of a group.

Defined in:

FLIGHTGROUP

Return value:

#string:

Generalized attribute of the group.

Get distance to parking spot.

Takes extra care of ships.

Defined in:

FLIGHTGROUP

Parameters:

Reference coordinate.

Return value:

#number:

Distance to parking spot in meters.

Size of the bounding box of a DCS object derived from the DCS descriptor table.

If boundinb box is nil, a size of zero is returned.

Defined in:

FLIGHTGROUP

Parameter:

DCS#Object DCSobject

The DCS object for which the size is needed.

Return values:

#number:

Max size of object in meters (length (x) or width (z) components not including height (y)).

#number:

Length (x component) of size.

#number:

Height (y component) of size.

#number:

Width (z component) of size.

Get onboard number.

Defined in:

FLIGHTGROUP

Parameter:

#string unitname

Name of the unit.

Return value:

#string:

Modex.

Get player data.

Defined in:

FLIGHTGROUP

Return value:

Player data.

Returns the unit of a player and the player name.

If the unit does not belong to a player, nil is returned.

Defined in:

FLIGHTGROUP

Parameter:

#string _unitName

Name of the player unit.

Return values:

Unit of player or nil.

#string:

Name of the player or nil.

Get the proper terminal type based on generalized attribute of the group.

Defined in:

FLIGHTGROUP

Parameters:

Generlized attibute of unit.

#number _category

Airbase category.

Return value:

Terminal type for this group.

Initialize group parameters.

Also initializes waypoints if self.waypoints is nil.

Defined in:

FLIGHTGROUP

Parameter:

#table Template

Template used to init the group. Default is self.template.

Return value:

self

Init player data.

Defined in:

FLIGHTGROUP

Parameter:

#string PlayerName

Player name.

Return value:

Player data.

Checks if a group has a human player.

Defined in:

FLIGHTGROUP

Parameter:

Aircraft group.

Return value:

#boolean:

If true, human player inside group.

Checks if a human player sits in the unit.

Defined in:

FLIGHTGROUP

Parameter:

Aircraft unit.

Return value:

#boolean:

If true, human player inside the unit.

Land at an airbase.

Defined in:

FLIGHTGROUP

Parameters:

Airbase where the group shall land.

#number SpeedTo

Speed used for travelling from current position to holding point in knots.

#number SpeedHold

Holding speed in knots.

#number SpeedLand

Landing speed in knots. Default 170 kts.

Player mark parking.

Defined in:

FLIGHTGROUP

Player menu not implemented.

Defined in:

FLIGHTGROUP

Parameter:

#string groupname

Name of the flight group.

Function called when flight is on final.

Defined in:

FLIGHTGROUP

Parameters:

Group object.

#FLIGHTGROUP flightgroup

Flight group object.

Player status.

Defined in:

FLIGHTGROUP

Player set skill.

Defined in:

FLIGHTGROUP

Parameter:

#string Skill

Skill.

Player set subtitles.

Defined in:

FLIGHTGROUP

Function called when flight has reached the holding point.

Defined in:

FLIGHTGROUP

Parameters:

Group object.

#FLIGHTGROUP flightgroup

Flight group object.

Set parking spot of element.

Defined in:

FLIGHTGROUP

Parameters:

The element.

Set parking spot of element to free

Defined in:

FLIGHTGROUP

Parameter:

The element.

Update menu.

Defined in:

FLIGHTGROUP

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the FLIGHTGROUP and all its event handlers.

Defined in:

FLIGHTGROUP

Parameter:

#number delay

Delay in seconds.

On after "Airborne" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Arrived" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Cruising" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Dead" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Disengage" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Set#SET_UNIT TargetUnitSet

On after "ElementAirborne" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementArrived" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

The airbase, where the element arrived.

The Parking spot the element has.

On after "ElementDead" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementDestroyed" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementEngineOn" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementLanded" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

The airbase if applicable or nil.

On after "ElementParking" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementSpawned" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementTakeoff" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

The airbase if applicable or nil.

On after "ElementTaxiing" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "EngageTarget" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#table Target

Target object. Can be a UNIT, STATIC, GROUP, SET_UNIT or SET_GROUP object.

On after "FuelCritical" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "FuelLow" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Holding" event.

Flight arrived at the holding point.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LandAt" event.

Order helicopter to land at a specific point.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The coordinate where to land. Default is current position.

#number Duration

The duration in seconds to remain on ground. Default nil = forever.

On after "LandAtAirbase" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

On after "Landed" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase the flight landed.

On after "LandedAt" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Landing" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "OutOfMissilesAA" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "OutOfMissilesAG" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Parking" event.

Add flight to flightcontrol of airbase.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "RTB" event.

Order flight to hold at an airbase and wait for signal to land.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

#number SpeedTo

Speed used for traveling from current position to holding point in knots. Default 75% of max speed.

#number SpeedHold

Holding speed in knots. Default 250 kts.

#number SpeedLand

Landing speed in knots. Default 170 kts.

On after "Refuel" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The coordinate.

On after "Refueled" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Spawned" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Takeoff" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase the flight landed.

On after "Taxiing" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "UpdateRoute" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Next waypoint index. Default is the one coming after that one that has been passed last.

#number N

Waypoint Max waypoint index to be included in the route. Default is the final waypoint.

On after "Wait" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Duration

Duration how long the group will be waiting in seconds. Default nil (=forever).

#number Altitude

Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.

#number Speed

Speed in knots. Default 250 kts for airplanes and 20 kts for helos.

On before "LandAt" event.

Check we have a helo group.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The coordinate where to land. Default is current position.

#number Duration

The duration in seconds to remain on ground. Default 600 sec (10 min).

On before "LandAtAirbase" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

On before "RTB" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The airbase to hold at.

#number SpeedTo

Speed used for travelling from current position to holding point in knots.

#number SpeedHold

Holding speed in knots.

On before "UpdateRoute" event.

Update route of group, e.g after new waypoints and/or waypoint tasks have been added.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Next waypoint index. Default is the one coming after that one that has been passed last.

#number N

Waypoint Max waypoint index to be included in the route. Default is the final waypoint.

Return value:

#boolean:

Transision allowed?

On before "Wait" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Duration

Duration how long the group will be waiting in seconds. Default nil (=forever).

#number Altitude

Altitude in feet. Default 10,000 ft for airplanes and 1,000 feet for helos.

#number Speed

Speed in knots. Default 250 kts for airplanes and 20 kts for helos.

Field(s)

#table FLIGHTGROUP.Players

FLIGHTGROUP players.

#number FLIGHTGROUP.RTBRecallCount

Number that counts RTB calls.

#number FLIGHTGROUP.Tholding

Abs. mission time stamp when the group reached the holding point.

#number FLIGHTGROUP.Tparking

Abs. mission time stamp when the group was spawned uncontrolled and is parking.

#string FLIGHTGROUP.actype

Type name of the aircraft.

#boolean FLIGHTGROUP.ai

If true, flight is purely AI. If false, flight contains at least one human player.

Ops.Airboss#AIRBOSS FLIGHTGROUP.airboss

The airboss handling this group.

Ops.OpsGroup#OPSGROUP.Ammo FLIGHTGROUP.ammo

Ammunition data. Number of Guns, Rockets, Bombs, Missiles.

#number FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

#string FLIGHTGROUP.controlstatus

Flight control status.

FLIGHTGROUP.currbase

Set current airbase.

#boolean FLIGHTGROUP.despawnAfterHolding

If true, group is despawned after reaching the holding point.

#boolean FLIGHTGROUP.despawnAfterLanding

If true, group is despawned after landed at an airbase.

FLIGHTGROUP.destbase

Set the destination base.

OPS.FlightControl#FLIGHTCONTROL FLIGHTGROUP.flightcontrol

The flightcontrol handling this group.

#boolean FLIGHTGROUP.fuelcritical

Fuel critical switch.

#boolean FLIGHTGROUP.fuelcriticalrtb

RTB on critical fuel switch.

#number FLIGHTGROUP.fuelcriticalthresh

Critical fuel threshold in percent.

#boolean FLIGHTGROUP.fuellow

Fuel low switch.

#boolean FLIGHTGROUP.fuellowrtb

RTB on low fuel switch.

#number FLIGHTGROUP.fuellowthresh

Low fuel threshold in percent.

#boolean FLIGHTGROUP.groupinitialized

Init done.

#number FLIGHTGROUP.holdtime

Time [s] flight is holding before going on final. Set to nil for indefinitely.

#boolean FLIGHTGROUP.isDead

Not dead or destroyed yet.

FLIGHTGROUP.isHelo

Helo group.

#boolean FLIGHTGROUP.isReadyTO

Flight is ready for takeoff. This is for FLIGHTCONTROL.

#boolean FLIGHTGROUP.jettisonEmptyTanks

Allow (true) or disallow (false) AI to jettison empty fuel tanks.

#boolean FLIGHTGROUP.jettisonWeapons

Allow (true) or disallow (false) AI to jettison weapons if in danger.

FLIGHTGROUP.lid

Set some string id for output to DCS.log file.

#table FLIGHTGROUP.menu

F10 radio menu.

#boolean FLIGHTGROUP.prohibitAB

Disallow (true) or allow (false) AI to use the afterburner.

#number FLIGHTGROUP.rangemax

Max range in meters.

#number FLIGHTGROUP.refueltype

The refueling system type (0=boom, 1=probe), if the group can refuel from a tanker.

FLIGHTGROUP.speedCruise

Cruise speed: 70% of max speed but within limit.

FLIGHTGROUP.speedMax

Max speed in km/h.

#number FLIGHTGROUP.tankertype

The refueling system type (0=boom, 1=probe), if the group is a tanker.

FLIGHTGROUP.timerCheckZone

Start check zone timer.

FLIGHTGROUP.timerQueueUpdate

Start queue update timer.

FLIGHTGROUP.timerStatus

Start the status monitoring.

#string FLIGHTGROUP.version

FLIGHTGROUP class version.

#table FLIGHTGROUP.waypoints

Waypoints

FLIGHTGROUP.waypoints0

Template waypoints.

Function(s)

Activate a late activated group.

Defined in:

Parameter:

#number delay

(Optional) Delay in seconds before the group is activated. Default is immediately.

Return value:

self

Add a zone that triggers and event if the group enters or leaves any of the zones.

Defined in:

Parameter:

Core.Zone#ZONE CheckZone

Zone to check.

Return value:

self

Add mission to queue.

Defined in:

Parameter:

Mission for this group.

Return value:

self

Create a cargo transport assignment.

Defined in:

Parameter:

The troop transport assignment.

Return value:

self

Add a scheduled task.

Defined in:

Parameters:

#table task

DCS task table structure.

#string clock

Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.

#string description

Brief text describing the task, e.g. "Attack SAM".

#number prio

Priority of the task.

#number duration

Duration before task is cancelled in seconds counted after task started. Default never.

Return value:

The task structure.

Add an enroute task.

Defined in:

Parameter:

#table task

DCS task table structure.

Add a waypoint task.

Defined in:

Parameters:

#table task

DCS task table structure.

where the task is executed. Default is the at next waypoint.

#string description

Brief text describing the task, e.g. "Attack SAM".

#number prio

Priority of the task. Number between 1 and 100. Default is 50.

#number duration

Duration before task is cancelled in seconds counted after task started. Default never.

Return value:

The task structure.

Add a weapon range for ARTY auftrag.

Defined in:

Parameters:

#number RangeMin

Minimum range in nautical miles. Default 0 NM.

#number RangeMax

Maximum range in nautical miles. Default 10 NM.

#number BitType

Bit mask of weapon type for which the given min/max ranges apply. Default is ENUMS.WeaponFlag.Auto, i.e. for all weapon types.

Return value:

self

Add weight to the internal cargo of an element of the group.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#number Weight

Cargo weight to be added in kg.

Check if the group can in principle be carrier of a cargo group.

This checks the max cargo capacity of the group but not how much cargo is already loaded (if any). Note that the cargo group cannot be split into units, i.e. the largest cargo bay of any element of the group must be able to load the whole cargo group in one piece.

Defined in:

Parameter:

Cargo data, which needs a carrier.

Return value:

#boolean:

If true, there is an element of the group that can load the whole cargo group.

Cancel all missions in mission queue that are not already done or cancelled.

Defined in:

Check if task description is unique.

Defined in:

Parameter:

#string description

Task destription

Return value:

#boolean:

If true, no other task has the same description.

Clear DCS tasks.

Defined in:

Return value:

self

Clear waypoints.

Defined in:

Parameters:

#number IndexMin

Clear waypoints up to this min WP index. Default 1.

#number IndexMax

Clear waypoints up to this max WP index. Default #self.waypoints.

Count elements of the group.

Defined in:

Parameter:

#table States

(Optional) Only count elements in specific states. Can also be a single state passed as #string.

Return value:

#number:

Number of elements.

Count remaining missons.

Defined in:

Return value:

#number:

Number of missions to be done.

Count the number of tasks that still pending in the queue.

Defined in:

Return values:

#number:

Total number of tasks remaining.

#number:

Number of SCHEDULED tasks remaining.

#number:

Number of WAYPOINT tasks remaining.

Count remaining cargo transport assignments.

Defined in:

Return value:

#number:

Number of unfinished transports in the queue.

Count remaining waypoint tasks.

Defined in:

Parameters:

#number uid

Unique waypoint ID.

id

Return value:

#number:

Number of waypoint tasks.

Deactivate the group.

Group will be respawned in late activated state.

Defined in:

Parameter:

#number delay

(Optional) Delay in seconds before the group is deactivated. Default is immediately.

Return value:

self

Delete a cargo transport assignment from the cargo queue.

Defined in:

Parameter:

Cargo transport do be deleted.

Return value:

self

Despawn the group.

The whole group is despawned and a "Remove Unit" event is generated for all current units of the group. If no Remove Unit event should be generated, the second optional parameter needs to be set to true. If this group belongs to an AIRWING, BRIGADE or FLEET, it will be added to the warehouse stock if the NoEventRemoveUnit parameter is false or nil.

Defined in:

Parameters:

#number Delay

Delay in seconds before the group will be despawned. Default immediately.

#boolean NoEventRemoveUnit

If true, no event "Remove Unit" is generated.

Return value:

self

Despawn an element/unit of the group.

Defined in:

Parameters:

The element that will be despawned.

#number Delay

Delay in seconds before the element will be despawned. Default immediately.

#boolean NoEventRemoveUnit

If true, no event "Remove Unit" is generated.

Return value:

self

Despawn a unit of the group.

A "Remove Unit" event is generated by default.

Defined in:

Parameters:

#string UnitName

Name of the unit

#number Delay

Delay in seconds before the group will be despawned. Default immediately.

#boolean NoEventRemoveUnit

If true, no event "Remove Unit" is generated.

Return value:

self

Destroy group.

The whole group is despawned and a Unit Lost for aircraft or Dead event for ground/naval units is generated for all current units.

Defined in:

Parameter:

#number Delay

Delay in seconds before the group will be destroyed. Default immediately.

Return value:

self

Destroy a unit of the group.

A Unit Lost for aircraft or Dead event for ground/naval units is generated.

Defined in:

Parameters:

#string UnitName

Name of the unit which should be destroyed.

#number Delay

Delay in seconds before the group will be destroyed. Default immediately.

Return value:

self

Find carrier for cargo by evaluating the free cargo bay storage.

Defined in:

Parameter:

#number Weight

Weight of cargo in kg.

Return value:

Carrier able to transport the cargo.

Get 2D distance to a coordinate.

Defined in:

Parameter:

Can also be a DCS#Vec2 or DCS#Vec3.

Return value:

#number:

Distance in meters.

Get current Alarm State of the group.

Defined in:

Return value:

#number:

Current Alarm State.

Set current altitude.

Defined in:

Return value:

#number:

Altitude in feet.

Get inital amount of ammunition.

Defined in:

Return value:

Initial ammo table.

Get the number of shells a unit or group currently has.

For a group the ammo count of all units is summed up.

Defined in:

Parameter:

The element.

Return value:

Ammo data.

Get total amount of ammunition of the whole group.

Defined in:

Return value:

Ammo data.

Get the number of shells a unit or group currently has.

For a group the ammo count of all units is summed up.

Defined in:

Parameters:

The unit object.

#boolean display

Display ammo table as message to all. Default false.

Return value:

Ammo data.

Get generalized attribute.

Defined in:

Return value:

#string:

Generalized attribute.

Get current TACAN parameters.

Defined in:

Return value:

TACAN beacon.

Get callsign of the first element alive.

Defined in:

Parameters:

#boolean ShortCallsign

If true, append major flight number only

#boolean Keepnumber

(Player only) If true, and using a customized callsign in the #GROUP name after an #-sign, use all of that information.

#table CallsignTranslations

(optional) Translation table between callsigns

Return value:

#string:

Callsign name, e.g. Uzi11, or "Ghostrider11".

Get all groups currently loaded as cargo.

Defined in:

Parameter:

#string CarrierName

(Optional) Only return cargo groups loaded into a particular carrier unit.

Return value:

#table:

Cargo ops groups.

Get OPSGROUPs in the cargo bay.

Defined in:

Return value:

#table:

Cargo OPSGROUPs.

Get coalition.

Defined in:

Return value:

#number:

Coalition side of carrier.

Get current coordinate of the group.

If the current position cannot be determined, the last known position is returned.

Defined in:

Parameters:

#boolean NewObject

Create a new coordiante object.

#string UnitName

(Optional) Get position of a specifc unit of the group. Default is the first existing unit in the group.

Return value:

The coordinate (of the first unit) of the group.

Get a coordinate, which is in weapon range.

Defined in:

Parameters:

Core.Point#COORDINATE TargetCoord

Coordinate of the target.

#number WeaponBitType

Weapon type.

Reference coordinate.

Return value:

Coordinate in weapon range

Get default cruise speed.

Defined in:

Return value:

#number:

Cruise altitude in feet.

Get DCS GROUP object.

Defined in:

Return value:

DCS group object.

Get DCS group object.

Defined in:

Return value:

DCS group object.

Get DCS GROUP object.

Defined in:

Parameter:

#number UnitNumber

Number of the unit in the group. Default first unit.

Return value:

DCS group object.

Get DCS units.

Defined in:

Return value:

#list<DCS#Unit>:

DCS units.

Get set of detected groups.

Defined in:

Return value:

Set of detected groups.

Get set of detected units.

Defined in:

Return value:

Set of detected units.

Get distance to waypoint.

Defined in:

Parameter:

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Distance in meters.

Get current EPLRS state.

Defined in:

Return value:

#boolean:

If true, EPLRS is on.

Get the first element of a group, which is alive.

Defined in:

Return value:

The element or #nil if no element is alive any more.

Get the element of a group.

Defined in:

Parameter:

#string unitname

Name of unit.

Return value:

The element.

Get the bounding box of the element.

Defined in:

Parameter:

#string UnitName

Name of unit.

Return value:

Bounding box polygon zone.

Get the loading zone of the element.

Defined in:

Parameter:

#string UnitName

Name of unit.

Return value:

Bounding box polygon zone.

Get the unloading zone of the element.

Defined in:

Parameter:

#string UnitName

Name of unit.

Return value:

Bounding box polygon zone.

Get current emission state.

Defined in:

Return value:

#boolean:

If true, emission is on.

Returns the currently expected speed.

Defined in:

Return value:

#number:

Expected speed in m/s.

Get free cargo bay weight.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Free cargo bay in kg.

Get max weight of cargo (group) this group can load.

This is the largest free cargo bay of any (not dead) element of the group. Optionally, you can calculate the current max weight possible, which accounts for currently loaded cargo.

Defined in:

Parameter:

#boolean Currently

If true, calculate the max weight currently possible in case there is already cargo loaded.

Return value:

#number:

Max weight in kg.

Get relative free cargo bay in percent.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Free cargo bay in percent.

Get MOOSE GROUP object.

Defined in:

Return value:

Moose group object.

Get current heading of the group or (optionally) of a specific unit of the group.

Defined in:

Parameter:

#string UnitName

(Optional) Get heading of a specific unit of the group. Default is from the first existing unit in the group.

Return value:

#number:

Current heading of the group in degrees.

Get highest threat.

Defined in:

Return values:

The highest threat unit.

#number:

Threat level of the unit.

Get LASER code.

Defined in:

Return value:

#number:

Current Laser code.

Get current LASER coordinate, i.e.

where the beam is pointing at if the LASER is on.

Defined in:

Return value:

Current position where the LASER is pointing at.

Get current target of the LASER.

This can be a STATIC or UNIT object.

Defined in:

Return value:

Current target object.

Returns the absolute total life points of the group.

Defined in:

Parameter:

(Optional) Only get life points of this element.

Return values:

#number:

Life points, i.e. the sum of life points over all units in the group (unless a specific element was passed).

#number:

Initial life points.

Get mission by its id (auftragsnummer).

Defined in:

Parameter:

#number id

Mission id (auftragsnummer).

Return value:

The mission.

Get mission by its task id.

Defined in:

Parameter:

#number taskid

The id of the (waypoint) task of the mission.

Return value:

The mission.

Get current mission.

Defined in:

Return value:

The current mission or nil.

Get the group name.

Defined in:

Return value:

#string:

Group name.

Get number of elements alive.

Defined in:

Parameter:

#string status

(Optional) Only count number, which are in a special status.

Return value:

#number:

Number of elements.

Get coordinate of next waypoint of the group.

Defined in:

Parameter:

#boolean cyclic

If true, return first waypoint if last waypoint was reached.

Return value:

Coordinate of the next waypoint.

Get cargo transport assignment from the cargo queue by its unique ID.

Defined in:

Parameter:

#number uid

Unique ID of the transport

Return value:

Get current orientation of the group.

Defined in:

Parameter:

#string UnitName

(Optional) Get orientation of a specific unit of the group. Default is the first existing unit of the group.

Return values:

Orientation X parallel to where the "nose" is pointing.

Orientation Y pointing "upwards".

Orientation Z perpendicular to the "nose".

Get current "X" orientation of the first unit in the group.

Defined in:

Parameter:

#string UnitName

(Optional) Get orientation of a specific unit of the group. Default is the first existing unit of the group.

Return value:

Orientation X parallel to where the "nose" is pointing.

Get current ROE of the group.

Defined in:

Return value:

#number:

Current ROE.

Get current ROT of the group.

Defined in:

Return value:

#number:

Current ROT.

Get current Radio frequency and modulation.

Defined in:

Return values:

#number:

Radio frequency in MHz or nil.

#number:

Radio modulation or nil.

#boolean:

If true, the radio is on. Otherwise, radio is turned off.

Get default cruise speed.

Defined in:

Return value:

#number:

Cruise speed (>0) in knots.

Returns a non-zero speed to the next waypoint (even if the waypoint speed is zero).

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed to next waypoint (>0) in knots.

Get current TACAN parameters.

Defined in:

Return values:

#number:

TACAN channel.

#string:

TACAN Morse code.

#string:

TACAN band ("X" or "Y").

#boolean:

TACAN is On (true) or Off (false).

#string:

UnitName Name of the unit acting as beacon.

Get task by its id.

Defined in:

Parameters:

#number id

Task id.

#string status

(Optional) Only return tasks with this status, e.g. OPSGROUP.TaskStatus.SCHEDULED.

Return value:

The task or nil.

Get the currently executed task if there is any.

Defined in:

Return value:

Current task or nil.

Get the unfinished waypoint tasks

Defined in:

Parameter:

#number id

Unique waypoint ID.

Return value:

#table:

Table of tasks. Table could also be empty {}.

Get highest detected threat.

Detection must be turned on. The threat level is a number between 0 and 10, where 0 is the lowest, e.g. unarmed units.

Defined in:

Parameters:

#number ThreatLevelMin

Only consider threats with level greater or equal to this number. Default 1 (so unarmed units wont be considered).

#number ThreatLevelMax

Only consider threats with level smaller or queal to this number. Default 10.

Return values:

Highest threat unit detected by the group or nil if no threat is currently detected.

#number:

Threat level.

Get time to waypoint based on current velocity.

Defined in:

Parameter:

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Time in seconds. If velocity is 0

Get MOOSE UNIT object.

Defined in:

Parameter:

#number UnitNumber

Number of the unit in the group. Default first unit.

Return value:

The MOOSE UNIT object.

Get relative used (loaded) cargo bay in percent.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Used cargo bay in percent.

Get current 2D position vector of the group.

Defined in:

Parameter:

#string UnitName

(Optional) Get position of a specifc unit of the group. Default is the first existing unit in the group.

Return value:

Vector with x,y components.

Get current 3D position vector of the group.

Defined in:

Parameter:

#string UnitName

(Optional) Get position of a specifc unit of the group. Default is the first existing unit in the group.

Return value:

Vector with x,y,z components.

Get current velocity of the group.

Defined in:

Parameter:

#string UnitName

(Optional) Get velocity of a specific unit of the group. Default is from the first existing unit in the group.

Return value:

#number:

Velocity in m/s.

Get waypoint.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

Waypoint table.

Get the waypoint from its unique ID.

Defined in:

Parameter:

#number uid

Waypoint unique ID.

Return value:

Waypoint data.

Get the waypoint from its index.

Defined in:

Parameter:

#number index

Waypoint index.

Return value:

Waypoint data.

Get waypoint coordinates.

Defined in:

Parameter:

#number index

Waypoint index.

Return value:

Coordinate of the next waypoint.

Get current waypoint.

Defined in:

Return value:

Current waypoint table.

Get current waypoint UID.

Defined in:

Return value:

#number:

Current waypoint UID.

Get final waypoint.

Defined in:

Return value:

Final waypoint table.

Get unique ID of waypoint given its index.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Unique ID.

Get the waypoint index (its position in the current waypoints table).

Defined in:

Parameter:

#number uid

Waypoint unique ID.

Return value:

Waypoint data.

Get waypoint index after waypoint with given ID.

So if the waypoint has index 3 it will return 4.

Defined in:

Parameter:

#number uid

Unique ID of the waypoint. Default is new waypoint index after the last current one.

Return value:

#number:

Index after waypoint with given ID.

Get current waypoint index.

This is the index of the last passed waypoint.

Defined in:

Return value:

#number:

Current waypoint index.

Get next waypoint index.

Defined in:

Parameters:

#boolean cyclic

If true, return first waypoint if last waypoint was reached. Default is patrol ad infinitum value set.

#number i

Waypoint index from which the next index is returned. Default is the last waypoint passed.

Return value:

#number:

Next waypoint index.

Get next waypoint.

Defined in:

Parameter:

#boolean cyclic

If true, return first waypoint if last waypoint was reached.

Return value:

Next waypoint table.

Get waypoint speed.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed set at waypoint in knots.

Get unique ID of waypoint.

Defined in:

Parameter:

The waypoint data table.

Return value:

#number:

Unique ID.

Get the waypoint UID from its index, i.e.

its current position in the waypoints table.

Defined in:

Parameter:

#number index

Waypoint index.

Return value:

#number:

Unique waypoint ID.

Get the waypoints.

Defined in:

Return value:

#table:

Table of all waypoints.

Get weapon data.

Defined in:

Parameter:

#number BitType

Type of weapon.

Return value:

Weapon range data.

Get weight of the internal cargo the group is carriing right now.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Cargo weight in kg.

Get max weight of the internal cargo the group can carry.

Optionally, the max cargo weight of a specific unit can be requested.

Defined in:

Parameter:

#string UnitName

Name of the unit. Default is of the whole group.

Return value:

#number:

Max cargo weight in kg. This does not include any cargo loaded or reserved currently.

Get total weight of the group including cargo.

Optionally, the total weight of a specific unit can be requested.

Defined in:

Parameters:

#string UnitName

Name of the unit. Default is of the whole group.

#boolean IncludeReserved

If false, cargo weight that is only reserved is not counted. By default (true or nil), the reserved cargo is included.

Return value:

#number:

Total weight in kg.

Check if an element of the group has line of sight to a coordinate.

Defined in:

Parameters:

The position to which we check the LoS. Can also be a DCS#Vec3.

The (optinal) element. If not given, all elements are checked.

DCS#Vec3 OffsetElement

Offset vector of the element.

DCS#Vec3 OffsetCoordinate

Offset vector of the coordinate.

Return value:

#boolean:

If true, there is line of sight to the specified coordinate.

Check if this group has passed its final waypoint.

Defined in:

Return value:

#boolean:

If true, this group has passed the final waypoint.

Returns true if the DCS controller currently has a task.

Defined in:

Return value:

#boolean:

True or false if the controller has a task. Nil if no controller.

Check if a given coordinate is in weapon range.

Defined in:

Parameters:

Core.Point#COORDINATE TargetCoord

Coordinate of the target.

#number WeaponBitType

Weapon type.

Reference coordinate.

Return value:

#boolean:

If true, coordinate is in range.

Check if group is activated.

Defined in:

Return value:

#boolean:

If true, the group exists or false if the group does not exist. If nil, the DCS group could not be found.

Check if group is alive.

Defined in:

Return value:

#boolean:

true if group is exists and is activated, false if group is exist but is NOT activated. nil otherwise, e.g. the GROUP object is nil or the group is not spawned yet.

Check if this is a ARMYGROUP.

Defined in:

Return value:

#boolean:

If true, this is a ground group.

Check if awaiting a transport lift.

Defined in:

Parameter:

(Optional) The transport.

Return value:

#boolean:

If true, group is awaiting transport lift..

Check if the group is currently boarding a carrier.

Defined in:

Parameter:

#string CarrierGroupName

(Optional) Additionally check if group is boarding this particular carrier group.

Return value:

#boolean:

If true, group is boarding.

Check if the group is currently busy doing something.

  • Boarding
  • Rearming
  • Returning
  • Pickingup, Loading, Transporting, Unloading
  • Engageing

Defined in:

Return value:

#boolean:

If true, group is busy.

Check if the group is assigned as cargo.

Defined in:

Parameter:

#boolean CheckTransport

If true or nil, also check if cargo is associated with a transport assignment. If not, we consider it not cargo.

Return value:

#boolean:

If true, group is cargo.

Check if the group is a carrier.

Defined in:

Return value:

#boolean:

If true, group is a carrier.

Check if group is dead.

Could be destroyed or despawned. FSM state of dead group is InUtero though.

Defined in:

Return value:

#boolean:

If true, all units/elements of the group are dead.

Check if group was destroyed.

Defined in:

Return value:

#boolean:

If true, all units/elements of the group were destroyed.

Check if the group is engaging another unit or group.

Defined in:

Return value:

#boolean:

If true, group is engaging.

Check if group is exists.

Defined in:

Return value:

#boolean:

If true, the group exists or false if the group does not exist. If nil, the DCS group could not be found.

Check if this is a FLIGHTGROUP.

Defined in:

Return value:

#boolean:

If true, this is an airplane or helo group.

Check if group is in state in utero.

Note that dead groups are also in utero but will return false here.

Defined in:

Return value:

#boolean:

If true, group is not spawned yet.

Check if group is currently inside a zone.

Defined in:

Parameter:

The zone.

Return value:

#boolean:

If true, group is in this zone

Check if the group has currently switched a LASER on.

Defined in:

Return value:

#boolean:

If true, LASER of the group is on.

Check if this group is currently "late activated" and needs to be "activated" to appear in the mission.

Defined in:

Return value:

#boolean:

Is this the group late activated?

Check if the group is currently loaded into a carrier.

Defined in:

Parameter:

#string CarrierGroupName

(Optional) Additionally check if group is loaded into a particular carrier group(s).

Return value:

#boolean:

If true, group is loaded.

Check if the group is loading cargo.

Defined in:

Return value:

#boolean:

If true, group is loading.

Check if a given mission is already in the queue.

Defined in:

Parameter:

the mission to check

Return value:

#boolean:

If true, the mission is in the queue.

Check if a given mission type is already in the queue.

Defined in:

Parameter:

#string MissionType

MissionType Type of mission.

Return value:

#boolean:

If true, the mission type is in the queue.

Check if this is a NAVYGROUP.

Defined in:

Return value:

#boolean:

If true, this is a ship group.

Check if the group is not cargo.

Defined in:

Parameter:

#boolean CheckTransport

If true or nil, also check if cargo is associated with a transport assignment. If not, we consider it not cargo.

Return value:

#boolean:

If true, group is not cargo.

Check if the group is not a carrier yet.

Defined in:

Return value:

#boolean:

If true, group is not a carrier.

Check if group is currently on a mission.

Defined in:

Parameter:

#number MissionUID

(Optional) Check if group is currently on a mission with this UID. Default is to check for any current mission.

Return value:

#boolean:

If true, group is currently on a mission.

Check if the group is completely out of ammo.

Defined in:

Return value:

#boolean:

If true, group is out-of-ammo.

Check if the group is out of bombs.

Defined in:

Return value:

#boolean:

If true, group is out of bombs.

Check if the group is out of guns.

Defined in:

Return value:

#boolean:

If true, group is out of guns.

Check if the group is out of missiles.

Defined in:

Return value:

#boolean:

If true, group is out of missiles.

Check if the group is out of torpedos.

Defined in:

Return value:

#boolean:

If true, group is out of torpedos.

Check if the group is picking up cargo.

Defined in:

Return value:

#boolean:

If true, group is picking up.

Check if the group is currently rearming or on its way to the rearming place.

Defined in:

Return value:

#boolean:

If true, group is rearming.

Check if the group is retreated (has reached its retreat zone).

Defined in:

Return value:

#boolean:

If true, group is retreated.

Check if the group is currently retreating or retreated.

Defined in:

Return value:

#boolean:

If true, group is retreating or retreated.

Check if the group is currently returning to a zone.

Defined in:

Return value:

#boolean:

If true, group is returning.

Check if group is in state spawned.

Defined in:

Return value:

#boolean:

If true, group is spawned.

Check if FSM is stopped.

Defined in:

Return value:

#boolean:

If true, FSM state is stopped.

Check if target is detected.

Defined in:

Parameter:

The target object.

Return value:

#boolean:

If true, target was detected.

Check if the group is transporting cargo.

Defined in:

Return value:

#boolean:

If true, group is transporting.

Check if this group is currently "uncontrolled" and needs to be "started" to begin its route.

Defined in:

Return value:

#boolean:

If true, this group uncontrolled.

Check if the group is unloading cargo.

Defined in:

Return value:

#boolean:

If true, group is unloading.

Check if group is currently waiting.

Defined in:

Return value:

#boolean:

If true, group is currently waiting.

Set detection on or off.

If detection is on, detected targets of the group will be evaluated and FSM events triggered.

Defined in:

Parameters:

The target object.

#boolean KnowType

Make type known.

#boolean KnowDist

Make distance known.

#number Delay

Delay in seconds before the target is known.

Return value:

self

Mark waypoints on F10 map.

Defined in:

Parameter:

#number Duration

Duration in seconds how long the waypoints are displayed before they are automatically removed. Default is that they are never removed.

Return value:

self

Triggers the FSM event "MissionCancel".

Defined in:

Parameter:

The mission.

Triggers the FSM event "MissionDone".

Defined in:

Parameter:

The mission.

Triggers the FSM event "MissionExecute".

Defined in:

Parameter:

The mission.

Triggers the FSM event "MissionStart".

Defined in:

Parameter:

The mission.

Create a new OPSGROUP class object.

Defined in:

Parameter:

The GROUP object. Can also be given by its group name as #string.

Return value:

self

Create a scheduled task.

Defined in:

Parameters:

#table task

DCS task table structure.

#string clock

Mission time when task is executed. Default in 5 seconds. If argument passed as #number, it defines a relative delay in seconds.

#string description

Brief text describing the task, e.g. "Attack SAM".

#number prio

Priority of the task.

#number duration

Duration before task is cancelled in seconds counted after task started. Default never.

Return value:

The task structure.

On After "DetectedGroup" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Detected Group.

On After "DetectedGroupKnown" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Known detected group.

On After "DetectedGroupLost" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Lost detected group.

On After "DetectedGroupNew" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Newly detected group.

On After "DetectedUnit" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Detected Unit.

On After "DetectedUnitKnown" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Known detected unit.

On After "DetectedUnitLost" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Lost detected unit.

On After "DetectedUnitNew" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Newly detected unit.

On after "HoverEnd" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "HoverStart" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "MissionCancel" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionDone" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionExecute" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionStart" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "TransportCancel" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

Event function handling the birth of a unit.

Defined in:

Parameter:

Event data.

Event function handling the dead of a unit.

Defined in:

Parameter:

Event data.

Event function handling the hit of a unit.

Defined in:

Parameter:

Event data.

Event function handling the event that a unit achieved a kill.

Defined in:

Parameter:

Event data.

Event function handling when a unit is removed from the game.

Defined in:

Parameter:

Event data.

Event function handling when a unit is removed from the game.

Defined in:

Parameter:

Event data.

Push DCS task.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

Send a radio transmission via SRS Text-To-Speech.

Defined in:

Parameters:

#string Text

Text of transmission.

#number Delay

Delay in seconds before the transmission is started.

#boolean SayCallsign

If true, the callsign is prepended to the given text. Default false.

#number Frequency

Override sender frequency, helpful when you need multiple radios from the same sender. Default is the frequency set for the OpsGroup.

Return value:

self

Reduce weight to the internal cargo of an element of the group.

Defined in:

Parameters:

#string UnitName

Name of the unit.

#number Weight

Cargo weight to be reduced in kg.

Remove mission from queue.

Defined in:

Parameter:

Mission to be removed.

Return value:

self

Remove task from task queue.

Defined in:

Parameter:

The task to be removed from the queue.

Return value:

#boolean:

True if task could be removed.

Remove a waypoint.

Defined in:

Parameter:

#number wpindex

Waypoint number.

Return value:

self

Remove a waypoint with a ceratin UID.

Defined in:

Parameter:

#number uid

Waypoint UID.

Return value:

self

Remove waypoints markers on the F10 map.

Defined in:

Parameter:

#number Delay

Delay in seconds before the markers are removed. Default is immediately.

Return value:

self

Return group back to the legion it belongs to.

Group is despawned and added back to the stock.

Defined in:

Parameter:

#number Delay

Delay in seconds before the group will be despawned. Default immediately

Return value:

self

Route group along waypoints.

Defined in:

Parameters:

#table waypoints

Table of waypoints.

#number delay

Delay in seconds.

Return value:

self

Route group to mission.

Defined in:

Parameters:

The mission table.

#number delay

Delay in seconds.

Self destruction of group.

An explosion is created at the position of each element.

Defined in:

Parameters:

#number Delay

Delay in seconds. Default now.

#number ExplosionPower

(Optional) Explosion power in kg TNT. Default 100 kg.

#string ElementName

Name of the element that should be destroyed. Default is all elements.

Return value:

self

Set current altitude.

Defined in:

Parameters:

#number Altitude

Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.

#boolean Keep

If true the group will maintain that speed on passing waypoints. If nil or false the group will return to the speed as defined by their route.

RadarAlt

Return value:

self

Set max weight that each unit of the group can handle.

Defined in:

Parameters:

#number Weight

Max weight of cargo in kg the unit can carry.

#string UnitName

Name of the Unit. If not given, weight is set for all units of the group.

Return value:

self

Set that this carrier is an all aspect loader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a back loader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a front loader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a port (left side) loader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a starboard (right side) loader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is an all aspect unloader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a back unloader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a front unloader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a port (left side) unloader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a starboard (right side) unloader.

Defined in:

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Define a SET of zones that trigger and event if the group enters or leaves any of the zones.

Defined in:

Parameter:

Core.Set#SET_ZONE CheckZonesSet

Set of zones.

Return value:

self

Set the default Alarm State for the group.

This is the state gets when the group is spawned or to which it defaults back after a mission.

Defined in:

Parameter:

#number alarmstate

Alarm state of group. Default is AI.Option.Ground.val.ALARM_STATE.AUTO (0).

Return value:

self

Set default cruise altitude.

Defined in:

Parameter:

#number Altitude

Altitude in feet. Default is 10,000 ft for airplanes and 1,500 feet for helicopters.

Return value:

self

Set default callsign.

Defined in:

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number. Default 1.

Return value:

self

Set the default EPLRS for the group.

Defined in:

Parameter:

#boolean OnOffSwitch

If true, EPLRS is on by default. If false default EPLRS setting is off. If nil, default is on if group has EPLRS and off if it does not have a datalink.

Return value:

self

Set the default emission state for the group.

Defined in:

Parameter:

#boolean OnOffSwitch

If true, EPLRS is on by default. If false default EPLRS setting is off. If nil, default is on if group has EPLRS and off if it does not have a datalink.

Return value:

self

Set default formation.

Defined in:

Parameter:

#number Formation

The formation the groups flies in.

Return value:

self

Set default ICLS parameters.

Defined in:

Parameters:

#number Channel

ICLS channel. Default is 1.

#string Morse

Morse code. Default "XXX".

#string UnitName

Name of the unit acting as beacon.

#boolean OffSwitch

If true, TACAN is off by default.

Return value:

self

Set the default immortal for the group.

Defined in:

Parameter:

#boolean OnOffSwitch

If true, group is immortal by default.

Return value:

self

Set the default invisible for the group.

Defined in:

Parameter:

#boolean OnOffSwitch

If true, group is ivisible by default.

Return value:

self

Set the default ROE for the group.

This is the ROE state gets when the group is spawned or to which it defaults back after a mission.

Defined in:

Parameter:

#number roe

ROE of group. Default is ENUMS.ROE.ReturnFire.

Return value:

self

Set the default ROT for the group.

This is the ROT state gets when the group is spawned or to which it defaults back after a mission.

Defined in:

Parameter:

#number rot

ROT of group. Default is ENUMS.ROT.PassiveDefense.

Return value:

self

Set default Radio frequency and modulation.

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default radio.modulation.AM.

#boolean OffSwitch

If true, radio is OFF by default.

Return value:

self

Set default cruise speed.

Defined in:

Parameter:

#number Speed

Speed in knots.

Return value:

self

Set default TACAN parameters.

Defined in:

Parameters:

#number Channel

TACAN channel. Default is 74.

#string Morse

Morse code. Default "XXX".

#string UnitName

Name of the unit acting as beacon.

#string Band

TACAN mode. Default is "X" for ground and "Y" for airborne units.

#boolean OffSwitch

If true, TACAN is off by default.

Return value:

self

Set detection on or off.

If detection is on, detected targets of the group will be evaluated and FSM events triggered.

Defined in:

Parameter:

#boolean Switch

If true, detection is on. If false or nil, detection is off. Default is off.

Return value:

self

Disable to automatically engage detected targets.

Defined in:

Return value:

self

Enable to automatically engage detected targets.

Defined in:

Parameters:

#number RangeMax

Max range in NM. Only detected targets within this radius from the group will be engaged. Default is 25 NM.

#table TargetTypes

Types of target attributes that will be engaged. See DCS enum attributes. Default "All".

Core.Set#SET_ZONE EngageZoneSet

Set of zones in which targets are engaged. Default is anywhere.

Core.Set#SET_ZONE NoEngageZoneSet

Set of zones in which targets are not engaged. Default is nowhere.

Return value:

self

Set LASER parameters.

Defined in:

Parameters:

#number Code

Laser code. Default 1688.

#boolean CheckLOS

Check if lasing unit has line of sight to target coordinate. Default is true.

#boolean IROff

If true, then dont switch on the additional IR pointer.

#number UpdateTime

Time interval in seconds the beam gets up for moving targets. Default every 0.5 sec.

Return value:

self

Set LASER target.

Defined in:

Parameter:

The target to lase. Can also be a COORDINATE object.

Set that group is going to rearm once it runs out of ammo.

Defined in:

Return value:

self

Set that group is retreating once it runs out of ammo.

Defined in:

Return value:

self

Set that group is return to legion once it runs out of ammo.

Defined in:

Return value:

self

[GROUND, NAVAL] Set whether this group should return to its legion once all mission etc are finished.

Only for ground and naval groups. Aircraft will

Defined in:

Parameter:

#boolean Switch

If true or nil, group will return. If false, group will not return and stay where it finishes its last mission.

Return value:

self

Use SRS Simple-Text-To-Speech for transmissions.

Defined in:

Parameters:

#string PathToSRS

Path to SRS directory.

#string Gender

Gender: "male" or "female" (default).

#string Culture

Culture, e.g. "en-GB" (default).

#string Voice

Specific voice. Overrides Gender and Culture.

#number Port

SRS port. Default 5002.

#string PathToGoogleKey

Full path to the google credentials JSON file, e.g. "C:\Users\myUsername\Downloads\key.json".

#string Label

Label of the SRS comms for the SRS Radio overlay. Defaults to "ROBOT". No spaces allowed!

#number Volume

Volume to be set, 0.0 = silent, 1.0 = loudest. Defaults to 1.0

Return value:

self

Set current speed.

Defined in:

Parameters:

#number Speed

Speed in knots. Default is 70% of max speed.

#boolean Keep

If true the group will maintain that speed on passing waypoints. If nil or false the group will return to the speed as defined by their route.

#boolean AltCorrected

If true, use altitude corrected indicated air speed.

Return value:

self

Set DCS task.

Enroute tasks are injected automatically.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

Set verbosity level.

Defined in:

Parameter: