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.
  • Sophisticated task queueing system.
  • Many additional events for each element and the whole group.

Author: funkyfranky

Global(s)

Global FLIGHTGROUP

*To invent an airplane is nothing.

#FLIGHTGROUP FLIGHTGROUP

*To invent an airplane is nothing.

To build one is something. To fly is everything.* -- Otto Lilienthal


Banner Image

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:AddElementByName(unitname)

Add an element to the flight group.

FLIGHTGROUP:AddTaskEnrouteEngageTargetsInZone(ZoneRadius, TargetTypes, Priority)

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

FLIGHTGROUP:AddWaypoint(coordinate, speed, wpnumber, updateroute)

Add an AIR 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: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: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:GetRadio()

Get current Radio frequency and modulation.

FLIGHTGROUP:InitWaypoints(waypoints)

Initialize Mission Editor waypoints.

FLIGHTGROUP:IsAirborne()

Check if flight is airborne.

FLIGHTGROUP:IsArrived()

Check if flight has arrived at its destination parking spot.

FLIGHTGROUP:IsFuelCritical()

Check if flight is critical on fuel.

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

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

FLIGHTGROUP:IsLandedAt()

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

FLIGHTGROUP:IsLanding()

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

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

Check if flight is parking.

FLIGHTGROUP:IsWaiting()

Check if flight is waiting after passing final waypoint.

FLIGHTGROUP:New(group)

Create a new FLIGHTGROUP object and start the FSM.

FLIGHTGROUP:OnEventBirth(EventData)

Flightgroup event function, handling the birth of a unit.

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:OnEventRemoveUnit(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:SetAirboss(airboss)

Set the AIRBOSS controlling this flight group.

FLIGHTGROUP:SetAirwing(airwing)

Set AIRWING the flight group belongs to.

FLIGHTGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)

Set default formation.

FLIGHTGROUP:SetDefaultFormation(Formation)

Set default formation.

FLIGHTGROUP:SetDefaultRadio(Frequency, Modulation)

Set default Radio frequency and modulation.

FLIGHTGROUP:SetDefaultTACAN(Channel, Morse)

Set default TACAN parameters.

FLIGHTGROUP:SetFlightControl(flightcontrol)

Set the FLIGHTCONTROL controlling this flight group.

FLIGHTGROUP:SetFuelCriticalThreshold(threshold, rtb)

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:StartUncontrolled(delay)

Start an uncontrolled group.

FLIGHTGROUP:SwitchCallsign(CallsignName, CallsignNumber)

Switch to a specific callsign.

FLIGHTGROUP:SwitchFormation(Formation)

Switch to a specific formation.

FLIGHTGROUP:SwitchRadioOff()

Turn radio off.

FLIGHTGROUP:SwitchRadioOn(Frequency, Modulation)

Turn radio on.

FLIGHTGROUP:SwitchTACANOff()

Deactivate TACAN beacon.

FLIGHTGROUP:SwitchTACANOn(TACANChannel, TACANMorse)

Activate TACAN beacon.

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:_CheckGroupDone(delay)

Check if flight is done, i.e.

FLIGHTGROUP._ClearedToLand(group, flightgroup)

Function called when flight has reached the holding point.

FLIGHTGROUP._FinishedRefuelling(group, flightgroup)

Function called when flight finished refuelling.

FLIGHTGROUP:_GetAttribute()

Get the generalized attribute of a group.

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:_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()

Initialize group parameters.

FLIGHTGROUP:_IsElement(unitname)

Check if a unit is an element of the flightgroup.

FLIGHTGROUP:_IsHuman(group)

Checks if a group has a human player.

FLIGHTGROUP:_IsHumanUnit(unit)

Checks if a human player sits in the unit.

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)

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

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

The airwing the flight group belongs to.

FLIGHTGROUP.ammo

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

FLIGHTGROUP.callsignName

Callsign name.

FLIGHTGROUP.callsignNameDefault

FLIGHTGROUP.callsignNumber

Callsign number.

FLIGHTGROUP.callsignNumberDefault

FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

FLIGHTGROUP.controlstatus

Flight control status.

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

Flag for holding.

FLIGHTGROUP.flightcontrol

The flightcontrol handling this group.

FLIGHTGROUP.formation

FLIGHTGROUP.formationDefault

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

FLIGHTGROUP.group

FLIGHTGROUP.groupinitialized

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

FLIGHTGROUP.isGround

FLIGHTGROUP.isLateActivated

FLIGHTGROUP.isNaval

FLIGHTGROUP.isUncontrolled

FLIGHTGROUP.ishelo

If true, the is a helicopter group.

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:onafterDead(From, Event, To)

On after "FlightDead" 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: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:onafterEngageTargets(From, Event, To, TargetUnitSet)

On after "EngageTargets" 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:onafterLanded(From, Event, To, airbase)

On after "Landed" event.

FLIGHTGROUP:onafterLanding(From, Event, To)

On after "Landing" 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:onafterRespawn(From, Event, To, Template)

On after "Respawn" event.

FLIGHTGROUP:onafterSpawned(From, Event, To)

On after "Spawned" event.

FLIGHTGROUP:onafterStatus(From, Event, To)

On after "Status" event.

FLIGHTGROUP:onafterStop(From, Event, To)

On after Start 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)

On after "UpdateRoute" event.

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

On after "Wait" event.

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

On before "LandAt" event.

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

On before "RTB" event.

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

On before "UpdateRoute" event.

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

On before "Wait" event.

FLIGHTGROUP.passedfinalwp

FLIGHTGROUP.position

FLIGHTGROUP.radioFreq

FLIGHTGROUP.radioFreqDefault

FLIGHTGROUP.radioModu

FLIGHTGROUP.radioModuDefault

FLIGHTGROUP.radioOn

FLIGHTGROUP.radioUse

FLIGHTGROUP.rangemax

Max range in km.

FLIGHTGROUP.refueltype

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

FLIGHTGROUP.respawning

FLIGHTGROUP.speedCruise

FLIGHTGROUP.speedmax

FLIGHTGROUP.tacanBeacon

FLIGHTGROUP.tacanChannel

FLIGHTGROUP.tacanChannelDefault

FLIGHTGROUP.tacanMorse

FLIGHTGROUP.tacanMorseDefault

FLIGHTGROUP.tacanOn

FLIGHTGROUP.tankertype

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

FLIGHTGROUP.template

FLIGHTGROUP.traveldist

FLIGHTGROUP.traveltime

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:AddTask(task, clock, description, prio, duration)

Add a scheduled task.

FLIGHTGROUP:AddTaskEnroute(task)

Add an enroute task.

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

Add a waypoint task.

FLIGHTGROUP:CheckTaskDescriptionUnique(description)

Check if task description is unique.

FLIGHTGROUP.ClassName

Name of the class.

FLIGHTGROUP:ClearTasks(DCSTask)

Clear DCS tasks.

FLIGHTGROUP:CountRemainingMissison()

Count remaining missons.

FLIGHTGROUP:CountRemainingTasks()

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

FLIGHTGROUP.Debug

Debug mode. Messages to all about status.

FLIGHTGROUP.ElementStatus

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:GetCoalition()

Get coalition.

FLIGHTGROUP:GetCoordinate()

Get current coordinate of the group.

FLIGHTGROUP:GetDetectedUnits()

Get set of detected units.

FLIGHTGROUP:GetElementByName(unitname)

Get the element of a group.

FLIGHTGROUP:GetGroup()

Get MOOSE GROUP object.

FLIGHTGROUP:GetHeading()

Get current heading of the group.

FLIGHTGROUP:GetLifePoints()

Returns the absolute (average) 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()

Get coordinate of next waypoint of the group.

FLIGHTGROUP:GetROE()

Get current ROE of the group.

FLIGHTGROUP:GetTaskByID(id, status)

Get task by its id.

FLIGHTGROUP:GetTaskCurrent()

Get the currently executed task if there is any.

FLIGHTGROUP:GetTasksWaypoint(n)

Get the unfinished waypoint tasks

FLIGHTGROUP:GetWaypoint(indx)

Get waypoint.

FLIGHTGROUP:GetWaypointCoordinate(wp)

Get next waypoint coordinates.

FLIGHTGROUP:GetWaypointCurrent()

Get current waypoint.

FLIGHTGROUP:GetWaypointFinal()

Get final waypoint.

FLIGHTGROUP:GetWaypointIndexNext(cyclic)

Get next waypoint index.

FLIGHTGROUP:GetWaypointNext(cyclic)

Get next waypoint.

FLIGHTGROUP:GetWaypointSpeed(indx)

Get waypoint speed.

FLIGHTGROUP:InitWaypoints(waypoints)

Initialize Mission Editor waypoints.

FLIGHTGROUP:IsAlive()

Check if group is alive.

FLIGHTGROUP:IsDead()

Check if group is dead.

FLIGHTGROUP:IsInUtero()

Check if group is in state in utero.

FLIGHTGROUP:IsLateActivated()

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

FLIGHTGROUP:IsSpawned()

Check if group is in state spawned.

FLIGHTGROUP:IsStopped()

Check if FSM is stopped.

FLIGHTGROUP:IsUncontrolled()

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

FLIGHTGROUP:New(Group)

Create a new OPSGROUP class object.

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

Create a scheduled task.

FLIGHTGROUP:PushTask(DCSTask)

Push DCS task.

FLIGHTGROUP:RemoveMission(Mission)

Remove mission from queue.

FLIGHTGROUP:RemoveTask(Task)

Remove task from task queue.

FLIGHTGROUP:RemoveWaypoint(wpindex)

Remove a waypoint.

FLIGHTGROUP:Route(waypoints, delay)

Route group along waypoints.

FLIGHTGROUP:RouteToMission(mission, delay)

Route group to mission.

FLIGHTGROUP:SelfDestruction(Delay, ExplosionPower)

Self destruction of group.

FLIGHTGROUP:SetCheckZones(CheckZonesSet)

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

FLIGHTGROUP:SetDefaultROE(roe)

Set the default ROE for the group.

FLIGHTGROUP:SetDefaultROT(roe)

Set the default ROT for the group.

FLIGHTGROUP:SetDetection(Switch)

Set detection on or off.

FLIGHTGROUP:SetOptionROE(roe)

Set current ROE for the group.

FLIGHTGROUP:SetOptionROT(rot)

Set ROT for the group.

FLIGHTGROUP:SetTask(DCSTask)

Set DCS task.

FLIGHTGROUP:Status()

Triggers the FSM event "Status".

FLIGHTGROUP.TaskStatus

FLIGHTGROUP.TaskType

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:_CheckDetectedUnits()

Check detected units.

FLIGHTGROUP:_CheckInZones()

Check if group is in zones.

FLIGHTGROUP:_GetNextMission()

Get next mission.

FLIGHTGROUP:_GetNextTask()

Get next task in queue.

FLIGHTGROUP:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

FLIGHTGROUP._PassingWaypoint(group, opsgroup, i)

Function called when a group is passing a waypoint.

FLIGHTGROUP:_SetElementStatusAll(status)

Set status for all elements (except dead ones).

FLIGHTGROUP:_SortTaskQueue()

Sort task queue.

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:_UpdateStatus(element, newstatus, airbase)

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

FLIGHTGROUP:_UpdateWaypointTasks(n)

Initialize Mission Editor waypoints.

FLIGHTGROUP:__Status(delay)

Triggers the FSM event "Status" after a delay.

FLIGHTGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

FLIGHTGROUP.ai

If true, group is purely AI.

FLIGHTGROUP.attribute

Generalized attribute.

FLIGHTGROUP.checkzones

Set of zones.

FLIGHTGROUP.currentmission

The ID (auftragsnummer) of the currently assigned AUFTRAG.

FLIGHTGROUP.currentwp

Current waypoint.

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

If true, EPLRS data link is on.

FLIGHTGROUP.eplrsDefault

Default EPLRS data link setting.

FLIGHTGROUP.formation

Current formation setting.

FLIGHTGROUP.formationDefault

Default formation setting.

FLIGHTGROUP.group

Group object.

FLIGHTGROUP.groupinitialized

If true, group parameters were initialized.

FLIGHTGROUP.groupname

Name of the group.

FLIGHTGROUP.inzones

Set of zones in which the group is currently in.

FLIGHTGROUP.isAircraft

If true, group is airplane or helicopter.

FLIGHTGROUP.isGround

If true, group is some ground unit.

FLIGHTGROUP.isLateActivated

Is the group late activated.

FLIGHTGROUP.isNaval

If true, group is ships or submarine.

FLIGHTGROUP.isUncontrolled

Is the group uncontrolled.

FLIGHTGROUP.lid

Class id string for output to DCS log file.

FLIGHTGROUP.missionpaused

Paused mission.

FLIGHTGROUP.missionqueue

Queue of missions.

FLIGHTGROUP:onafterCheckZone(From, Event, To)

On after "CheckZone" event.

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

On after "DetectedUnit" event.

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

On after "DetectedUnitNew" event.

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

On after "EnterZone" event.

FLIGHTGROUP:onafterGotoWaypoint(From, Event, To, n)

On after "GotoWaypoint" event.

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

On after "LeaveZone" 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:onafterPassingWaypoint(From, Event, To, n, N)

On after "PassingWaypoint" event.

FLIGHTGROUP:onafterPauseMission(From, Event, To)

On after "PauseMission" event.

FLIGHTGROUP:onafterQueueUpdate(From, Event, To)

On after "QueueUpdate" 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:onafterUnpauseMission(From, Event, To)

On after "UnpauseMission" event.

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

On before "MissionStart" event.

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

On before "TaskDone" event.

FLIGHTGROUP.passedfinalwp

Group has passed the final waypoint.

FLIGHTGROUP.position

Current position of the group.

FLIGHTGROUP.radioFreq

Currently used radio frequency in MHz.

FLIGHTGROUP.radioFreqDefault

Default radio frequency in MHz.

FLIGHTGROUP.radioModu

Currently used radio modulation radio.modulation.AM or radio.modulation.FM.

FLIGHTGROUP.radioModuDefault

Default Radio modulation radio.modulation.AM or radio.modulation.FM.

FLIGHTGROUP.radioOn

If true, radio is currently turned on.

FLIGHTGROUP.radioQueue

Radio queue.

FLIGHTGROUP.respawning

Group is being respawned.

FLIGHTGROUP.roe

Current ROE setting.

FLIGHTGROUP.roeDefault

Default ROE setting.

FLIGHTGROUP.rot

Current ROT setting.

FLIGHTGROUP.rotDefault

Default ROT setting.

FLIGHTGROUP.speedCruise

Cruising speed in km/h.

FLIGHTGROUP.speedmax

Max speed in km/h.

FLIGHTGROUP.tacanBeacon

The unit acting as TACAN beacon.

FLIGHTGROUP.tacanChannel

The currenly used TACAN channel.

FLIGHTGROUP.tacanChannelDefault

The default TACAN channel.

FLIGHTGROUP.tacanMorse

The currently used TACAN morse code.

FLIGHTGROUP.tacanMorseDefault

The default TACAN morse code.

FLIGHTGROUP.tacanOn

If true, TACAN is currently active.

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 of the group.

FLIGHTGROUP.traveldist

Distance traveled in meters. This is a lower bound!

FLIGHTGROUP.traveltime

Time.

FLIGHTGROUP.verbose

Verbosity level. 0=silent.

FLIGHTGROUP.version

NavyGroup version.

FLIGHTGROUP.waypoints

Table of waypoints.

FLIGHTGROUP.waypoints0

Table of initial waypoints.

Fields and Methods inherited from FSM Description

FLIGHTGROUP:AddEndState(State)

Adds an End state.

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

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

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

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

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)

FLIGHTGROUP:LoadCallBacks(CallBackTable)

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)

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

FLIGHTGROUP:_create_transition(EventName)

FLIGHTGROUP:_delayed_transition(EventName)

FLIGHTGROUP:_eventmap(Events, EventStructure)

FLIGHTGROUP:_gosub(ParentFrom, ParentEvent)

FLIGHTGROUP:_handler(EventName, ...)

FLIGHTGROUP:_isendstate(Current)

FLIGHTGROUP:_submap(subs, sub, name)

FLIGHTGROUP:can(e)

FLIGHTGROUP:cannot(e)

FLIGHTGROUP.current

FLIGHTGROUP.endstates

FLIGHTGROUP:is(state)

FLIGHTGROUP.options

FLIGHTGROUP.subs

Fields and Methods inherited from BASE Description

FLIGHTGROUP.ClassID

The ID number of the class.

FLIGHTGROUP.ClassName

The name of the class.

FLIGHTGROUP.ClassNameAndID

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

FLIGHTGROUP:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

FLIGHTGROUP:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

FLIGHTGROUP:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

FLIGHTGROUP:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

FLIGHTGROUP:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

FLIGHTGROUP:E(Arguments)

Log an exception which will be traced always.

FLIGHTGROUP:EventDispatcher()

Returns the event dispatcher

FLIGHTGROUP:EventRemoveAll()

Remove all subscribed events

FLIGHTGROUP:F(Arguments)

Trace a function call.

FLIGHTGROUP:F2(Arguments)

Trace a function call level 2.

FLIGHTGROUP:F3(Arguments)

Trace a function call level 3.

FLIGHTGROUP:GetClassID()

Get the ClassID of the class instance.

FLIGHTGROUP:GetClassName()

Get the ClassName of the class instance.

FLIGHTGROUP:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

FLIGHTGROUP:GetEventPriority()

Get the Class Event processing Priority.

FLIGHTGROUP:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

FLIGHTGROUP:GetState(Object, Key)

Get a Value given a Key from the Object.

FLIGHTGROUP:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

FLIGHTGROUP:I(Arguments)

Log an information which will be traced always.

FLIGHTGROUP:Inherit(Child, Parent)

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

FLIGHTGROUP:IsInstanceOf(ClassName)

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

FLIGHTGROUP:IsTrace()

Enquires if tracing is on (for the class).

FLIGHTGROUP:New()

BASE constructor.

FLIGHTGROUP:OnEvent(EventData)

Occurs when an object is completely destroyed.

FLIGHTGROUP:OnEventBaseCaptured(EventData)

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

FLIGHTGROUP:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

FLIGHTGROUP:OnEventCrash(EventData)

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

FLIGHTGROUP:OnEventDead(EventData)

Occurs when an object is dead.

FLIGHTGROUP:OnEventDetailedFailure(EventData)

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

FLIGHTGROUP:OnEventEjection(EventData)

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

FLIGHTGROUP:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

FLIGHTGROUP:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

FLIGHTGROUP:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

FLIGHTGROUP:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

FLIGHTGROUP:OnEventKill(EventData)

Occurs on the death of a unit.

FLIGHTGROUP:OnEventLand(EventData)

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

FLIGHTGROUP:OnEventLandingAfterEjection(EventData)

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

FLIGHTGROUP:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

FLIGHTGROUP:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

FLIGHTGROUP:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

FLIGHTGROUP:OnEventMissionEnd(EventData)

Occurs when a mission ends

FLIGHTGROUP:OnEventMissionStart(EventData)

Occurs when a mission starts

FLIGHTGROUP:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

FLIGHTGROUP:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

FLIGHTGROUP:OnEventPlayerLeaveUnit(EventData)

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

FLIGHTGROUP:OnEventRefueling(EventData)

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

FLIGHTGROUP:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

FLIGHTGROUP:OnEventScore(EventData)

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

FLIGHTGROUP:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

FLIGHTGROUP:OnEventShootingStart(EventData)

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

FLIGHTGROUP:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

FLIGHTGROUP:OnEventTakeoff(EventData)

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

FLIGHTGROUP:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

FLIGHTGROUP:ScheduleStop(SchedulerFunction)

Stops the Schedule.

FLIGHTGROUP.Scheduler

FLIGHTGROUP:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

FLIGHTGROUP:SetState(Object, Key, Value)

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

FLIGHTGROUP:T(Arguments)

Trace a function logic level 1.

FLIGHTGROUP:T2(Arguments)

Trace a function logic level 2.

FLIGHTGROUP:T3(Arguments)

Trace a function logic level 3.

FLIGHTGROUP:TraceAll(TraceAll)

Trace all methods in MOOSE

FLIGHTGROUP:TraceClass(Class)

Set tracing for a class

FLIGHTGROUP:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

FLIGHTGROUP:TraceLevel(Level)

Set trace level

FLIGHTGROUP:TraceOff()

Set trace off.

FLIGHTGROUP:TraceOn()

Set trace on.

FLIGHTGROUP:TraceOnOff(TraceOnOff)

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

FLIGHTGROUP:UnHandleEvent(Event)

UnSubscribe to a DCS event.

FLIGHTGROUP._

FLIGHTGROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

FLIGHTGROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

FLIGHTGROUP.__

FLIGHTGROUP:onEvent(event)

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.Element Description

FLIGHTGROUP.Element.ai

If true, element is AI.

FLIGHTGROUP.Element.callsign

Call sign, e.g. "Uzi 1-1".

FLIGHTGROUP.Element.category

Aircraft category.

FLIGHTGROUP.Element.categoryname

Aircraft category name.

FLIGHTGROUP.Element.client

The client if element is occupied by a human player.

FLIGHTGROUP.Element.damage

Damage of element in percent.

FLIGHTGROUP.Element.fuelmass

Mass of fuel in kg.

FLIGHTGROUP.Element.fuelmass0

FLIGHTGROUP.Element.fuelrel

FLIGHTGROUP.Element.group

Group object of the element.

FLIGHTGROUP.Element.modex

Tail number.

FLIGHTGROUP.Element.name

Name of the element, i.e. the unit/client.

FLIGHTGROUP.Element.parking

The parking spot table the element is parking on.

FLIGHTGROUP.Element.pylons

Table of pylons.

FLIGHTGROUP.Element.size

FLIGHTGROUP.Element.skill

Skill level.

FLIGHTGROUP.Element.status

Status, i.e. born, parking, taxiing. See OPSGROUP.ElementStatus.

FLIGHTGROUP.Element.unit

Element unit object.

FLIGHTGROUP class.

Field(s)

#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.AirWing#AIRWING FLIGHTGROUP.airwing

The airwing the flight group belongs to.

#FLIGHTGROUP.Ammo FLIGHTGROUP.ammo

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

#number FLIGHTGROUP.callsignName

Callsign name.

#number FLIGHTGROUP.callsignNumber

Callsign number.

#number FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

#string FLIGHTGROUP.controlstatus

Flight control status.

Wrapper.Airbase#AIRBASE FLIGHTGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.destzone

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

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.

#number FLIGHTGROUP.fuelmass

Initial fuel mass. TODO: this is a unit property!

Wrapper.Airbase#AIRBASE FLIGHTGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.homezone

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

#boolean FLIGHTGROUP.isAircraft

Define category.

FLIGHTGROUP.isLateActivated

Is (template) group late activated.

#boolean FLIGHTGROUP.ishelo

If true, the is a helicopter group.

FLIGHTGROUP.lid

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

#table FLIGHTGROUP.menu

F10 radio menu.

#number FLIGHTGROUP.rangemax

Max range in km.

#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.template

Get template of group.

#string FLIGHTGROUP.version

FLIGHTGROUP class version.

FLIGHTGROUP.waypoints0

Template waypoints.

Function(s)

Add an element to the flight group.

Defined in:

FLIGHTGROUP

Parameter:

#string unitname

Name of unit.

Return value:

The element or nil.

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 350 kts.

#number wpnumber

Waypoint number. Default at the end.

#boolean updateroute

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

Return value:

#number:

Waypoint index.

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 #nil.

Get airwing the flight group belongs to.

Defined in:

FLIGHTGROUP

Return value:

The AIRWING object.

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.

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 current Radio frequency and modulation.

Defined in:

FLIGHTGROUP

Return values:

#number:

Radio frequency in MHz or nil.

#number:

Radio modulation or nil.

Initialize Mission Editor waypoints.

Defined in:

FLIGHTGROUP

Parameter:

#table waypoints

Table of waypoints. Default is from group template.

Return value:

self

Check if flight is airborne.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is airborne.

Check if flight has arrived at its destination parking spot.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

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

Check if flight is critical on fuel.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is critical 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

Return value:

#boolean:

If true, flight has landed

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

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, group is currently landed at the assigned position and waiting until task is complete.

Check if flight is landing.

Defined in:

FLIGHTGROUP

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

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 flight is parking.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is taxiing after engine start up.

Check if flight is waiting after passing final waypoint.

Defined in:

FLIGHTGROUP

Return value:

#boolean:

If true, flight is waiting.

Create a new FLIGHTGROUP object and start the FSM.

Defined in:

FLIGHTGROUP

Parameter:

The group object. Can also be given as #string with the name of the group.

Return value:

self

Flightgroup event function, handling the birth 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.

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 AIRWING the flight group belongs to.

Defined in:

FLIGHTGROUP

Parameter:

The AIRWING object.

Return value:

self

Set default formation.

Defined in:

FLIGHTGROUP

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number.

Return value:

self

Set default formation.

Defined in:

FLIGHTGROUP

Parameter:

#number Formation

The formation the groups flies in.

Return value:

self

Set default Radio frequency and modulation.

Defined in:

FLIGHTGROUP

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default radio.Modulation.AM.

Return value:

self

Set default TACAN parameters.

AA TACANs are always on "Y" band.

Defined in:

FLIGHTGROUP

Parameters:

#number Channel

TACAN channel.

#string Morse

Morse code. Default "XXX".

Return value:

self

Set the FLIGHTCONTROL controlling this flight group.

Defined in:

FLIGHTGROUP

Parameter:

The FLIGHTCONTROL object.

Return value:

self

Set fuel critical threshold.

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

Defined in:

FLIGHTGROUP

Parameters:

#number threshold

Fuel threshold in percent. Default 10 %.

#boolean rtb

If true, RTB on fuel critical event.

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

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

Switch to a specific callsign.

Defined in:

FLIGHTGROUP

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number.

Return value:

self

Switch to a specific formation.

Defined in:

FLIGHTGROUP

Parameter:

#number Formation

New formation the group will fly in.

Return value:

self

Turn radio off.

Defined in:

FLIGHTGROUP

Return value:

self

Turn radio on.

Defined in:

FLIGHTGROUP

Parameters:

#number Frequency

Radio frequency in MHz.

#number Modulation

Radio modulation. Default radio.Modulation.AM.

Return value:

self

Deactivate TACAN beacon.

Defined in:

FLIGHTGROUP

Return value:

self

Activate TACAN beacon.

Defined in:

FLIGHTGROUP

Parameters:

#number TACANChannel

TACAN Channel.

#string TACANMorse

TACAN morse code.

Return value:

self

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

Parameter:

#number delay

Delay in seconds.

Function called when flight has reached the holding point.

Defined in:

FLIGHTGROUP

Parameters:

Group object.

#FLIGHTGROUP flightgroup

Flight group object.

Function called when flight finished refuelling.

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.

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.

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

Return value:

self

Check if a unit is an element of the flightgroup.

Defined in:

FLIGHTGROUP

Parameter:

#string unitname

Name of unit.

Return value:

#boolean:

If true, unit is element of the flight group or false if otherwise.

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.

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.

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

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 "FlightDead" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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 "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 "EngageTargets" event.

Order to engage a set of units.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Core.Set#SET_UNIT TargetUnitSet

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 600 sec (10 min).

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 "Landing" 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 "Respawn" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#table Template

The template used to respawn the group.

On after "Spawned" event.

Sets the template, initializes the waypoints.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Status" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

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

Waypoint number. Default is next waypoint.

On after "Wait" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Coordinate where to orbit. Default current position.

#number Altitude

Altitude in feet. Default 10000 ft.

#number Speed

Speed in knots. Default 250 kts.

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

Waypoint number.

Return value:

#boolean:

Transision allowed?

On before "Wait" event.

Defined in:

FLIGHTGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Coordinate where to orbit. Default current position.

#number Altitude

Altitude in feet. Default 10000 ft.

#number Speed

Speed in knots. Default 250 kts.

Field(s)

#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.AirWing#AIRWING FLIGHTGROUP.airwing

The airwing the flight group belongs to.

#FLIGHTGROUP.Ammo FLIGHTGROUP.ammo

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

#number FLIGHTGROUP.callsignName

Callsign name.

#number FLIGHTGROUP.callsignNumber

Callsign number.

#number FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

#string FLIGHTGROUP.controlstatus

Flight control status.

Wrapper.Airbase#AIRBASE FLIGHTGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.destzone

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

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.

#number FLIGHTGROUP.fuelmass

Initial fuel mass. TODO: this is a unit property!

Wrapper.Airbase#AIRBASE FLIGHTGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.homezone

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

#boolean FLIGHTGROUP.isAircraft

Define category.

FLIGHTGROUP.isLateActivated

Is (template) group late activated.

#boolean FLIGHTGROUP.ishelo

If true, the is a helicopter group.

FLIGHTGROUP.lid

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

#table FLIGHTGROUP.menu

F10 radio menu.

#number FLIGHTGROUP.rangemax

Max range in km.

#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.template

Get template of group.

#string FLIGHTGROUP.version

FLIGHTGROUP class version.

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

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.

#number waypointindex

Number of waypoint. Counting starts at one! Default is the as 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.

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:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

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.

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

Defined in:

Return value:

#number:

Coalition side of carrier.

Get current coordinate of the group.

Defined in:

Return value:

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

Get set of detected units.

Defined in:

Return value:

Set of detected units.

Get the element of a group.

Defined in:

Parameter:

#string unitname

Name of unit.

Return value:

The element.

Get MOOSE GROUP object.

Defined in:

Return value:

Moose group object.

Get current heading of the group.

Defined in:

Return value:

#number:

Current heading of the group in degrees.

Returns the absolute (average) life points of the group.

Defined in:

Return values:

#number:

Life points. If group contains more than one element, the average is given.

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

Return values:

Coordinate of the next waypoint.

#number:

Number of waypoint.

Get current ROE of the group.

Defined in:

Return value:

#number:

Current ROE.

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 n

Waypoint index. Counting starts at one.

Return value:

#table:

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

Get waypoint.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#table:

Waypoint table.

Get next waypoint coordinates.

Defined in:

Parameter:

#table wp

Waypoint table.

Return value:

Coordinate of the next waypoint.

Get current waypoint.

Defined in:

Return value:

#table:

Waypoint table.

Get final waypoint.

Defined in:

Return value:

#table:

Waypoint table.

Get next waypoint index.

Defined in:

Parameter:

#boolean cyclic

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

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:

#table:

Waypoint table.

Get waypoint speed.

Defined in:

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed set at waypoint in knots.

Initialize Mission Editor waypoints.

Defined in:

Parameter:

#table waypoints

Table of waypoints. Default is from group template.

Return value:

self

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 group is dead.

Defined in:

Return value:

#boolean:

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

Check if group is in state in utero.

Defined in:

Return value:

#boolean:

If true, group is not spawned yet.

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 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 this group is currently "uncontrolled" and needs to be "started" to begin its route.

Defined in:

Return value:

#boolean:

If this group uncontrolled.

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.

Push DCS task.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

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

Route group along waypoints.

Defined in:

Parameters:

#table waypoints

Table of waypoints.

delay

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 500 kg.

Return value:

#number:

Relative fuel in percent.

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 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 roe

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

Return value:

self

Set detection on or off.

Defined in:

Parameter:

#boolean Switch

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

Return value:

self

Set current ROE for the group.

Defined in:

Parameter:

#string roe

ROE of group. Default is the value defined by :SetDefaultROE().

Return value:

self

Set ROT for the group.

Defined in:

Parameter:

#string rot

ROT of group. Default is the value defined by :SetDefaultROT().

Return value:

self

Set DCS task.

Enroute tasks are injected automatically.

Defined in:

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

Triggers the FSM event "Status".

Defined in:

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

Defined in:

Parameters:

#string unitname

Name of unit.

status

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

Defined in:

Parameter:

#string status

Status to check.

Return value:

#boolean:

If true, all elements have a similar status.

Check detected units.

Defined in:

Check if group is in zones.

Defined in:

Get next mission.

Defined in:

Return value:

Next mission or nil.

Get next task in queue.

Task needs to be in state SCHEDULED and time must have passed.

Defined in:

Return value:

The next task in line or nil.

Returns a name of a missile category.

Defined in:

Parameter:

#number categorynumber

Number of missile category from weapon missile category enumerator. See https://wiki.hoggitworld.com/view/DCS_Class_Weapon

Return value:

#string:

Missile category name.

Function called when a group is passing a waypoint.

Defined in:

Parameters:

Group that passed the waypoint

#OPSGROUP opsgroup

Ops group object.

#number i

Waypoint number that has been reached.

Set status for all elements (except dead ones).

Defined in:

Parameter:

#string status

Element status.

Function called when a task is done.

Defined in:

Parameters:

Group for which the task is done.

#OPSGROUP opsgroup

Ops group.

Task.

Function called when a task is executed.

Defined in:

Parameters:

Group which should execute the task.

#OPSGROUP opsgroup

Ops group.

Task.

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

Defined in:

Parameters:

Element.

#string newstatus

New status of element

Airbase if applicable.

Initialize Mission Editor waypoints.

Defined in:

Parameter:

#number n

Waypoint

Triggers the FSM event "Status" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the OPSGROUP and all its event handlers.

Defined in:

Parameter:

#number delay

Delay in seconds.

On after "CheckZone" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "DetectedUnit" event.

Add newly detected unit to detected units set.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The detected unit.

On after "DetectedUnitNew" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The detected unit.

On after "EnterZone" event.

Sets self.inzones[zonename]=true.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The zone that the group entered.

On after "GotoWaypoint" event.

Group will got to the given waypoint and execute its route from there.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

The goto waypoint number.

On after "LeaveZone" event.

Sets self.inzones[zonename]=false.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The zone that the group entered.

On after "MissionCancel" event.

Cancels the mission.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission to be cancelled.

On after "MissionDone" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "MissionExecute" event.

Mission execution began.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission table.

On after "MissionStart" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission table.

On after "PassingWaypoint" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number n

Waypoint passed.

#number N

Total number of waypoints.

On after "PauseMission" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "QueueUpdate" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "TaskCancel" event.

Cancels the current task or simply sets the status to DONE if the task is not the current one.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The task to cancel. Default is the current task (if any).

On after "TaskDone" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after TaskExecute event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "UnpauseMission" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "MissionStart" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission table.

On before "TaskDone" event.

Deny transition if task status is PAUSED.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#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.AirWing#AIRWING FLIGHTGROUP.airwing

The airwing the flight group belongs to.

#FLIGHTGROUP.Ammo FLIGHTGROUP.ammo

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

#number FLIGHTGROUP.callsignName

Callsign name.

#number FLIGHTGROUP.callsignNumber

Callsign number.

#number FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

#string FLIGHTGROUP.controlstatus

Flight control status.

Wrapper.Airbase#AIRBASE FLIGHTGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.destzone

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

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.

#number FLIGHTGROUP.fuelmass

Initial fuel mass. TODO: this is a unit property!

Wrapper.Airbase#AIRBASE FLIGHTGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.homezone

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

#boolean FLIGHTGROUP.isAircraft

Define category.

FLIGHTGROUP.isLateActivated

Is (template) group late activated.

#boolean FLIGHTGROUP.ishelo

If true, the is a helicopter group.

FLIGHTGROUP.lid

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

#table FLIGHTGROUP.menu

F10 radio menu.

#number FLIGHTGROUP.rangemax

Max range in km.

#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.template

Get template of group.

#string FLIGHTGROUP.version

FLIGHTGROUP class version.

FLIGHTGROUP.waypoints0

Template waypoints.

Function(s)

Adds an End state.

Defined in:

Parameter:

State

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameter:

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameter:

Current

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

#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.AirWing#AIRWING FLIGHTGROUP.airwing

The airwing the flight group belongs to.

#FLIGHTGROUP.Ammo FLIGHTGROUP.ammo

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

#number FLIGHTGROUP.callsignName

Callsign name.

#number FLIGHTGROUP.callsignNumber

Callsign number.

#number FLIGHTGROUP.ceiling

Max altitude the aircraft can fly at in meters.

#string FLIGHTGROUP.controlstatus

Flight control status.

Wrapper.Airbase#AIRBASE FLIGHTGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.destzone

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

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.

#number FLIGHTGROUP.fuelmass

Initial fuel mass. TODO: this is a unit property!

Wrapper.Airbase#AIRBASE FLIGHTGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE FLIGHTGROUP.homezone

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

#boolean FLIGHTGROUP.isAircraft

Define category.

FLIGHTGROUP.isLateActivated

Is (template) group late activated.

#boolean FLIGHTGROUP.ishelo

If true, the is a helicopter group.

FLIGHTGROUP.lid

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

#table FLIGHTGROUP.menu

F10 radio menu.

#number FLIGHTGROUP.rangemax

Max range in km.

#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.template

Get template of group.

#string FLIGHTGROUP.version

FLIGHTGROUP class version.

FLIGHTGROUP.waypoints0

Template waypoints.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.

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

Defined in:

Parameter:

The EventData structure.

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event

Generalized attribute.

See DCS attributes on hoggit.

Field(s)

#string FLIGHTGROUP.Attribute.ATTACKHELO

Attack helicopter.

#string FLIGHTGROUP.Attribute.AWACS

Airborne Early Warning and Control System.

#string FLIGHTGROUP.Attribute.BOMBER

Aircraft which can be used for strategic bombing.

#string FLIGHTGROUP.Attribute.FIGHTER

Fighter, interceptor, ... airplane.

#string FLIGHTGROUP.Attribute.OTHER

Other aircraft type.

#string FLIGHTGROUP.Attribute.TANKER

Airplane which can refuel other aircraft.

#string FLIGHTGROUP.Attribute.TRANSPORTHELO

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

#string FLIGHTGROUP.Attribute.TRANSPORTPLANE

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

#string FLIGHTGROUP.Attribute.UAV

Unpiloted Aerial Vehicle, e.g. drones.

Function(s)

Flight group element.

Field(s)

#boolean FLIGHTGROUP.Element.ai

If true, element is AI.

#string FLIGHTGROUP.Element.callsign

Call sign, e.g. "Uzi 1-1".

#number FLIGHTGROUP.Element.category

Aircraft category.

#string FLIGHTGROUP.Element.categoryname

Aircraft category name.

Wrapper.Client#CLIENT FLIGHTGROUP.Element.client

The client if element is occupied by a human player.

#number FLIGHTGROUP.Element.damage

Damage of element in percent.

#number FLIGHTGROUP.Element.fuelmass

Mass of fuel in kg.

FLIGHTGROUP.Element.fuelrel

Store rel fuel.

Wrapper.Group#GROUP FLIGHTGROUP.Element.group

Group object of the element.

#string FLIGHTGROUP.Element.modex

Tail number.

#string FLIGHTGROUP.Element.name

Name of the element, i.e. the unit/client.

Wrapper.Airbase#AIRBASE.ParkingSpot FLIGHTGROUP.Element.parking

The parking spot table the element is parking on.

#table FLIGHTGROUP.Element.pylons

Table of pylons.

#string FLIGHTGROUP.Element.skill

Skill level.

#string FLIGHTGROUP.Element.status

Status, i.e. born, parking, taxiing. See OPSGROUP.ElementStatus.

Function(s)