Banner Image

Module Ops.OpsGroup

Ops - Generic group enhancement.

This class is not meant to be used itself by the end user. It contains common functionalities of derived classes for air, ground and sea.


Author: funkyfranky


Global(s)

Global OPSGROUP

A small group of determined and like-minded people can change the course of history. -- Mahatma Gandhi


The OPSGROUP Concept

The OPSGROUP class contains common functions used by other classes such as FLIGHTGROUP, NAVYGROUP and ARMYGROUP.

#OPSGROUP OPSGROUP

A small group of determined and like-minded people can change the course of history. -- Mahatma Gandhi


The OPSGROUP Concept

The OPSGROUP class contains common functions used by other classes such as FLIGHTGROUP, NAVYGROUP and ARMYGROUP.

Those classes inherit everything of this class and extend it with features specific to their unit category.

This class is NOT meant to be used by the end user itself.

Type(s)

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

OPSGROUP:Activate(delay)

Activate a late activated group.

OPSGROUP:AddCheckZone(CheckZone)

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

OPSGROUP:AddMission(Mission)

Add mission to queue.

OPSGROUP:AddOpsTransport(OpsTransport)

Create a cargo transport assignment.

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

Add a scheduled task.

OPSGROUP:AddTaskEnroute(task)

Add an enroute task.

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

Add a waypoint task.

OPSGROUP:AddWeaponRange(RangeMin, RangeMax, BitType)

Add a weapon range for ARTY auftrag.

OPSGROUP:AddWeightCargo(UnitName, Weight)

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

OPSGROUP.Astar

path finding.

OPSGROUP:CanCargo(Cargo)

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

OPSGROUP:CancelAllMissions()

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

OPSGROUP.CargoStatus

OPSGROUP.CarrierStatus

OPSGROUP:CheckTaskDescriptionUnique(description)

Check if task description is unique.

OPSGROUP.ClassName

Name of the class.

OPSGROUP:ClearTasks()

Clear DCS tasks.

OPSGROUP:ClearWaypoints(IndexMin, IndexMax)

Clear waypoints.

OPSGROUP:CountElements(States)

Count elements of the group.

OPSGROUP:CountRemainingMissison()

Count remaining missons.

OPSGROUP:CountRemainingTasks()

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

OPSGROUP:CountRemainingTransports()

Count remaining cargo transport assignments.

OPSGROUP:CountTasksWaypoint(uid, id)

Count remaining waypoint tasks.

OPSGROUP:Deactivate(delay)

Deactivate the group.

OPSGROUP:DelOpsTransport(CargoTransport)

Delete a cargo transport assignment from the cargo queue.

OPSGROUP:Despawn(Delay, NoEventRemoveUnit)

Despawn the group.

OPSGROUP:DespawnElement(Element, Delay, NoEventRemoveUnit)

Despawn an element/unit of the group.

OPSGROUP:DespawnUnit(UnitName, Delay, NoEventRemoveUnit)

Despawn a unit of the group.

OPSGROUP:Destroy(Delay)

Destroy group.

OPSGROUP:DestroyUnit(UnitName, Delay)

Destroy a unit of the group.

OPSGROUP.EPLRS

OPSGROUP.ElementStatus

OPSGROUP:FindCarrierForCargo(Weight)

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

OPSGROUP:Get2DDistance(Coordinate)

Get 2D distance to a coordinate.

OPSGROUP:GetAlarmstate()

Get current Alarm State of the group.

OPSGROUP:GetAltitude()

Set current altitude.

OPSGROUP:GetAmmo0()

Get inital amount of ammunition.

OPSGROUP:GetAmmoElement(element)

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

OPSGROUP:GetAmmoTot()

Get total amount of ammunition of the whole group.

OPSGROUP:GetAmmoUnit(unit, display)

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

OPSGROUP:GetAttribute()

Get generalized attribute.

OPSGROUP:GetBeaconTACAN()

Get current TACAN parameters.

OPSGROUP:GetCallsignName(ShortCallsign, Keepnumber, CallsignTranslations)

Get callsign of the first element alive.

OPSGROUP:GetCargoGroups(CarrierName)

Get all groups currently loaded as cargo.

OPSGROUP:GetCargoOpsGroups()

Get OPSGROUPs in the cargo bay.

OPSGROUP:GetCoalition()

Get coalition.

OPSGROUP:GetCoordinate(NewObject, UnitName)

Get current coordinate of the group.

OPSGROUP:GetCoordinateInRange(TargetCoord, WeaponBitType, RefCoord)

Get a coordinate, which is in weapon range.

OPSGROUP:GetCruiseAltitude()

Get default cruise speed.

OPSGROUP:GetDCSGroup()

Get DCS GROUP object.

OPSGROUP:GetDCSObject()

Get DCS group object.

OPSGROUP:GetDCSUnit(UnitNumber)

Get DCS GROUP object.

OPSGROUP:GetDCSUnits()

Get DCS units.

OPSGROUP:GetDetectedGroups()

Get set of detected groups.

OPSGROUP:GetDetectedUnits()

Get set of detected units.

OPSGROUP:GetDistanceToWaypoint(indx)

Get distance to waypoint.

OPSGROUP:GetEPLRS()

Get current EPLRS state.

OPSGROUP:GetElementAlive()

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

OPSGROUP:GetElementByName(unitname)

Get the element of a group.

OPSGROUP:GetElementZoneBoundingBox(UnitName)

Get the bounding box of the element.

OPSGROUP:GetElementZoneLoad(UnitName)

Get the loading zone of the element.

OPSGROUP:GetElementZoneUnload(UnitName)

Get the unloading zone of the element.

OPSGROUP:GetEmission()

Get current emission state.

OPSGROUP:GetExpectedSpeed()

Returns the currently expected speed.

OPSGROUP:GetFreeCargobay(UnitName, IncludeReserved)

Get free cargo bay weight.

OPSGROUP:GetFreeCargobayMax(Currently)

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

OPSGROUP:GetFreeCargobayRelative(UnitName, IncludeReserved)

Get relative free cargo bay in percent.

OPSGROUP:GetGroup()

Get MOOSE GROUP object.

OPSGROUP:GetHeading(UnitName)

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

OPSGROUP:GetHighestThreat()

Get highest threat.

OPSGROUP:GetLaserCode()

Get LASER code.

OPSGROUP:GetLaserCoordinate()

Get current LASER coordinate, i.e.

OPSGROUP:GetLaserTarget()

Get current target of the LASER.

OPSGROUP:GetLifePoints(Element)

Returns the absolute total life points of the group.

OPSGROUP:GetMissionByID(id)

Get mission by its id (auftragsnummer).

OPSGROUP:GetMissionByTaskID(taskid)

Get mission by its task id.

OPSGROUP:GetMissionCurrent()

Get current mission.

OPSGROUP:GetName()

Get the group name.

OPSGROUP:GetNelements(status)

Get number of elements alive.

OPSGROUP:GetNextWaypointCoordinate(cyclic)

Get coordinate of next waypoint of the group.

OPSGROUP:GetOpsTransportByUID(uid)

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

OPSGROUP:GetOrientation(UnitName)

Get current orientation of the group.

OPSGROUP:GetOrientationX(UnitName)

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

OPSGROUP:GetROE()

Get current ROE of the group.

OPSGROUP:GetROT()

Get current ROT of the group.

OPSGROUP:GetRadio()

Get current Radio frequency and modulation.

OPSGROUP:GetSpeedCruise()

Get default cruise speed.

OPSGROUP:GetSpeedToWaypoint(indx)

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

OPSGROUP:GetTACAN()

Get current TACAN parameters.

OPSGROUP:GetTaskByID(id, status)

Get task by its id.

OPSGROUP:GetTaskCurrent()

Get the currently executed task if there is any.

OPSGROUP:GetTasksWaypoint(id)

Get the unfinished waypoint tasks

OPSGROUP:GetThreat(ThreatLevelMin, ThreatLevelMax)

Get highest detected threat.

OPSGROUP:GetTimeToWaypoint(indx)

Get time to waypoint based on current velocity.

OPSGROUP:GetUnit(UnitNumber)

Get MOOSE UNIT object.

OPSGROUP:GetUsedCargobayRelative(UnitName, IncludeReserved)

Get relative used (loaded) cargo bay in percent.

OPSGROUP:GetVec2(UnitName)

Get current 2D position vector of the group.

OPSGROUP:GetVec3(UnitName)

Get current 3D position vector of the group.

OPSGROUP:GetVelocity(UnitName)

Get current velocity of the group.

OPSGROUP:GetWaypoint(indx)

Get waypoint.

OPSGROUP:GetWaypointByID(uid)

Get the waypoint from its unique ID.

OPSGROUP:GetWaypointByIndex(index)

Get the waypoint from its index.

OPSGROUP:GetWaypointCoordinate(index)

Get waypoint coordinates.

OPSGROUP:GetWaypointCurrent()

Get current waypoint.

OPSGROUP:GetWaypointCurrentUID()

Get current waypoint UID.

OPSGROUP:GetWaypointFinal()

Get final waypoint.

OPSGROUP:GetWaypointID(indx)

Get unique ID of waypoint given its index.

OPSGROUP:GetWaypointIndex(uid)

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

OPSGROUP:GetWaypointIndexAfterID(uid)

Get waypoint index after waypoint with given ID.

OPSGROUP:GetWaypointIndexCurrent()

Get current waypoint index.

OPSGROUP:GetWaypointIndexNext(cyclic, i)

Get next waypoint index.

OPSGROUP:GetWaypointNext(cyclic)

Get next waypoint.

OPSGROUP:GetWaypointSpeed(indx)

Get waypoint speed.

OPSGROUP:GetWaypointUID(waypoint)

Get unique ID of waypoint.

OPSGROUP:GetWaypointUIDFromIndex(index)

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

OPSGROUP:GetWaypoints()

Get the waypoints.

OPSGROUP:GetWeaponData(BitType)

Get weapon data.

OPSGROUP:GetWeightCargo(UnitName, IncludeReserved)

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

OPSGROUP:GetWeightCargoMax(UnitName)

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

OPSGROUP:GetWeightTotal(UnitName, IncludeReserved)

Get total weight of the group including cargo.

OPSGROUP.GroupStatus

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

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

OPSGROUP:HasPassedFinalWaypoint()

Check if this group has passed its final waypoint.

OPSGROUP:HasTaskController()

Returns true if the DCS controller currently has a task.

OPSGROUP:InWeaponRange(TargetCoord, WeaponBitType, RefCoord)

Check if a given coordinate is in weapon range.

OPSGROUP:IsActive()

Check if group is activated.

OPSGROUP:IsAlive()

Check if group is alive.

OPSGROUP:IsArmygroup()

Check if this is a ARMYGROUP.

OPSGROUP:IsAwaitingLift(Transport)

Check if awaiting a transport lift.

OPSGROUP:IsBoarding(CarrierGroupName)

Check if the group is currently boarding a carrier.

OPSGROUP:IsBusy()

Check if the group is currently busy doing something.

OPSGROUP:IsCargo(CheckTransport)

Check if the group is assigned as cargo.

OPSGROUP:IsCarrier()

Check if the group is a carrier.

OPSGROUP:IsDead()

Check if group is dead.

OPSGROUP:IsDestroyed()

Check if group was destroyed.

OPSGROUP:IsEngaging()

Check if the group is engaging another unit or group.

OPSGROUP:IsExist()

Check if group is exists.

OPSGROUP:IsFlightgroup()

Check if this is a FLIGHTGROUP.

OPSGROUP:IsInUtero()

Check if group is in state in utero.

OPSGROUP:IsInZone(Zone)

Check if group is currently inside a zone.

OPSGROUP:IsLasing()

Check if the group has currently switched a LASER on.

OPSGROUP:IsLateActivated()

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

OPSGROUP:IsLoaded(CarrierGroupName)

Check if the group is currently loaded into a carrier.

OPSGROUP:IsLoading()

Check if the group is loading cargo.

OPSGROUP:IsMissionInQueue(Mission)

Check if a given mission is already in the queue.

OPSGROUP:IsMissionTypeInQueue(MissionType)

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

OPSGROUP:IsNavygroup()

Check if this is a NAVYGROUP.

OPSGROUP:IsNotCargo(CheckTransport)

Check if the group is not cargo.

OPSGROUP:IsNotCarrier()

Check if the group is not a carrier yet.

OPSGROUP:IsOnMission(MissionUID)

Check if group is currently on a mission.

OPSGROUP:IsOutOfAmmo()

Check if the group is completely out of ammo.

OPSGROUP:IsOutOfBombs()

Check if the group is out of bombs.

OPSGROUP:IsOutOfGuns()

Check if the group is out of guns.

OPSGROUP:IsOutOfMissiles()

Check if the group is out of missiles.

OPSGROUP:IsOutOfTorpedos()

Check if the group is out of torpedos.

OPSGROUP:IsPickingup()

Check if the group is picking up cargo.

OPSGROUP:IsRearming()

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

OPSGROUP:IsRetreated()

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

OPSGROUP:IsRetreating()

Check if the group is currently retreating or retreated.

OPSGROUP:IsReturning()

Check if the group is currently returning to a zone.

OPSGROUP:IsSpawned()

Check if group is in state spawned.

OPSGROUP:IsStopped()

Check if FSM is stopped.

OPSGROUP:IsTargetDetected(TargetObject)

Check if target is detected.

OPSGROUP:IsTransporting()

Check if the group is transporting cargo.

OPSGROUP:IsUncontrolled()

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

OPSGROUP:IsUnloading()

Check if the group is unloading cargo.

OPSGROUP:IsWaiting()

Check if group is currently waiting.

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

Set detection on or off.

OPSGROUP:MarkWaypoints(Duration)

Mark waypoints on F10 map.

OPSGROUP:MissionCancel(Mission)

Triggers the FSM event "MissionCancel".

OPSGROUP:MissionDone(Mission)

Triggers the FSM event "MissionDone".

OPSGROUP:MissionExecute(Mission)

Triggers the FSM event "MissionExecute".

OPSGROUP:MissionStart(Mission)

Triggers the FSM event "MissionStart".

OPSGROUP.Ndestroyed

Number of destroyed units.

OPSGROUP:New(group)

Create a new OPSGROUP class object.

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

Create a scheduled task.

OPSGROUP.Nhit

Number of hits taken.

OPSGROUP.Nkills

Number kills of this groups.

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

On After "DetectedGroup" event.

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

On After "DetectedGroupKnown" event.

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

On After "DetectedGroupLost" event.

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

On After "DetectedGroupNew" event.

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

On After "DetectedUnit" event.

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

On After "DetectedUnitKnown" event.

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

On After "DetectedUnitLost" event.

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

On After "DetectedUnitNew" event.

OPSGROUP:OnAfterHoverEnd(From, Event, To)

On after "HoverEnd" event.

OPSGROUP:OnAfterHoverStart(From, Event, To)

On after "HoverStart" event.

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

On after "MissionCancel" event.

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

On after "MissionDone" event.

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

On after "MissionExecute" event.

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

On after "MissionStart" event.

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

On after "TransportCancel" event.

OPSGROUP:OnEventBirth(EventData)

Event function handling the birth of a unit.

OPSGROUP:OnEventDead(EventData)

Event function handling the dead of a unit.

OPSGROUP:OnEventHit(EventData)

Event function handling the hit of a unit.

OPSGROUP:OnEventKill(EventData)

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

OPSGROUP:OnEventPlayerLeaveUnit(EventData)

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

OPSGROUP:OnEventRemoveUnit(EventData)

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

OPSGROUP:PushTask(DCSTask)

Push DCS task.

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

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

OPSGROUP:RedWeightCargo(UnitName, Weight)

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

OPSGROUP:RemoveMission(Mission)

Remove mission from queue.

OPSGROUP:RemoveTask(Task)

Remove task from task queue.

OPSGROUP:RemoveWaypoint(wpindex)

Remove a waypoint.

OPSGROUP:RemoveWaypointByID(uid)

Remove a waypoint with a ceratin UID.

OPSGROUP:RemoveWaypointMarkers(Delay)

Remove waypoints markers on the F10 map.

OPSGROUP:ReturnToLegion(Delay)

Return group back to the legion it belongs to.

OPSGROUP:Route(waypoints, delay)

Route group along waypoints.

OPSGROUP:RouteToMission(mission, delay)

Route group to mission.

OPSGROUP:SelfDestruction(Delay, ExplosionPower, ElementName)

Self destruction of group.

OPSGROUP:SetAltitude(Altitude, Keep, RadarAlt)

Set current altitude.

OPSGROUP:SetCargoBayLimit(Weight, UnitName)

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

OPSGROUP:SetCarrierLoaderAllAspect(Length, Width)

Set that this carrier is an all aspect loader.

OPSGROUP:SetCarrierLoaderBack(Length, Width)

Set that this carrier is a back loader.

OPSGROUP:SetCarrierLoaderFront(Length, Width)

Set that this carrier is a front loader.

OPSGROUP:SetCarrierLoaderPort(Length, Width)

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

OPSGROUP:SetCarrierLoaderStarboard(Length, Width)

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

OPSGROUP:SetCarrierUnloaderAllAspect(Length, Width)

Set that this carrier is an all aspect unloader.

OPSGROUP:SetCarrierUnloaderBack(Length, Width)

Set that this carrier is a back unloader.

OPSGROUP:SetCarrierUnloaderFront(Length, Width)

Set that this carrier is a front unloader.

OPSGROUP:SetCarrierUnloaderPort(Length, Width)

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

OPSGROUP:SetCarrierUnloaderStarboard(Length, Width)

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

OPSGROUP:SetCheckZones(CheckZonesSet)

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

OPSGROUP:SetDefaultAlarmstate(alarmstate)

Set the default Alarm State for the group.

OPSGROUP:SetDefaultAltitude(Altitude)

Set default cruise altitude.

OPSGROUP:SetDefaultCallsign(CallsignName, CallsignNumber)

Set default callsign.

OPSGROUP:SetDefaultEPLRS(OnOffSwitch)

Set the default EPLRS for the group.

OPSGROUP:SetDefaultEmission(OnOffSwitch)

Set the default EPLRS for the group.

OPSGROUP:SetDefaultFormation(Formation)

Set default formation.

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

Set default ICLS parameters.

OPSGROUP:SetDefaultImmortal(OnOffSwitch)

Set the default immortal for the group.

OPSGROUP:SetDefaultInvisible(OnOffSwitch)

Set the default invisible for the group.

OPSGROUP:SetDefaultROE(roe)

Set the default ROE for the group.

OPSGROUP:SetDefaultROT(rot)

Set the default ROT for the group.

OPSGROUP:SetDefaultRadio(Frequency, Modulation, OffSwitch)

Set default Radio frequency and modulation.

OPSGROUP:SetDefaultSpeed(Speed)

Set default cruise speed.

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

Set default TACAN parameters.

OPSGROUP:SetDetection(Switch)

Set detection on or off.

OPSGROUP:SetEngageDetectedOff()

Disable to automatically engage detected targets.

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

Enable to automatically engage detected targets.

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

Set LASER parameters.

OPSGROUP:SetLaserTarget(Target)

Set LASER target.

OPSGROUP:SetRearmOnOutOfAmmo()

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

OPSGROUP:SetRetreatOnOutOfAmmo()

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

OPSGROUP:SetReturnOnOutOfAmmo()

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

OPSGROUP:SetReturnToLegion(Switch)

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

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

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

OPSGROUP:SetSpeed(Speed, Keep, AltCorrected)

Set current speed.

OPSGROUP:SetTask(DCSTask)

Set DCS task.

OPSGROUP:SetVerbosity(VerbosityLevel)

Set verbosity level.

OPSGROUP:Status()

Triggers the FSM event "Status".

OPSGROUP:Stop()

Triggers the FSM event "Stop".

OPSGROUP:SwitchAlarmstate(alarmstate)

Set current Alarm State of the group.

OPSGROUP:SwitchCallsign(CallsignName, CallsignNumber)

Switch to a specific callsign.

OPSGROUP:SwitchEPLRS(OnOffSwitch)

Switch EPLRS datalink on or off.

OPSGROUP:SwitchEmission(OnOffSwitch)

Switch emission on or off.

OPSGROUP:SwitchFormation(Formation)

Switch to a specific formation.

OPSGROUP:SwitchICLS(Channel, Morse, UnitName)

Activate/switch ICLS beacon settings.

OPSGROUP:SwitchImmortal(OnOffSwitch)

Switch immortality on or off.

OPSGROUP:SwitchInvisible(OnOffSwitch)

Switch invisibility on or off.

OPSGROUP:SwitchROE(roe)

Set current ROE for the group.

OPSGROUP:SwitchROT(rot)

Set ROT for the group.

OPSGROUP:SwitchRadio(Frequency, Modulation)

Turn radio on or switch frequency/modulation.

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

Activate/switch TACAN beacon settings.

OPSGROUP.TaskStatus

OPSGROUP.TaskType

OPSGROUP:Teleport(Coordinate, Delay, NoPauseMission)

Teleport the group to a different location.

OPSGROUP.Tloading

OPSGROUP.Tpickingup

OPSGROUP.TpositionUpdate

OPSGROUP:TransportCancel(Transport)

Triggers the FSM event "TransportCancel".

OPSGROUP.Ttransporting

OPSGROUP.Tunloading

OPSGROUP:TurnOffICLS()

Deactivate ICLS beacon.

OPSGROUP:TurnOffRadio()

Turn radio off.

OPSGROUP:TurnOffTACAN()

Deactivate TACAN beacon.

OPSGROUP.Twaiting

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

OPSGROUP:_AddCargobay(CargoGroup, CarrierElement, Reserved)

Add OPSGROUP to cargo bay of a carrier.

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

Add warehouse storage to cargo bay of a carrier.

OPSGROUP:_AddElementByName(unitname)

Add a unit/element to the OPS group.

OPSGROUP:_AddMyCargoBay(MyCargo, CarrierElement)

Add storage to cargo bay of a carrier.

OPSGROUP:_AddMyLift(Transport)

Check if awaiting a transport.

OPSGROUP:_AddWaypoint(waypoint, wpnumber)

Initialize Mission Editor waypoints.

OPSGROUP:_AllSameStatus(unitname, status)

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

OPSGROUP:_AllSimilarStatus(status)

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

OPSGROUP:_CheckAmmoFull()

Check ammo is full.

OPSGROUP:_CheckAmmoStatus()

Check ammo status.

OPSGROUP:_CheckCargoTransport()

Check cargo transport assignments.

OPSGROUP:_CheckDamage()

Check damage.

OPSGROUP:_CheckDelivered(CargoTransport)

Check if all cargo of this transport assignment was delivered.

OPSGROUP:_CheckDetectedUnits()

Check detected units.

OPSGROUP:_CheckGoPickup(CargoTransport)

Check if all cargo of this transport assignment was delivered.

OPSGROUP:_CheckGroupDone(delay)

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

OPSGROUP:_CheckInZones()

Check if group is in zones.

OPSGROUP:_CheckStuck()

Check if group got stuck.

OPSGROUP:_CoordinateFromObject(Object)

Get coordinate from an object.

OPSGROUP:_CountPausedMissions()

Count paused mission.

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

Add OPSGROUP to cargo bay of a carrier.

OPSGROUP:_CreateWaypoint(Waypoint, waypoint)

Enhance waypoint table.

OPSGROUP:_DelCargobay(CargoGroup)

Remove OPSGROUP from cargo bay of a carrier.

OPSGROUP:_DelCargobayElement(Element, MyCargo)

Remove OPSGROUP from cargo bay of a carrier.

OPSGROUP:_DelMyLift(Transport)

Remove my lift.

OPSGROUP:_GetCargobay(CargoGroup)

Get cargo bay item.

OPSGROUP:_GetCargobayElement(Element, CargoUID)

Remove OPSGROUP from cargo bay of a carrier.

OPSGROUP:_GetDetectedTarget()

Get target group.

OPSGROUP:_GetElementZoneLoader(Element, Zone, Loader)

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

OPSGROUP:_GetMyCargoBayFromUID(uid)

Get cargo bay data from a cargo data id.

OPSGROUP:_GetMyCarrier()

Get my carrier.

OPSGROUP:_GetMyCarrierElement()

Get my carrier element.

OPSGROUP:_GetMyCarrierGroup()

Get my carrier group.

OPSGROUP:_GetNextCargoTransport()

Get cargo transport from cargo queue.

OPSGROUP:_GetNextMission()

Get next mission.

OPSGROUP:_GetNextTask()

Get next task in queue.

OPSGROUP:_GetPausedMission()

Get paused mission.

OPSGROUP:_GetROEName(roe)

Get name of ROE corresponding to the numerical value.

OPSGROUP:_GetTemplate(Copy)

Get the template of the group.

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

Get weight of warehouse storage to transport.

OPSGROUP:_InitWaypoints(WpIndexMin, WpIndexMax)

Initialize Mission Editor waypoints.

OPSGROUP:_IsElement(unitname)

Check if a unit is an element of the flightgroup.

OPSGROUP:_IsInCargobay(OpsGroup)

Check if a group is in the cargo bay.

OPSGROUP:_IsMyCarrierReserved()

Is my carrier reserved.

OPSGROUP:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

OPSGROUP:_NewCargoStatus(Status)

Set (new) cargo status.

OPSGROUP:_NewCarrierStatus(Status)

Set (new) carrier status.

OPSGROUP:_PassedFinalWaypoint(final, comment)

Set passed final waypoint value.

OPSGROUP._PassingWaypoint(opsgroup, uid)

Function called when a group is passing a waypoint.

OPSGROUP:_PrintTaskAndMissionStatus()

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

OPSGROUP:_QueueUpdate()

On after "QueueUpdate" event.

OPSGROUP:_RemoveMissionWaypoints(Mission, Silently)

On after "MissionDone" event.

OPSGROUP:_RemoveMyCarrier()

Remove my carrier.

OPSGROUP:_RemovePausedMission(AuftragsNummer)

Remove paused mission from the table.

OPSGROUP:_Respawn(Delay, Template, Reset)

Respawn the group.

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

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

OPSGROUP:_SetElementStatusAll(status)

Set status for all elements (except dead ones).

OPSGROUP:_SetLegion(Legion)

Set legion this ops group belongs to.

OPSGROUP:_SetMissionOptions(mission)

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

OPSGROUP:_SetMyCarrier(CarrierGroup, CarrierElement, Reserved)

Set my carrier.

OPSGROUP:_SetTemplate(Template)

Set the template of the group.

OPSGROUP:_SetWaypointTasks(Waypoint)

Set tasks at this waypoint

OPSGROUP:_SimpleTaskFunction(Function, uid)

Simple task function.

OPSGROUP:_SortCargo(Cargos)

On after "Loading" event.

OPSGROUP:_SortTaskQueue()

Sort task queue.

OPSGROUP:_SwitchICLS(Icls)

Activate/switch ICLS beacon settings.

OPSGROUP:_SwitchTACAN(Tacan)

Activate/switch TACAN beacon settings.

OPSGROUP._TaskDone(group, opsgroup, task)

Function called when a task is done.

OPSGROUP._TaskExecute(group, opsgroup, task)

Function called when a task is executed.

OPSGROUP:_TransferCargo(CargoGroup, CarrierGroup, CarrierElement)

Transfer cargo from to another carrier.

OPSGROUP:_UpdateLaser()

Update laser point.

OPSGROUP:_UpdatePosition()

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

OPSGROUP:_UpdateStatus(element, newstatus, airbase)

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

OPSGROUP:_UpdateTask(Task, Mission)

Update (DCS) task.

OPSGROUP:_UpdateWaypointTasks(n)

Initialize Mission Editor waypoints.

OPSGROUP:__MissionCancel(delay, Mission)

Triggers the FSM event "MissionCancel" after a delay.

OPSGROUP:__MissionDone(delay, Mission)

Triggers the FSM event "MissionDone" after a delay.

OPSGROUP:__MissionExecute(delay, Mission)

Triggers the FSM event "MissionExecute" after a delay.

OPSGROUP:__MissionStart(delay, Mission)

Triggers the FSM event "MissionStart" after a delay.

OPSGROUP:__Status(delay)

Triggers the FSM event "Status" after a delay.

OPSGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

OPSGROUP:__TransportCancel(delay, Transport)

Triggers the FSM event "TransportCancel" after a delay.

OPSGROUP.actype

OPSGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

OPSGROUP.altitudeCruise

OPSGROUP.ammo

Initial ammount of ammo.

OPSGROUP.attribute

Generalized attribute.

OPSGROUP.callsign

Current callsign settings.

OPSGROUP.callsignAlias

Callsign alias.

OPSGROUP.callsignDefault

Default callsign settings.

OPSGROUP.callsignName

Callsign name.

OPSGROUP.cargoBay

Table containing OPSGROUP loaded into this group.

OPSGROUP.cargoStatus

Cargo status of this group acting as cargo.

OPSGROUP.cargoTZC

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

OPSGROUP.cargoTransport

Current cargo transport assignment.

OPSGROUP.cargoTransportUID

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

OPSGROUP.cargoqueue

Table containing cargo groups to be transported.

OPSGROUP.carrier

Carrier the group is loaded into as cargo.

OPSGROUP.carrierGroup

Carrier group transporting this group as cargo.

OPSGROUP.carrierLoader

Carrier loader parameters.

OPSGROUP.carrierStatus

Carrier status of this group acting as cargo carrier.

OPSGROUP.carrierUnloader

Carrier unloader parameters.

OPSGROUP.category

OPSGROUP.ceiling

OPSGROUP.checkzones

Set of zones.

OPSGROUP.cohort

Cohort the group belongs to.

OPSGROUP.controller

The DCS controller of the group.

OPSGROUP.coordinate

Current coordinate.

OPSGROUP.currbase

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

OPSGROUP.currentmission

The ID (auftragsnummer) of the currently assigned AUFTRAG.

OPSGROUP.currentwp

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

OPSGROUP.dTpositionUpdate

OPSGROUP.dTwait

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

OPSGROUP.dcsgroup

The DCS group object.

OPSGROUP.descriptors

OPSGROUP.destbase

The destination base of the flight group.

OPSGROUP.destzone

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

OPSGROUP.detectedgroups

Set of detected groups.

OPSGROUP.detectedunits

Set of detected units.

OPSGROUP.detectionOn

If true, detected units of the group are analyzed.

OPSGROUP.elements

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

OPSGROUP.engagedetectedEngageZones

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

OPSGROUP.engagedetectedNoEngageZones

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

OPSGROUP.engagedetectedOn

If true, auto engage detected targets.

OPSGROUP.engagedetectedRmax

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

OPSGROUP.engagedetectedTypes

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

OPSGROUP.group

Group object.

OPSGROUP.groupinitialized

If true, group parameters were initialized.

OPSGROUP.groupname

Name of the group.

OPSGROUP.heading

Heading of the group at last status check.

OPSGROUP.headingLast

Backup of last heading to monitor changes.

OPSGROUP.homebase

The home base of the flight group.

OPSGROUP.homezone

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

OPSGROUP.icls

Current ICLS settings.

OPSGROUP.iclsDefault

Default ICLS settings.

OPSGROUP.inzones

Set of zones in which the group is currently in.

OPSGROUP.isAI

If true, group is purely AI.

OPSGROUP.isArmygroup

Is an ARMYGROUP.

OPSGROUP.isDead

If true, the whole group is dead.

OPSGROUP.isDestroyed

If true, the whole group was destroyed.

OPSGROUP.isEPLRS

OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

OPSGROUP.isHelo

If true, this is a helicopter group.

OPSGROUP.isLandingAtAirbase

OPSGROUP.isLateActivated

Is the group late activated.

OPSGROUP.isMobile

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

OPSGROUP.isNavygroup

Is a NAVYGROUP.

OPSGROUP.isSubmarine

If true, this is a submarine group.

OPSGROUP.isTrain

OPSGROUP.isUncontrolled

Is the group uncontrolled.

OPSGROUP.isVTOL

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

OPSGROUP.ispathfinding

If true, group is on pathfinding route.

OPSGROUP.legion

Legion the group belongs to.

OPSGROUP.legionReturn

OPSGROUP.lid

Class id string for output to DCS log file.

OPSGROUP.life

OPSGROUP.missionqueue

Queue of missions.

OPSGROUP.msrs

MOOSE SRS wrapper.

OPSGROUP.mycarrier

Carrier group for this group.

OPSGROUP.mylifts

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

On after "Board" event.

OPSGROUP:onafterDamaged(From, Event, To)

On after "Damaged" event.

OPSGROUP:onafterDead(From, Event, To)

On after "Dead" event.

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

On after "Delivered" event.

OPSGROUP:onafterDestroyed(From, Event, To)

On after "Destroyed" event.

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

On after "DetectedGroup" event.

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

On after "DetectedGroupNew" event.

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

On after "DetectedUnit" event.

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

On after "DetectedUnitNew" event.

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

On after "ElementDamaged" event.

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

On after "ElementDead" event.

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

On after "ElementDestroyed" event.

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

On after "ElementHit" event.

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

On after "ElementInUtero" event.

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

On after "EnterZone" event.

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

On after "GotoWaypoint" event.

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

On after "Hit" event.

OPSGROUP:onafterInUtero(From, Event, To)

On after "InUtero" event.

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

On after "LaserCode" event.

OPSGROUP:onafterLaserGotLOS(From, Event, To)

On after "LaserGotLOS" event.

OPSGROUP:onafterLaserLostLOS(From, Event, To)

On after "LaserLostLOS" event.

OPSGROUP:onafterLaserOff(From, Event, To)

On after "LaserOff" event.

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

On after "LaserOn" event.

OPSGROUP:onafterLaserPause(From, Event, To)

On after "LaserPause" event.

OPSGROUP:onafterLaserResume(From, Event, To)

On after "LaserResume" event.

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

On after "LeaveZone" event.

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

On after "Load" event.

OPSGROUP:onafterLoading(From, Event, To)

On after "Loading" event.

OPSGROUP:onafterLoadingDone(From, Event, To)

On after "LoadingDone" event.

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

On after "MissionCancel" event.

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

On after "MissionDone" event.

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

On after "MissionExecute" event.

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

On after "MissionStart" event.

OPSGROUP:onafterOutOfAmmo(From, Event, To)

On after "OutOfAmmo" event.

OPSGROUP:onafterPassedFinalWaypoint(From, Event, To)

On after "PassedFinalWaypoint" event.

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

On after "PassingWaypoint" event.

OPSGROUP:onafterPauseMission(From, Event, To)

On after "PauseMission" event.

OPSGROUP:onafterPickup(From, Event, To)

On after "Pickup" event.

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

On after "Respawn" event.

OPSGROUP:onafterStop(From, Event, To)

On after "Stop" event.

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

On after "TaskCancel" event.

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

On after "TaskDone" event.

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

On after "TaskExecute" event.

OPSGROUP:onafterTransport(From, Event, To)

On after "Transport" event.

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

On after "TransportCancel" event.

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

On after "Unload" event.

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

On after "Unloaded" event.

OPSGROUP:onafterUnloading(From, Event, To)

On after "Unloading" event.

OPSGROUP:onafterUnloadingDone(From, Event, To)

On after "UnloadingDone" event.

OPSGROUP:onafterUnpauseMission(From, Event, To)

On after "UnpauseMission" event.

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

On after "Wait" event.

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

On before "Board" event.

OPSGROUP:onbeforeDead(From, Event, To)

On before "Dead" event.

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

On before "ElementSpawned" event.

OPSGROUP:onbeforeLaserOff(From, Event, To)

On before "LaserOff" event.

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

On before "LaserOn" event.

OPSGROUP:onbeforeLaserResume(From, Event, To)

On before "LaserResume" event.

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

On before "MissionStart" event.

OPSGROUP:onbeforeStop(From, Event, To)

On before "Stop" event.

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

On before "TaskDone" event.

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

On before "TaskExecute" event.

OPSGROUP:onbeforeTransport(From, Event, To)

On before "Transport" event.

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

On before "Unload" event.

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

On before "Wait" event.

OPSGROUP.option

Current optional settings.

OPSGROUP.optionDefault

Default option settings.

OPSGROUP.orientX

Orientation at last status check.

OPSGROUP.orientXLast

Backup of last orientation to monitor changes.

OPSGROUP.outofAmmo

OPSGROUP.outofBombs

OPSGROUP.outofGuns

OPSGROUP.outofMissiles

OPSGROUP.outofMissilesAA

OPSGROUP.outofMissilesAG

OPSGROUP.outofMissilesAS

OPSGROUP.outofRockets

OPSGROUP.outofTorpedos

OPSGROUP.passedfinalwp

Group has passed the final waypoint.

OPSGROUP.pausedmissions

Paused missions.

OPSGROUP.position

Position of the group at last status check.

OPSGROUP.positionLast

Backup of last position vec to monitor changes.

OPSGROUP.radio

Current radio settings.

OPSGROUP.radioDefault

Default radio settings.

OPSGROUP.radioQueue

Radio queue.

OPSGROUP.rangemax

OPSGROUP.rearmOnOutOfAmmo

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

OPSGROUP.reconindecies

OPSGROUP.refueltype

OPSGROUP.retreatOnOutOfAmmo

OPSGROUP.rtzOnOutOfAmmo

OPSGROUP.scheduleIDDespawn

OPSGROUP.speed

OPSGROUP.speedCruise

Cruising speed in km/h.

OPSGROUP.speedMax

Max speed in km/h.

OPSGROUP.speedWp

Speed to the next waypoint in m/s.

OPSGROUP.spot

Laser and IR spot.

OPSGROUP.stuckTimestamp

OPSGROUP.stuckVec3

OPSGROUP.tacan

Current TACAN settings.

OPSGROUP.tacanDefault

Default TACAN settings.

OPSGROUP.tankertype

OPSGROUP.taskcounter

Running number of task ids.

OPSGROUP.taskcurrent

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

OPSGROUP.taskenroute

Enroute task of the group.

OPSGROUP.taskpaused

Paused tasks.

OPSGROUP.taskqueue

Queue of tasks.

OPSGROUP.template

Template table of the group.

OPSGROUP.timerCheckZone

Timer for check zones.

OPSGROUP.timerQueueUpdate

Timer for queue updates.

OPSGROUP.timerStatus

Timer for status update.

OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

OPSGROUP.travelds

OPSGROUP.traveltime

Time.

OPSGROUP.useMEtasks

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

OPSGROUP.useSRS

Use SRS for transmissions.

OPSGROUP.velocity

OPSGROUP.velocityLast

OPSGROUP.verbose

Verbosity level. 0=silent.

OPSGROUP.version

OpsGroup version.

OPSGROUP.waypoints

Table of waypoints.

OPSGROUP.waypoints0

Table of initial waypoints.

OPSGROUP.weaponData

Weapon data table with key=BitType.

OPSGROUP.wpcounter

Running number counting waypoints.

Fields and Methods inherited from FSM Description

OPSGROUP:AddEndState(State)

Adds an End state.

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

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

OPSGROUP:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

OPSGROUP:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

OPSGROUP.CallScheduler

Call scheduler.

OPSGROUP.ClassName

Name of the class.

OPSGROUP.Events

OPSGROUP:GetCurrentState()

Get current state.

OPSGROUP:GetEndStates()

Returns the End states.

OPSGROUP:GetProcess(From, Event)

OPSGROUP:GetProcesses()

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

OPSGROUP:GetScores()

Returns a table with the scores defined.

OPSGROUP:GetStartState()

Returns the start state of the FSM.

OPSGROUP:GetState()

Get current state.

OPSGROUP:GetSubs()

Returns a table with the Subs defined.

OPSGROUP:GetTransitions()

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

OPSGROUP:Is(State)

Check if FSM is in state.

OPSGROUP:LoadCallBacks(CallBackTable)

Load call backs.

OPSGROUP:New()

Creates a new FSM object.

OPSGROUP.Scores

Scores.

OPSGROUP:SetProcess(From, Event, Fsm)

OPSGROUP:SetStartState(State)

Sets the start state of the FSM.

OPSGROUP._EndStates

OPSGROUP._EventSchedules

OPSGROUP._Processes

OPSGROUP._Scores

OPSGROUP._StartState

OPSGROUP._Transitions

OPSGROUP:_add_to_map(Map, Event)

Add to map.

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

Call handler.

OPSGROUP:_create_transition(EventName)

Create transition.

OPSGROUP:_delayed_transition(EventName)

Delayed transition.

OPSGROUP:_eventmap(Events, EventStructure)

Event map.

OPSGROUP:_gosub(ParentFrom, ParentEvent)

Go sub.

OPSGROUP:_handler(EventName, ...)

Handler.

OPSGROUP:_isendstate(Current)

Is end state.

OPSGROUP:_submap(subs, sub, name)

Sub maps.

OPSGROUP:can(e)

Check if can do an event.

OPSGROUP:cannot(e)

Check if cannot do an event.

OPSGROUP.current

Current state name.

OPSGROUP.endstates

OPSGROUP:is(State, state)

Check if FSM is in state.

OPSGROUP.options

Options.

OPSGROUP.subs

Subs.

Fields and Methods inherited from BASE Description

OPSGROUP.ClassID

The ID number of the class.

OPSGROUP.ClassName

The name of the class.

OPSGROUP.ClassNameAndID

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

OPSGROUP:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

OPSGROUP:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

OPSGROUP:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

OPSGROUP:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

OPSGROUP:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

OPSGROUP:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

OPSGROUP:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

OPSGROUP:E(Arguments)

Log an exception which will be traced always.

OPSGROUP:EventDispatcher()

Returns the event dispatcher

OPSGROUP:EventRemoveAll()

Remove all subscribed events

OPSGROUP:F(Arguments)

Trace a function call.

OPSGROUP:F2(Arguments)

Trace a function call level 2.

OPSGROUP:F3(Arguments)

Trace a function call level 3.

OPSGROUP:GetClassID()

Get the ClassID of the class instance.

OPSGROUP:GetClassName()

Get the ClassName of the class instance.

OPSGROUP:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

OPSGROUP:GetEventPriority()

Get the Class Core.Event processing Priority.

OPSGROUP:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

OPSGROUP:GetState(Object, Key)

Get a Value given a Key from the Object.

OPSGROUP:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

OPSGROUP:I(Arguments)

Log an information which will be traced always.

OPSGROUP:Inherit(Child, Parent)

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

OPSGROUP:IsInstanceOf(ClassName)

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

OPSGROUP:IsTrace()

Enquires if tracing is on (for the class).

OPSGROUP:New()

BASE constructor.

OPSGROUP:OnEvent(EventData)

Occurs when an Event for an object is triggered.

OPSGROUP:OnEventBDA(EventData)

BDA.

OPSGROUP:OnEventBaseCaptured(EventData)

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

OPSGROUP:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

OPSGROUP:OnEventCrash(EventData)

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

OPSGROUP:OnEventDead(EventData)

Occurs when an object is dead.

OPSGROUP:OnEventDetailedFailure(EventData)

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

OPSGROUP:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

OPSGROUP:OnEventEjection(EventData)

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

OPSGROUP:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

OPSGROUP:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

OPSGROUP:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

OPSGROUP:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

OPSGROUP:OnEventKill(EventData)

Occurs on the death of a unit.

OPSGROUP:OnEventLand(EventData)

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

OPSGROUP:OnEventLandingAfterEjection(EventData)

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

OPSGROUP:OnEventLandingQualityMark(EventData)

Landing quality mark.

OPSGROUP:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

OPSGROUP:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

OPSGROUP:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

OPSGROUP:OnEventMissionEnd(EventData)

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

OPSGROUP:OnEventMissionStart(EventData)

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

OPSGROUP:OnEventParatrooperLanding(EventData)

Weapon add.

OPSGROUP:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

OPSGROUP:OnEventPlayerEnterAircraft(EventData)

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

OPSGROUP:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

OPSGROUP:OnEventPlayerLeaveUnit(EventData)

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

OPSGROUP:OnEventRefueling(EventData)

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

OPSGROUP:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

OPSGROUP:OnEventScore(EventData)

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

OPSGROUP:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

OPSGROUP:OnEventShootingStart(EventData)

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

OPSGROUP:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

OPSGROUP:OnEventTakeoff(EventData)

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

OPSGROUP:OnEventTriggerZone(EventData)

Trigger zone.

OPSGROUP:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

OPSGROUP:ScheduleStop(SchedulerID)

Stops the Schedule.

OPSGROUP.Scheduler

OPSGROUP:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

OPSGROUP:SetState(Object, Key, Value)

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

OPSGROUP:T(Arguments)

Trace a function logic level 1.

OPSGROUP:T2(Arguments)

Trace a function logic level 2.

OPSGROUP:T3(Arguments)

Trace a function logic level 3.

OPSGROUP:TraceAll(TraceAll)

Trace all methods in MOOSE

OPSGROUP:TraceClass(Class)

Set tracing for a class

OPSGROUP:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

OPSGROUP:TraceLevel(Level)

Set trace level

OPSGROUP:TraceOff()

Set trace off.

OPSGROUP:TraceOn()

Set trace on.

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

OPSGROUP:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

OPSGROUP._

OPSGROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

OPSGROUP:_Serialize(Arguments)

(Internal) Serialize arguments

OPSGROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

OPSGROUP.__

OPSGROUP:onEvent(event)

The main event handling function...

Fields and Methods inherited from OPSGROUP.Ammo Description

OPSGROUP.Ammo.Bombs

Amount of bombs.

OPSGROUP.Ammo.Guns

Amount of gun shells.

OPSGROUP.Ammo.Missiles

Amount of missiles.

OPSGROUP.Ammo.MissilesAA

Amount of air-to-air missiles.

OPSGROUP.Ammo.MissilesAG

Amount of air-to-ground missiles.

OPSGROUP.Ammo.MissilesAS

Amount of anti-ship missiles.

OPSGROUP.Ammo.MissilesBM

Amount of ballistic missiles.

OPSGROUP.Ammo.MissilesCR

Amount of cruise missiles.

OPSGROUP.Ammo.MissilesSA

Amount of surfe-to-air missiles.

OPSGROUP.Ammo.Rockets

Amount of rockets.

OPSGROUP.Ammo.Torpedos

Amount of torpedos.

OPSGROUP.Ammo.Total

Total amount of ammo.

Fields and Methods inherited from OPSGROUP.Beacon Description

OPSGROUP.Beacon.Band

Band "X" or "Y" for TACAN beacon.

OPSGROUP.Beacon.BeaconName

Name of the unit acting as beacon.

OPSGROUP.Beacon.BeaconUnit

Unit object acting as beacon.

OPSGROUP.Beacon.Channel

Channel.

OPSGROUP.Beacon.Morse

Morse Code.

OPSGROUP.Beacon.On

If true, beacon is on, if false, beacon is turned off. If nil, has not been used yet.

Fields and Methods inherited from OPSGROUP.Callsign Description

OPSGROUP.Callsign.NameSquad

Name of the squad, e.g. "Uzi".

OPSGROUP.Callsign.NumberGroup

Group number. First number after name, e.g. "Uzi-1-1".

OPSGROUP.Callsign.NumberSquad

Squadron number corresponding to a name like "Uzi".

Fields and Methods inherited from OPSGROUP.CargoGroup Description

OPSGROUP.CargoGroup.delivered

If true, group was delivered.

OPSGROUP.CargoGroup.disembarkActivation

If true, group is activated. If false, group is late activated.

OPSGROUP.CargoGroup.disembarkCarriers

Carriers where this group is directly disembared to.

OPSGROUP.CargoGroup.disembarkZone

Zone where this group is disembarked to.

OPSGROUP.CargoGroup.opsgroup

The cargo opsgroup.

OPSGROUP.CargoGroup.status

Status of the cargo group. Not used yet.

OPSGROUP.CargoGroup.storage

Storage data.

OPSGROUP.CargoGroup.type

Type of cargo: "OPSGROUP" or "STORAGE".

OPSGROUP.CargoGroup.uid

Unique ID of this cargo data.

Fields and Methods inherited from OPSGROUP.CargoStatus Description

OPSGROUP.CargoStatus.ASSIGNED

Cargo is assigned to a carrier. (Not used!)

OPSGROUP.CargoStatus.AWAITING

Group is awaiting carrier.

OPSGROUP.CargoStatus.BOARDING

Cargo is boarding a carrier.

OPSGROUP.CargoStatus.LOADED

Cargo is loaded into a carrier.

OPSGROUP.CargoStatus.NOTCARGO

This group is no cargo yet.

Fields and Methods inherited from OPSGROUP.CarrierLoader Description

OPSGROUP.CarrierLoader.length

Length of (un-)loading zone in meters.

OPSGROUP.CarrierLoader.type

Loader type "Front", "Back", "Left", "Right", "All".

OPSGROUP.CarrierLoader.width

Width of (un-)loading zone in meters.

Fields and Methods inherited from OPSGROUP.CarrierStatus Description

OPSGROUP.CarrierStatus.LOADED

Carrier has loaded cargo.

OPSGROUP.CarrierStatus.LOADING

Carrier is loading cargo.

OPSGROUP.CarrierStatus.NOTCARRIER

This group is not a carrier yet.

OPSGROUP.CarrierStatus.PICKUP

Carrier is on its way to pickup cargo.

OPSGROUP.CarrierStatus.TRANSPORTING

Carrier is transporting cargo.

OPSGROUP.CarrierStatus.UNLOADING

Carrier is unloading cargo.

Fields and Methods inherited from OPSGROUP.Element Description

OPSGROUP.Element.DCSunit

The DCS unit object.

OPSGROUP.Element.Nhit

Number of times the element was hit.

OPSGROUP.Element.ai

If true, element is AI.

OPSGROUP.Element.callsign

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

OPSGROUP.Element.cargoBay

Cargo bay.

OPSGROUP.Element.category

Aircraft category.

OPSGROUP.Element.categoryname

Aircraft category name.

OPSGROUP.Element.client

The client if element is occupied by a human player.

OPSGROUP.Element.controller

The DCS controller of the unit.

OPSGROUP.Element.damage

Damage of element in percent.

OPSGROUP.Element.descriptors

Descriptors table.

OPSGROUP.Element.engineOn

If true, engines were started.

OPSGROUP.Element.fuelmass

Mass of fuel in kg.

OPSGROUP.Element.group

The GROUP object.

OPSGROUP.Element.heading

Last known heading in degrees.

OPSGROUP.Element.height

Height of element in meters.

OPSGROUP.Element.length

Length of element in meters.

OPSGROUP.Element.life

Life points when last updated.

OPSGROUP.Element.life0

Initial life points.

OPSGROUP.Element.modex

Tail number.

OPSGROUP.Element.name

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

OPSGROUP.Element.orientX

Last known ordientation vector in the direction of the nose X.

OPSGROUP.Element.parking

The parking spot table the element is parking on.

OPSGROUP.Element.playerName

Name of player if this is a client.

OPSGROUP.Element.pylons

Table of pylons.

OPSGROUP.Element.size

Size (max of length, width, height) in meters.

OPSGROUP.Element.skill

Skill level.

OPSGROUP.Element.status

The element status. See OPSGROUP.ElementStatus.

OPSGROUP.Element.typename

Type name.

OPSGROUP.Element.unit

The UNIT object.

OPSGROUP.Element.vec3

Last known 3D position vector.

OPSGROUP.Element.weight

Current weight including cargo in kg.

OPSGROUP.Element.weightCargo

Current cargo weight in kg.

OPSGROUP.Element.weightEmpty

Empty weight in kg.

OPSGROUP.Element.weightMaxCargo

Max. cargo weight in kg.

OPSGROUP.Element.weightMaxTotal

Max. total weight in kg.

OPSGROUP.Element.width

Width of element in meters.

OPSGROUP.Element.zoneBoundingbox

Bounding box zone of the element unit.

OPSGROUP.Element.zoneLoad

Loading zone.

OPSGROUP.Element.zoneUnload

Unloading zone.

Fields and Methods inherited from OPSGROUP.ElementStatus Description

OPSGROUP.ElementStatus.AIRBORNE

Element is airborne. Either after takeoff or after air start.

OPSGROUP.ElementStatus.ARRIVED

Element arrived at its parking spot and shut down its engines.

OPSGROUP.ElementStatus.DEAD

Element is dead after it crashed, pilot ejected or pilot dead events.

OPSGROUP.ElementStatus.ENGINEON

Element started its engines.

OPSGROUP.ElementStatus.INUTERO

Element was not spawned yet or its status is unknown so far.

OPSGROUP.ElementStatus.LANDED

Element landed and is taxiing to its parking spot.

OPSGROUP.ElementStatus.LANDING

Element is landing.

OPSGROUP.ElementStatus.PARKING

Element is parking after spawned on ramp.

OPSGROUP.ElementStatus.SPAWNED

Element was spawned into the world.

OPSGROUP.ElementStatus.TAKEOFF

Element took of after takeoff event.

OPSGROUP.ElementStatus.TAXIING

Element is taxiing after engine startup.

Fields and Methods inherited from OPSGROUP.GroupStatus Description

OPSGROUP.GroupStatus.AIRBORNE

Element is airborne. Either after takeoff or after air start.

OPSGROUP.GroupStatus.ARRIVED

Arrived at its parking spot and shut down its engines.

OPSGROUP.GroupStatus.DEAD

Element is dead after it crashed, pilot ejected or pilot dead events.

OPSGROUP.GroupStatus.INBOUND

OPSGROUP.GroupStatus.INUTERO

Not spawned yet or its status is unknown so far.

OPSGROUP.GroupStatus.LANDED

Landed and is taxiing to its parking spot.

OPSGROUP.GroupStatus.LANDING

Landing.

OPSGROUP.GroupStatus.PARKING

Parking after spawned on ramp.

OPSGROUP.GroupStatus.TAXIING

Taxiing after engine startup.

Fields and Methods inherited from OPSGROUP.MyCargo Description

OPSGROUP.MyCargo.cargoUID

OPSGROUP.MyCargo.group

The cargo group.

OPSGROUP.MyCargo.reserved

If true, the cargo bay space is reserved but cargo has not actually been loaded yet.

OPSGROUP.MyCargo.storageAmount

Amount of storage.

OPSGROUP.MyCargo.storageType

Type of storage.

OPSGROUP.MyCargo.storageWeight

Weight of storage item.

Fields and Methods inherited from OPSGROUP.MyCarrier Description

OPSGROUP.MyCarrier.element

The carrier element.

OPSGROUP.MyCarrier.group

The carrier group.

OPSGROUP.MyCarrier.reserved

If true, the carrier has caro space reserved for me.

Fields and Methods inherited from OPSGROUP.Option Description

OPSGROUP.Option.Alarm

Alarm state.

OPSGROUP.Option.Disperse

Disperse under fire.

OPSGROUP.Option.EPLRS

data link.

OPSGROUP.Option.Emission

Emission on/off.

OPSGROUP.Option.Formation

Formation.

OPSGROUP.Option.Immortal

Immortal on/off.

OPSGROUP.Option.Invisible

Invisible on/off.

OPSGROUP.Option.ROE

Rule of engagement.

OPSGROUP.Option.ROT

Reaction on threat.

Fields and Methods inherited from OPSGROUP.Radio Description

OPSGROUP.Radio.Freq

Frequency

OPSGROUP.Radio.Modu

Modulation.

OPSGROUP.Radio.On

If true, radio is on, if false, radio is turned off. If nil, has not been used yet.

Fields and Methods inherited from OPSGROUP.Spawnpoint Description

OPSGROUP.Spawnpoint.Airport

Airport where to spawn.

OPSGROUP.Spawnpoint.Coordinate

Coordinate where to spawn

OPSGROUP.Spawnpoint.TerminalIDs

Terminal IDs, where to spawn the group. It is a table of #numbers because a group can consist of multiple units.

Fields and Methods inherited from OPSGROUP.Spot Description

OPSGROUP.Spot.CheckLOS

If true, check LOS to target.

OPSGROUP.Spot.Code

Laser code.

OPSGROUP.Spot.Coordinate

where the spot is pointing.

OPSGROUP.Spot.IR

Infra-red spot.

OPSGROUP.Spot.IRon

If true, turn IR pointer on.

OPSGROUP.Spot.LOS

OPSGROUP.Spot.Laser

Laser spot.

OPSGROUP.Spot.On

If true, the laser is on.

OPSGROUP.Spot.Paused

If true, laser is paused.

OPSGROUP.Spot.TargetGroup

The target group.

OPSGROUP.Spot.TargetType

Type of target: 0=coordinate, 1=static, 2=unit, 3=group.

OPSGROUP.Spot.TargetUnit

The current target unit.

OPSGROUP.Spot.dt

Update time interval in seconds.

OPSGROUP.Spot.element

The element of the group that is lasing.

OPSGROUP.Spot.lostLOS

If true, laser lost LOS.

OPSGROUP.Spot.offset

Local offset of the laser source.

OPSGROUP.Spot.offsetTarget

Offset of the target.

OPSGROUP.Spot.timer

Spot timer.

OPSGROUP.Spot.vec3

The 3D positon vector of the laser (and IR) spot.

Fields and Methods inherited from OPSGROUP.Task Description

OPSGROUP.Task.backupROE

Rules of engagement that are restored once the task is over.

OPSGROUP.Task.dcstask

DCS task structure.

OPSGROUP.Task.description

Brief text which describes the task.

OPSGROUP.Task.duration

Duration before task is cancelled in seconds. Default never.

OPSGROUP.Task.id

Task ID. Running number to get the task.

OPSGROUP.Task.ismission

This is an AUFTRAG task.

OPSGROUP.Task.prio

Priority.

OPSGROUP.Task.status

Task status.

OPSGROUP.Task.stopflag

If flag is set to 1 (=true), the task is stopped.

OPSGROUP.Task.target

Target object.

OPSGROUP.Task.time

Abs. mission time when to execute the task.

OPSGROUP.Task.timestamp

Abs. mission time, when task was started.

OPSGROUP.Task.type

Type of task: either SCHEDULED or WAYPOINT.

OPSGROUP.Task.waypoint

Waypoint index if task is a waypoint task.

Fields and Methods inherited from OPSGROUP.TaskStatus Description

OPSGROUP.TaskStatus.DONE

Task is done.

OPSGROUP.TaskStatus.EXECUTING

Task is being executed.

OPSGROUP.TaskStatus.PAUSED

Task is paused.

OPSGROUP.TaskStatus.SCHEDULED

Task is scheduled.

Fields and Methods inherited from OPSGROUP.TaskType Description

OPSGROUP.TaskType.SCHEDULED

Task is scheduled and will be executed at a given time.

OPSGROUP.TaskType.WAYPOINT

Task is executed at a specific waypoint.

Fields and Methods inherited from OPSGROUP.Waypoint Description

OPSGROUP.Waypoint.action

Waypoint action (turning point, etc.). Ground groups have the formation here.

OPSGROUP.Waypoint.alt

Altitude in meters. For submaries use negative sign for depth.

OPSGROUP.Waypoint.astar

If true, this waypint was found by A* pathfinding algorithm.

OPSGROUP.Waypoint.coordinate

Waypoint coordinate.

OPSGROUP.Waypoint.detour

Signifies that this waypoint is not part of the normal route: 0=Hold, 1=Resume Route.

OPSGROUP.Waypoint.formation

Ground formation. Similar to action but on/off road.

OPSGROUP.Waypoint.intowind

If true, this waypoint is a turn into wind route point.

OPSGROUP.Waypoint.marker

Marker on the F10 map.

OPSGROUP.Waypoint.missionUID

Mission UID (Auftragsnr) this waypoint belongs to.

OPSGROUP.Waypoint.name

Waypoint description. Shown in the F10 map.

OPSGROUP.Waypoint.npassed

Number of times a groups passed this waypoint.

OPSGROUP.Waypoint.patrol

OPSGROUP.Waypoint.roadcoord

Closest point to road.

OPSGROUP.Waypoint.roaddist

Distance to closest point on road.

OPSGROUP.Waypoint.speed

Speed in m/s.

OPSGROUP.Waypoint.task

Waypoint DCS task combo.

OPSGROUP.Waypoint.temp

If true, this is a temporary waypoint and will be deleted when passed. Also the passing waypoint FSM event is not triggered.

OPSGROUP.Waypoint.type

Waypoint type.

OPSGROUP.Waypoint.uid

Waypoint's unit id, which is a running number.

OPSGROUP.Waypoint.x

Waypoint x-coordinate.

OPSGROUP.Waypoint.y

Waypoint y-coordinate.

Fields and Methods inherited from OPSGROUP.WeaponData Description

OPSGROUP.WeaponData.BitType

Type of weapon.

OPSGROUP.WeaponData.RangeMax

Max range in meters.

OPSGROUP.WeaponData.RangeMin

Min range in meters.

OPSGROUP.WeaponData.ReloadTime

Time to reload in seconds.

OPSGROUP class.

Field(s)

#string OPSGROUP.ClassName

Name of the class.

#number OPSGROUP.Ndestroyed

Number of destroyed units.

#number OPSGROUP.Nhit

Number of hits taken.

#number OPSGROUP.Nkills

Number kills of this groups.

#number OPSGROUP.Twaiting

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

OPSGROUP.actype

Set type name.

#boolean OPSGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

#OPSGROUP.Ammo OPSGROUP.ammo

Initial ammount of ammo.

#string OPSGROUP.attribute

Generalized attribute.

#OPSGROUP.Callsign OPSGROUP.callsign

Current callsign settings.

#string OPSGROUP.callsignAlias

Callsign alias.

#OPSGROUP.Callsign OPSGROUP.callsignDefault

Default callsign settings.

#string OPSGROUP.callsignName

Callsign name.

#table OPSGROUP.cargoBay

Table containing OPSGROUP loaded into this group.

#string OPSGROUP.cargoStatus

Cargo status of this group acting as cargo.

Ops.OpsTransport#OPSTRANSPORT.TransportZoneCombo OPSGROUP.cargoTZC

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

Ops.OpsTransport#OPSTRANSPORT OPSGROUP.cargoTransport

Current cargo transport assignment.

#number OPSGROUP.cargoTransportUID

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

#table OPSGROUP.cargoqueue

Table containing cargo groups to be transported.

#OPSGROUP.Element OPSGROUP.carrier

Carrier the group is loaded into as cargo.

#OPSGROUP OPSGROUP.carrierGroup

Carrier group transporting this group as cargo.

#OPSGROUP.CarrierLoader OPSGROUP.carrierLoader

Carrier loader parameters.

#string OPSGROUP.carrierStatus

Carrier status of this group acting as cargo carrier.

#OPSGROUP.CarrierLoader OPSGROUP.carrierUnloader

Carrier unloader parameters.

OPSGROUP.category

Category.

Ops.Cohort#COHORT OPSGROUP.cohort

Cohort the group belongs to.

DCS#Controller OPSGROUP.controller

The DCS controller of the group.

Wrapper.Airbase#AIRBASE OPSGROUP.currbase

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

#number OPSGROUP.currentmission

The ID (auftragsnummer) of the currently assigned AUFTRAG.

#number OPSGROUP.currentwp

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

#number OPSGROUP.dTwait

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

DCS#Group OPSGROUP.dcsgroup

The DCS group object.

OPSGROUP.descriptors

Get Descriptors.

Wrapper.Airbase#AIRBASE OPSGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE OPSGROUP.destzone

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

Core.Set#SET_UNIT OPSGROUP.detectedunits

Set of detected units.

#boolean OPSGROUP.detectionOn

If true, detected units of the group are analyzed.

#table OPSGROUP.elements

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

Core.Set#SET_ZONE OPSGROUP.engagedetectedEngageZones

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

Core.Set#SET_ZONE OPSGROUP.engagedetectedNoEngageZones

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

#boolean OPSGROUP.engagedetectedOn

If true, auto engage detected targets.

#number OPSGROUP.engagedetectedRmax

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

#table OPSGROUP.engagedetectedTypes

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

#boolean OPSGROUP.groupinitialized

If true, group parameters were initialized.

#string OPSGROUP.groupname

Name of the group.

#number OPSGROUP.heading

Heading of the group at last status check.

#number OPSGROUP.headingLast

Backup of last heading to monitor changes.

Wrapper.Airbase#AIRBASE OPSGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE OPSGROUP.homezone

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

#OPSGROUP.Beacon OPSGROUP.icls

Current ICLS settings.

#OPSGROUP.Beacon OPSGROUP.iclsDefault

Default ICLS settings.

Core.Set#SET_ZONE OPSGROUP.inzones

Set of zones in which the group is currently in.

#boolean OPSGROUP.isAI

If true, group is purely AI.

#boolean OPSGROUP.isArmygroup

Is an ARMYGROUP.

#boolean OPSGROUP.isDead

If true, the whole group is dead.

#boolean OPSGROUP.isDestroyed

If true, the whole group was destroyed.

OPSGROUP.isEPLRS

Has this a datalink?

#boolean OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

#boolean OPSGROUP.isHelo

If true, this is a helicopter group.

#boolean OPSGROUP.isLateActivated

Is the group late activated.

#boolean OPSGROUP.isMobile

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

#boolean OPSGROUP.isNavygroup

Is a NAVYGROUP.

#boolean OPSGROUP.isSubmarine

If true, this is a submarine group.

#boolean OPSGROUP.isTrain
#boolean OPSGROUP.isUncontrolled

Is the group uncontrolled.

#boolean OPSGROUP.isVTOL

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

#boolean OPSGROUP.ispathfinding

If true, group is on pathfinding route.

Ops.Legion#LEGION OPSGROUP.legion

Legion the group belongs to.

#string OPSGROUP.lid

Class id string for output to DCS log file.

#number OPSGROUP.life
#table OPSGROUP.missionqueue

Queue of missions.

Sound.SRS#MSRS OPSGROUP.msrs

MOOSE SRS wrapper.

#OPSGROUP.MyCarrier OPSGROUP.mycarrier

Carrier group for this group.

#OPSGROUP.Option OPSGROUP.option

Current optional settings.

#OPSGROUP.Option OPSGROUP.optionDefault

Default option settings.

DCS#Vec3 OPSGROUP.orientX

Orientation at last status check.

DCS#Vec3 OPSGROUP.orientXLast

Backup of last orientation to monitor changes.

#boolean OPSGROUP.passedfinalwp

Group has passed the final waypoint.

#table OPSGROUP.pausedmissions

Paused missions.

DCS#Vec3 OPSGROUP.position

Position of the group at last status check.

DCS#Vec3 OPSGROUP.positionLast

Backup of last position vec to monitor changes.

#OPSGROUP.Radio OPSGROUP.radio

Current radio settings.

#OPSGROUP.Radio OPSGROUP.radioDefault

Default radio settings.

#boolean OPSGROUP.rearmOnOutOfAmmo

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

#table OPSGROUP.reconindecies

Init a table.

OPSGROUP.speed

Set speed to next wp.

#number OPSGROUP.speedCruise

Cruising speed in km/h.

#number OPSGROUP.speedMax

Max speed in km/h.

#number OPSGROUP.speedWp

Speed to the next waypoint in m/s.

#OPSGROUP.Spot OPSGROUP.spot

Laser and IR spot.

#OPSGROUP.Beacon OPSGROUP.tacan

Current TACAN settings.

#OPSGROUP.Beacon OPSGROUP.tacanDefault

Default TACAN settings.

#number OPSGROUP.taskcounter

Running number of task ids.

#number OPSGROUP.taskcurrent

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

#table OPSGROUP.taskenroute

Enroute task of the group.

#table OPSGROUP.taskpaused

Paused tasks.

#table OPSGROUP.taskqueue

Queue of tasks.

DCS#Template OPSGROUP.template

Template table of the group.

Core.Timer#TIMER OPSGROUP.timerCheckZone

Timer for check zones.

Core.Timer#TIMER OPSGROUP.timerQueueUpdate

Timer for queue updates.

Core.Timer#TIMER OPSGROUP.timerStatus

Timer for status update.

#number OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

OPSGROUP.travelds

Travel distance since last check.

#number OPSGROUP.traveltime

Time.

#boolean OPSGROUP.useMEtasks

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

#boolean OPSGROUP.useSRS

Use SRS for transmissions.

#number OPSGROUP.verbose

Verbosity level. 0=silent.

#string OPSGROUP.version

OpsGroup version.

#table OPSGROUP.waypoints

Table of waypoints.

#table OPSGROUP.waypoints0

Table of initial waypoints.

#OPSGROUP.WeaponData OPSGROUP.weaponData

Weapon data table with key=BitType.

#number OPSGROUP.wpcounter

Running number counting waypoints.

Function(s)

Activate a late activated group.

Defined in:

OPSGROUP

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:

OPSGROUP

Parameter:

Core.Zone#ZONE CheckZone

Zone to check.

Return value:

self

Add mission to queue.

Defined in:

OPSGROUP

Parameter:

Mission for this group.

Return value:

self

Create a cargo transport assignment.

Defined in:

OPSGROUP

Parameter:

The troop transport assignment.

Return value:

self

Add a scheduled task.

Defined in:

OPSGROUP

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:

OPSGROUP

Parameter:

#table task

DCS task table structure.

Add a waypoint task.

Defined in:

OPSGROUP

Parameters:

#table task

DCS task table structure.

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

#string description

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

#number prio

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

#number duration

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

Return value:

The task structure.

Add a weapon range for ARTY auftrag.

Defined in:

OPSGROUP

Parameters:

#number RangeMin

Minimum range in nautical miles. Default 0 NM.

#number RangeMax

Maximum range in nautical miles. Default 10 NM.

#number BitType

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

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#string UnitName

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

#number Weight

Cargo weight to be added in kg.

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

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

Defined in:

OPSGROUP

Parameter:

Cargo data, which needs a carrier.

Return value:

#boolean:

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

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

Defined in:

OPSGROUP

Check if task description is unique.

Defined in:

OPSGROUP

Parameter:

#string description

Task destription

Return value:

#boolean:

If true, no other task has the same description.

Clear DCS tasks.

Defined in:

OPSGROUP

Return value:

self

Clear waypoints.

Defined in:

OPSGROUP

Parameters:

#number IndexMin

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

#number IndexMax

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

Count elements of the group.

Defined in:

OPSGROUP

Parameter:

#table States

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

Return value:

#number:

Number of elements.

Count remaining missons.

Defined in:

OPSGROUP

Return value:

#number:

Number of missions to be done.

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

Defined in:

OPSGROUP

Return values:

#number:

Total number of tasks remaining.

#number:

Number of SCHEDULED tasks remaining.

#number:

Number of WAYPOINT tasks remaining.

Count remaining cargo transport assignments.

Defined in:

OPSGROUP

Return value:

#number:

Number of unfinished transports in the queue.

Count remaining waypoint tasks.

Defined in:

OPSGROUP

Parameters:

#number uid

Unique waypoint ID.

id

Return value:

#number:

Number of waypoint tasks.

Deactivate the group.

Group will be respawned in late activated state.

Defined in:

OPSGROUP

Parameter:

#number delay

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

Return value:

self

Delete a cargo transport assignment from the cargo queue.

Defined in:

OPSGROUP

Parameter:

Cargo transport do be deleted.

Return value:

self

Despawn the group.

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

Defined in:

OPSGROUP

Parameters:

#number Delay

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

#boolean NoEventRemoveUnit

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

Return value:

self

Despawn an element/unit of the group.

Defined in:

OPSGROUP

Parameters:

The element that will be despawned.

#number Delay

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

#boolean NoEventRemoveUnit

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

Return value:

self

Despawn a unit of the group.

A "Remove Unit" event is generated by default.

Defined in:

OPSGROUP

Parameters:

#string UnitName

Name of the unit

#number Delay

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

#boolean NoEventRemoveUnit

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

Return value:

self

Destroy group.

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

Defined in:

OPSGROUP

Parameter:

#number Delay

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

Return value:

self

Destroy a unit of the group.

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

Defined in:

OPSGROUP

Parameters:

#string UnitName

Name of the unit which should be destroyed.

#number Delay

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

Return value:

self

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

Defined in:

OPSGROUP

Parameter:

#number Weight

Weight of cargo in kg.

Return value:

Carrier able to transport the cargo.

Get 2D distance to a coordinate.

Defined in:

OPSGROUP

Parameter:

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

Return value:

#number:

Distance in meters.

Get current Alarm State of the group.

Defined in:

OPSGROUP

Return value:

#number:

Current Alarm State.

Set current altitude.

Defined in:

OPSGROUP

Return value:

#number:

Altitude in feet.

Get inital amount of ammunition.

Defined in:

OPSGROUP

Return value:

Initial ammo table.

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

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

Defined in:

OPSGROUP

Parameter:

The element.

Return value:

Ammo data.

Get total amount of ammunition of the whole group.

Defined in:

OPSGROUP

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:

OPSGROUP

Parameters:

The unit object.

#boolean display

Display ammo table as message to all. Default false.

Return value:

Ammo data.

Get generalized attribute.

Defined in:

OPSGROUP

Return value:

#string:

Generalized attribute.

Get current TACAN parameters.

Defined in:

OPSGROUP

Return value:

TACAN beacon.

Get callsign of the first element alive.

Defined in:

OPSGROUP

Parameters:

#boolean ShortCallsign

If true, append major flight number only

#boolean Keepnumber

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

#table CallsignTranslations

(optional) Translation table between callsigns

Return value:

#string:

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

Get all groups currently loaded as cargo.

Defined in:

OPSGROUP

Parameter:

#string CarrierName

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

Return value:

#table:

Cargo ops groups.

Get OPSGROUPs in the cargo bay.

Defined in:

OPSGROUP

Return value:

#table:

Cargo OPSGROUPs.

Get coalition.

Defined in:

OPSGROUP

Return value:

#number:

Coalition side of carrier.

Get current coordinate of the group.

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

Defined in:

OPSGROUP

Parameters:

#boolean NewObject

Create a new coordiante object.

#string UnitName

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

Return value:

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

Get a coordinate, which is in weapon range.

Defined in:

OPSGROUP

Parameters:

Core.Point#COORDINATE TargetCoord

Coordinate of the target.

#number WeaponBitType

Weapon type.

Reference coordinate.

Return value:

Coordinate in weapon range

Get default cruise speed.

Defined in:

OPSGROUP

Return value:

#number:

Cruise altitude in feet.

Get DCS GROUP object.

Defined in:

OPSGROUP

Return value:

DCS group object.

Get DCS group object.

Defined in:

OPSGROUP

Return value:

DCS group object.

Get DCS GROUP object.

Defined in:

OPSGROUP

Parameter:

#number UnitNumber

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

Return value:

DCS group object.

Get DCS units.

Defined in:

OPSGROUP

Return value:

#list<DCS#Unit>:

DCS units.

Get set of detected groups.

Defined in:

OPSGROUP

Return value:

Set of detected groups.

Get set of detected units.

Defined in:

OPSGROUP

Return value:

Set of detected units.

Get distance to waypoint.

Defined in:

OPSGROUP

Parameter:

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Distance in meters.

Get current EPLRS state.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, EPLRS is on.

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

Defined in:

OPSGROUP

Return value:

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

Get the element of a group.

Defined in:

OPSGROUP

Parameter:

#string unitname

Name of unit.

Return value:

The element.

Get the bounding box of the element.

Defined in:

OPSGROUP

Parameter:

#string UnitName

Name of unit.

Return value:

Bounding box polygon zone.

Get the loading zone of the element.

Defined in:

OPSGROUP

Parameter:

#string UnitName

Name of unit.

Return value:

Bounding box polygon zone.

Get the unloading zone of the element.

Defined in:

OPSGROUP

Parameter:

#string UnitName

Name of unit.

Return value:

Bounding box polygon zone.

Get current emission state.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, emission is on.

Returns the currently expected speed.

Defined in:

OPSGROUP

Return value:

#number:

Expected speed in m/s.

Get free cargo bay weight.

Defined in:

OPSGROUP

Parameters:

#string UnitName

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

#boolean IncludeReserved

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

Return value:

#number:

Free cargo bay in kg.

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

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

Defined in:

OPSGROUP

Parameter:

#boolean Currently

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

Return value:

#number:

Max weight in kg.

Get relative free cargo bay in percent.

Defined in:

OPSGROUP

Parameters:

#string UnitName

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

#boolean IncludeReserved

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

Return value:

#number:

Free cargo bay in percent.

Get MOOSE GROUP object.

Defined in:

OPSGROUP

Return value:

Moose group object.

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

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return value:

#number:

Current heading of the group in degrees.

Get highest threat.

Defined in:

OPSGROUP

Return values:

The highest threat unit.

#number:

Threat level of the unit.

Get LASER code.

Defined in:

OPSGROUP

Return value:

#number:

Current Laser code.

Get current LASER coordinate, i.e.

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

Defined in:

OPSGROUP

Return value:

Current position where the LASER is pointing at.

Get current target of the LASER.

This can be a STATIC or UNIT object.

Defined in:

OPSGROUP

Return value:

Current target object.

Returns the absolute total life points of the group.

Defined in:

OPSGROUP

Parameter:

(Optional) Only get life points of this element.

Return values:

#number:

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

#number:

Initial life points.

Get mission by its id (auftragsnummer).

Defined in:

OPSGROUP

Parameter:

#number id

Mission id (auftragsnummer).

Return value:

The mission.

Get mission by its task id.

Defined in:

OPSGROUP

Parameter:

#number taskid

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

Return value:

The mission.

Get current mission.

Defined in:

OPSGROUP

Return value:

The current mission or nil.

Get the group name.

Defined in:

OPSGROUP

Return value:

#string:

Group name.

Get number of elements alive.

Defined in:

OPSGROUP

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:

OPSGROUP

Parameter:

#boolean cyclic

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

Return value:

Coordinate of the next waypoint.

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

Defined in:

OPSGROUP

Parameter:

#number uid

Unique ID of the transport

Return value:

Get current orientation of the group.

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return values:

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

Orientation Y pointing "upwards".

Orientation Z perpendicular to the "nose".

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

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return value:

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

Get current ROE of the group.

Defined in:

OPSGROUP

Return value:

#number:

Current ROE.

Get current ROT of the group.

Defined in:

OPSGROUP

Return value:

#number:

Current ROT.

Get current Radio frequency and modulation.

Defined in:

OPSGROUP

Return values:

#number:

Radio frequency in MHz or nil.

#number:

Radio modulation or nil.

#boolean:

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

Get default cruise speed.

Defined in:

OPSGROUP

Return value:

#number:

Cruise speed (>0) in knots.

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

Defined in:

OPSGROUP

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed to next waypoint (>0) in knots.

Get current TACAN parameters.

Defined in:

OPSGROUP

Return values:

#number:

TACAN channel.

#string:

TACAN Morse code.

#string:

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

#boolean:

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

#string:

UnitName Name of the unit acting as beacon.

Get task by its id.

Defined in:

OPSGROUP

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:

OPSGROUP

Return value:

Current task or nil.

Get the unfinished waypoint tasks

Defined in:

OPSGROUP

Parameter:

#number id

Unique waypoint ID.

Return value:

#table:

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

Get highest detected threat.

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

Defined in:

OPSGROUP

Parameters:

#number ThreatLevelMin

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

#number ThreatLevelMax

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

Return values:

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

#number:

Threat level.

Get time to waypoint based on current velocity.

Defined in:

OPSGROUP

Parameter:

#number indx

Waypoint index. Default is the next waypoint.

Return value:

#number:

Time in seconds. If velocity is 0

Get MOOSE UNIT object.

Defined in:

OPSGROUP

Parameter:

#number UnitNumber

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

Return value:

The MOOSE UNIT object.

Get relative used (loaded) cargo bay in percent.

Defined in:

OPSGROUP

Parameters:

#string UnitName

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

#boolean IncludeReserved

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

Return value:

#number:

Used cargo bay in percent.

Get current 2D position vector of the group.

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return value:

Vector with x,y components.

Get current 3D position vector of the group.

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return value:

Vector with x,y,z components.

Get current velocity of the group.

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return value:

#number:

Velocity in m/s.

Get waypoint.

Defined in:

OPSGROUP

Parameter:

#number indx

Waypoint index.

Return value:

Waypoint table.

Get the waypoint from its unique ID.

Defined in:

OPSGROUP

Parameter:

#number uid

Waypoint unique ID.

Return value:

Waypoint data.

Get the waypoint from its index.

Defined in:

OPSGROUP

Parameter:

#number index

Waypoint index.

Return value:

Waypoint data.

Get waypoint coordinates.

Defined in:

OPSGROUP

Parameter:

#number index

Waypoint index.

Return value:

Coordinate of the next waypoint.

Get current waypoint.

Defined in:

OPSGROUP

Return value:

Current waypoint table.

Get current waypoint UID.

Defined in:

OPSGROUP

Return value:

#number:

Current waypoint UID.

Get final waypoint.

Defined in:

OPSGROUP

Return value:

Final waypoint table.

Get unique ID of waypoint given its index.

Defined in:

OPSGROUP

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Unique ID.

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

Defined in:

OPSGROUP

Parameter:

#number uid

Waypoint unique ID.

Return value:

Waypoint data.

Get waypoint index after waypoint with given ID.

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

Defined in:

OPSGROUP

Parameter:

#number uid

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

Return value:

#number:

Index after waypoint with given ID.

Get current waypoint index.

This is the index of the last passed waypoint.

Defined in:

OPSGROUP

Return value:

#number:

Current waypoint index.

Get next waypoint index.

Defined in:

OPSGROUP

Parameters:

#boolean cyclic

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

#number i

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

Return value:

#number:

Next waypoint index.

Get next waypoint.

Defined in:

OPSGROUP

Parameter:

#boolean cyclic

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

Return value:

Next waypoint table.

Get waypoint speed.

Defined in:

OPSGROUP

Parameter:

#number indx

Waypoint index.

Return value:

#number:

Speed set at waypoint in knots.

Get unique ID of waypoint.

Defined in:

OPSGROUP

Parameter:

The waypoint data table.

Return value:

#number:

Unique ID.

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

its current position in the waypoints table.

Defined in:

OPSGROUP

Parameter:

#number index

Waypoint index.

Return value:

#number:

Unique waypoint ID.

Get the waypoints.

Defined in:

OPSGROUP

Return value:

#table:

Table of all waypoints.

Get weapon data.

Defined in:

OPSGROUP

Parameter:

#number BitType

Type of weapon.

Return value:

Weapon range data.

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

Defined in:

OPSGROUP

Parameters:

#string UnitName

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

#boolean IncludeReserved

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

Return value:

#number:

Cargo weight in kg.

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

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

Defined in:

OPSGROUP

Parameter:

#string UnitName

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

Return value:

#number:

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

Get total weight of the group including cargo.

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

Defined in:

OPSGROUP

Parameters:

#string UnitName

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

#boolean IncludeReserved

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

Return value:

#number:

Total weight in kg.

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

Defined in:

OPSGROUP

Parameters:

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

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

DCS#Vec3 OffsetElement

Offset vector of the element.

DCS#Vec3 OffsetCoordinate

Offset vector of the coordinate.

Return value:

#boolean:

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

Check if this group has passed its final waypoint.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, this group has passed the final waypoint.

Returns true if the DCS controller currently has a task.

Defined in:

OPSGROUP

Return value:

#boolean:

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

Check if a given coordinate is in weapon range.

Defined in:

OPSGROUP

Parameters:

Core.Point#COORDINATE TargetCoord

Coordinate of the target.

#number WeaponBitType

Weapon type.

Reference coordinate.

Return value:

#boolean:

If true, coordinate is in range.

Check if group is activated.

Defined in:

OPSGROUP

Return value:

#boolean:

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

Check if group is alive.

Defined in:

OPSGROUP

Return value:

#boolean:

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

Check if this is a ARMYGROUP.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, this is a ground group.

Check if awaiting a transport lift.

Defined in:

OPSGROUP

Parameter:

(Optional) The transport.

Return value:

#boolean:

If true, group is awaiting transport lift..

Check if the group is currently boarding a carrier.

Defined in:

OPSGROUP

Parameter:

#string CarrierGroupName

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

Return value:

#boolean:

If true, group is boarding.

Check if the group is currently busy doing something.

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

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is busy.

Check if the group is assigned as cargo.

Defined in:

OPSGROUP

Parameter:

#boolean CheckTransport

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

Return value:

#boolean:

If true, group is cargo.

Check if the group is a carrier.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is a carrier.

Check if group is dead.

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

Defined in:

OPSGROUP

Return value:

#boolean:

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

Check if group was destroyed.

Defined in:

OPSGROUP

Return value:

#boolean:

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

Check if the group is engaging another unit or group.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is engaging.

Check if group is exists.

Defined in:

OPSGROUP

Return value:

#boolean:

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

Check if this is a FLIGHTGROUP.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, this is an airplane or helo group.

Check if group is in state in utero.

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

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is not spawned yet.

Check if group is currently inside a zone.

Defined in:

OPSGROUP

Parameter:

The zone.

Return value:

#boolean:

If true, group is in this zone

Check if the group has currently switched a LASER on.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, LASER of the group is on.

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

Defined in:

OPSGROUP

Return value:

#boolean:

Is this the group late activated?

Check if the group is currently loaded into a carrier.

Defined in:

OPSGROUP

Parameter:

#string CarrierGroupName

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

Return value:

#boolean:

If true, group is loaded.

Check if the group is loading cargo.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is loading.

Check if a given mission is already in the queue.

Defined in:

OPSGROUP

Parameter:

the mission to check

Return value:

#boolean:

If true, the mission is in the queue.

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

Defined in:

OPSGROUP

Parameter:

#string MissionType

MissionType Type of mission.

Return value:

#boolean:

If true, the mission type is in the queue.

Check if this is a NAVYGROUP.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, this is a ship group.

Check if the group is not cargo.

Defined in:

OPSGROUP

Parameter:

#boolean CheckTransport

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

Return value:

#boolean:

If true, group is not cargo.

Check if the group is not a carrier yet.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is not a carrier.

Check if group is currently on a mission.

Defined in:

OPSGROUP

Parameter:

#number MissionUID

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

Return value:

#boolean:

If true, group is currently on a mission.

Check if the group is completely out of ammo.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is out-of-ammo.

Check if the group is out of bombs.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is out of bombs.

Check if the group is out of guns.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is out of guns.

Check if the group is out of missiles.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is out of missiles.

Check if the group is out of torpedos.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is out of torpedos.

Check if the group is picking up cargo.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is picking up.

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

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is rearming.

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

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is retreated.

Check if the group is currently retreating or retreated.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is retreating or retreated.

Check if the group is currently returning to a zone.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is returning.

Check if group is in state spawned.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is spawned.

Check if FSM is stopped.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, FSM state is stopped.

Check if target is detected.

Defined in:

OPSGROUP

Parameter:

The target object.

Return value:

#boolean:

If true, target was detected.

Check if the group is transporting cargo.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is transporting.

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

Defined in:

OPSGROUP

Return value:

#boolean:

If true, this group uncontrolled.

Check if the group is unloading cargo.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is unloading.

Check if group is currently waiting.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is currently waiting.

Set detection on or off.

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

Defined in:

OPSGROUP

Parameters:

The target object.

#boolean KnowType

Make type known.

#boolean KnowDist

Make distance known.

#number Delay

Delay in seconds before the target is known.

Return value:

self

Mark waypoints on F10 map.

Defined in:

OPSGROUP

Parameter:

#number Duration

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

Return value:

self

Triggers the FSM event "MissionCancel".

Defined in:

OPSGROUP

Parameter:

The mission.

Triggers the FSM event "MissionDone".

Defined in:

OPSGROUP

Parameter:

The mission.

Triggers the FSM event "MissionExecute".

Defined in:

OPSGROUP

Parameter:

The mission.

Triggers the FSM event "MissionStart".

Defined in:

OPSGROUP

Parameter:

The mission.

Create a new OPSGROUP class object.

Defined in:

OPSGROUP

Parameter:

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

Return value:

self

Create a scheduled task.

Defined in:

OPSGROUP

Parameters:

#table task

DCS task table structure.

#string clock

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

#string description

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

#number prio

Priority of the task.

#number duration

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

Return value:

The task structure.

On After "DetectedGroup" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Detected Group.

On After "DetectedGroupKnown" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Known detected group.

On After "DetectedGroupLost" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Lost detected group.

On After "DetectedGroupNew" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Newly detected group.

On After "DetectedUnit" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Detected Unit.

On After "DetectedUnitKnown" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Known detected unit.

On After "DetectedUnitLost" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Lost detected unit.

On After "DetectedUnitNew" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Newly detected unit.

On after "HoverEnd" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "HoverStart" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "MissionCancel" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionDone" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionExecute" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "MissionStart" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission.

On after "TransportCancel" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The transport.

Event function handling the birth of a unit.

Defined in:

OPSGROUP

Parameter:

Event data.

Event function handling the dead of a unit.

Defined in:

OPSGROUP

Parameter:

Event data.

Event function handling the hit of a unit.

Defined in:

OPSGROUP

Parameter:

Event data.

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

Defined in:

OPSGROUP

Parameter:

Event data.

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

Defined in:

OPSGROUP

Parameter:

Event data.

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

Defined in:

OPSGROUP

Parameter:

Event data.

Push DCS task.

Defined in:

OPSGROUP

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#string Text

Text of transmission.

#number Delay

Delay in seconds before the transmission is started.

#boolean SayCallsign

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

#number Frequency

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

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#string UnitName

Name of the unit.

#number Weight

Cargo weight to be reduced in kg.

Remove mission from queue.

Defined in:

OPSGROUP

Parameter:

Mission to be removed.

Return value:

self

Remove task from task queue.

Defined in:

OPSGROUP

Parameter:

The task to be removed from the queue.

Return value:

#boolean:

True if task could be removed.

Remove a waypoint.

Defined in:

OPSGROUP

Parameter:

#number wpindex

Waypoint number.

Return value:

self

Remove a waypoint with a ceratin UID.

Defined in:

OPSGROUP

Parameter:

#number uid

Waypoint UID.

Return value:

self

Remove waypoints markers on the F10 map.

Defined in:

OPSGROUP

Parameter:

#number Delay

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

Return value:

self

Return group back to the legion it belongs to.

Group is despawned and added back to the stock.

Defined in:

OPSGROUP

Parameter:

#number Delay

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

Return value:

self

Route group along waypoints.

Defined in:

OPSGROUP

Parameters:

#table waypoints

Table of waypoints.

#number delay

Delay in seconds.

Return value:

self

Route group to mission.

Defined in:

OPSGROUP

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:

OPSGROUP

Parameters:

#number Delay

Delay in seconds. Default now.

#number ExplosionPower

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

#string ElementName

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

Return value:

self

Set current altitude.

Defined in:

OPSGROUP

Parameters:

#number Altitude

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

#boolean Keep

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

RadarAlt

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#number Weight

Max weight of cargo in kg the unit can carry.

#string UnitName

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

Return value:

self

Set that this carrier is an all aspect loader.

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a back loader.

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a front loader.

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is an all aspect unloader.

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a back unloader.

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

Set that this carrier is a front unloader.

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#number Length

Length of loading zone in meters. Default 50 m.

#number Width

Width of loading zone in meters. Default 20 m.

Return value:

self

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

Defined in:

OPSGROUP

Parameter:

Core.Set#SET_ZONE CheckZonesSet

Set of zones.

Return value:

self

Set the default Alarm State for the group.

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

Defined in:

OPSGROUP

Parameter:

#number alarmstate

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

Return value:

self

Set default cruise altitude.

Defined in:

OPSGROUP

Parameter:

#number Altitude

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

Return value:

self

Set default callsign.

Defined in:

OPSGROUP

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number. Default 1.

Return value:

self

Set the default EPLRS for the group.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

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

Return value:

self

Set the default EPLRS for the group.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

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

Return value:

self

Set default formation.

Defined in:

OPSGROUP

Parameter:

#number Formation

The formation the groups flies in.

Return value:

self

Set default ICLS parameters.

Defined in:

OPSGROUP

Parameters:

#number Channel

ICLS channel. Default is 1.

#string Morse

Morse code. Default "XXX".

#string UnitName

Name of the unit acting as beacon.

#boolean OffSwitch

If true, TACAN is off by default.

Return value:

self

Set the default immortal for the group.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

If true, group is immortal by default.

Return value:

self

Set the default invisible for the group.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

If true, group is ivisible by default.

Return value:

self

Set the default ROE for the group.

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

Defined in:

OPSGROUP

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:

OPSGROUP

Parameter:

#number rot

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

Return value:

self

Set default Radio frequency and modulation.

Defined in:

OPSGROUP

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default radio.modulation.AM.

#boolean OffSwitch

If true, radio is OFF by default.

Return value:

self

Set default cruise speed.

Defined in:

OPSGROUP

Parameter:

#number Speed

Speed in knots.

Return value:

self

Set default TACAN parameters.

Defined in:

OPSGROUP

Parameters:

#number Channel

TACAN channel. Default is 74.

#string Morse

Morse code. Default "XXX".

#string UnitName

Name of the unit acting as beacon.

#string Band

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

#boolean OffSwitch

If true, TACAN is off by default.

Return value:

self

Set detection on or off.

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

Defined in:

OPSGROUP

Parameter:

#boolean Switch

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

Return value:

self

Disable to automatically engage detected targets.

Defined in:

OPSGROUP

Return value:

self

Enable to automatically engage detected targets.

Defined in:

OPSGROUP

Parameters:

#number RangeMax

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

#table TargetTypes

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

Core.Set#SET_ZONE EngageZoneSet

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

Core.Set#SET_ZONE NoEngageZoneSet

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

Return value:

self

Set LASER parameters.

Defined in:

OPSGROUP

Parameters:

#number Code

Laser code. Default 1688.

#boolean CheckLOS

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

#boolean IROff

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

#number UpdateTime

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

Return value:

self

Set LASER target.

Defined in:

OPSGROUP

Parameter:

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

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

Defined in:

OPSGROUP

Return value:

self

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

Defined in:

OPSGROUP

Return value:

self

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

Defined in:

OPSGROUP

Return value:

self

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

Only for ground and naval groups. Aircraft will

Defined in:

OPSGROUP

Parameter:

#boolean Switch

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

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

#string PathToSRS

Path to SRS directory.

#string Gender

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

#string Culture

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

#string Voice

Specific voice. Overrides Gender and Culture.

#number Port

SRS port. Default 5002.

#string PathToGoogleKey

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

#string Label

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

#number Volume

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

Return value:

self

Set current speed.

Defined in:

OPSGROUP

Parameters:

#number Speed

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

#boolean Keep

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

#boolean AltCorrected

If true, use altitude corrected indicated air speed.

Return value:

self

Set DCS task.

Enroute tasks are injected automatically.

Defined in:

OPSGROUP

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

Set verbosity level.

Defined in:

OPSGROUP

Parameter:

#number VerbosityLevel

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

Return value:

self

Triggers the FSM event "Status".

Defined in:

OPSGROUP

Triggers the FSM event "Stop".

Stops the OPSGROUP and all its event handlers.

Defined in:

OPSGROUP

Set current Alarm State of the group.

  • 0 = "Auto"
  • 1 = "Green"
  • 2 = "Red"

Defined in:

OPSGROUP

Parameter:

#number alarmstate

Alarm state of group. Default is 0="Auto".

Return value:

self

Switch to a specific callsign.

Defined in:

OPSGROUP

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number.

Return value:

self

Switch EPLRS datalink on or off.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

If true or nil, switch EPLRS on. If false EPLRS switched off.

Return value:

self

Switch emission on or off.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

If true or nil, switch emission on. If false emission switched off.

Return value:

self

Switch to a specific formation.

Defined in:

OPSGROUP

Parameter:

#number Formation

New formation the group will fly in. Default is the setting of SetDefaultFormation().

Return value:

self

Activate/switch ICLS beacon settings.

Defined in:

OPSGROUP

Parameters:

#number Channel

ICLS Channel. Default is what is set in SetDefaultICLS() so usually channel 1.

#string Morse

ICLS morse code. Default is what is set in SetDefaultICLS() so usually "XXX".

#string UnitName

Name of the unit in the group which should activate the ICLS beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.

Return value:

self

Switch immortality on or off.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

If true or nil, switch immortality on. If false immortality switched off.

Return value:

self

Switch invisibility on or off.

Defined in:

OPSGROUP

Parameter:

#boolean OnOffSwitch

If true or nil, switch invisibliity on. If false invisibility switched off.

Return value:

self

Set current ROE for the group.

Defined in:

OPSGROUP

Parameter:

#string roe

ROE of group. Default is value set in SetDefaultROE (usually ENUMS.ROE.ReturnFire).

Return value:

self

Set ROT for the group.

Defined in:

OPSGROUP

Parameter:

#string rot

ROT of group. Default is value set in :SetDefaultROT (usually ENUMS.ROT.PassiveDefense).

Return value:

self

Turn radio on or switch frequency/modulation.

Defined in:

OPSGROUP

Parameters:

#number Frequency

Radio frequency in MHz. Default is value set in SetDefaultRadio (usually 251 MHz).

#number Modulation

Radio modulation. Default is value set in SetDefaultRadio (usually radio.modulation.AM).

Return value:

self

Activate/switch TACAN beacon settings.

Defined in:

OPSGROUP

Parameters:

#number Channel

TACAN Channel.

#string Morse

TACAN morse code. Default is the value set in OPSGROUP.SetDefaultTACAN or if not set "XXX".

#string UnitName

Name of the unit in the group which should activate the TACAN beacon. Can also be given as #number to specify the unit number. Default is the first unit of the group.

#string Band

TACAN channel mode "X" or "Y". Default is "Y" for aircraft and "X" for ground and naval groups.

Return value:

self

Teleport the group to a different location.

Defined in:

OPSGROUP

Parameters:

Coordinate where the group is teleported to.

#number Delay

Delay in seconds before respawn happens. Default 0.

#boolean NoPauseMission

If true, dont pause a running mission.

Return value:

self

Triggers the FSM event "TransportCancel".

Defined in:

OPSGROUP

Parameter:

The transport.

Deactivate ICLS beacon.

Defined in:

OPSGROUP

Return value:

self

Turn radio off.

Defined in:

OPSGROUP

Return value:

self

Deactivate TACAN beacon.

Defined in:

OPSGROUP

Return value:

self

Add OPSGROUP to cargo bay of a carrier.

Defined in:

OPSGROUP

Parameters:

#OPSGROUP CargoGroup

Cargo group.

#OPSGROUP.Element CarrierElement

The element of the carrier.

#boolean Reserved

Only reserve the cargo bay space.

Add warehouse storage to cargo bay of a carrier.

Defined in:

OPSGROUP

Parameters:

#OPSGROUP.Element CarrierElement

The element of the carrier.

#number CargoUID

UID of the cargo data.

#string StorageType

Storage type.

#number StorageAmount

Storage amount.

#number StorageWeight

Weight of a single storage item in kg.

Add a unit/element to the OPS group.

Defined in:

OPSGROUP

Parameter:

#string unitname

Name of unit.

Return value:

The element or nil.

Add storage to cargo bay of a carrier.

Defined in:

OPSGROUP

Parameters:

My cargo.

#OPSGROUP.Element CarrierElement

The element of the carrier.

Check if awaiting a transport.

Defined in:

OPSGROUP

Parameter:

The transport.

Return value:

self

Initialize Mission Editor waypoints.

Defined in:

OPSGROUP

Parameters:

Waypoint data.

#number wpnumber

Waypoint index/number. Default is as last waypoint.

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

Defined in:

OPSGROUP

Parameters:

#string unitname

Name of unit.

status

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

Defined in:

OPSGROUP

Parameter:

#string status

Status to check.

Return value:

#boolean:

If true, all elements have a similar status.

Check ammo is full.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, ammo is full.

Check ammo status.

Defined in:

OPSGROUP

Check cargo transport assignments.

Defined in:

OPSGROUP

Return value:

self

Check damage.

Defined in:

OPSGROUP

Return value:

self

Check if all cargo of this transport assignment was delivered.

Defined in:

OPSGROUP

Parameter:

The next due cargo transport or nil.

Return value:

#boolean:

If true, all cargo was delivered.

Check detected units.

Defined in:

OPSGROUP

Check if all cargo of this transport assignment was delivered.

Defined in:

OPSGROUP

Parameter:

The next due cargo transport or nil.

Return value:

#boolean:

If true, all cargo was delivered.

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

Defined in:

OPSGROUP

Parameter:

#number delay

Delay in seconds.

Check if group is in zones.

Defined in:

OPSGROUP

Check if group got stuck.

Defined in:

OPSGROUP

Get coordinate from an object.

Defined in:

OPSGROUP

Parameter:

The object.

Return value:

The coordinate of the object.

Count paused mission.

Defined in:

OPSGROUP

Return value:

#number:

Number of paused missions.

Add OPSGROUP to cargo bay of a carrier.

Defined in:

OPSGROUP

Parameters:

#number CargoUID

UID of the cargo data.

#OPSGROUP OpsGroup

Cargo group.

#string StorageType

Storage type.

#number StorageAmount

Storage amount.

#number StorageWeight

Weight of a single storage item in kg.

Return value:

My cargo object.

Enhance waypoint table.

Defined in:

OPSGROUP

Parameters:

data.

waypoint

Return value:

Modified waypoint data.

Remove OPSGROUP from cargo bay of a carrier.

Defined in:

OPSGROUP

Parameter:

#OPSGROUP CargoGroup

Cargo group.

Return value:

#boolean:

If true, cargo could be removed.

Remove OPSGROUP from cargo bay of a carrier.

Defined in:

OPSGROUP

Parameters:

Cargo group.

My cargo data.

Return value:

#boolean:

If true, cargo could be removed.

Remove my lift.

Defined in:

OPSGROUP

Parameter:

The transport.

Return value:

self

Get cargo bay item.

Defined in:

OPSGROUP

Parameter:

#OPSGROUP CargoGroup

Cargo group.

Return values:

Cargo bay item or nil if the group is not in the carrier.

#number:

CargoBayIndex Index of item in the cargo bay table.

Carrier element.

Remove OPSGROUP from cargo bay of a carrier.

Defined in:

OPSGROUP

Parameters:

Cargo group.

#number CargoUID

Cargo UID.

Return value:

MyCargo My cargo data.

Get target group.

Defined in:

OPSGROUP

Return values:

Detected target group.

#number:

Distance to target.

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

Defined in:

OPSGROUP

Parameters:

Element.

The zone.

Loader parameters.

Return value:

Bounding box polygon zone.

Get cargo bay data from a cargo data id.

Defined in:

OPSGROUP

Parameter:

#number uid

Unique ID of cargo data.

Return values:

Cargo My cargo.

Element that has loaded the cargo.

Get my carrier.

Defined in:

OPSGROUP

Return values:

Carrier group.

Carrier element.

#boolean:

If true, space is reserved for me

Get my carrier element.

Defined in:

OPSGROUP

Return value:

Carrier element.

Get my carrier group.

Defined in:

OPSGROUP

Return value:

Carrier group.

Get cargo transport from cargo queue.

Defined in:

OPSGROUP

Return value:

The next due cargo transport or nil.

Get next mission.

Defined in:

OPSGROUP

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:

OPSGROUP

Return value:

The next task in line or nil.

Get paused mission.

Defined in:

OPSGROUP

Return value:

Paused mission or nil.

Get name of ROE corresponding to the numerical value.

Defined in:

OPSGROUP

Parameter:

roe

Return value:

#string:

Name of ROE.

Get the template of the group.

Defined in:

OPSGROUP

Parameter:

#boolean Copy

Get a deep copy of the template.

Return value:

#table:

Template table.

Get weight of warehouse storage to transport.

Defined in:

OPSGROUP

Parameters:

#boolean Total

Get total weight. Otherweise the amount left to deliver (total-loaded-lost-delivered).

#boolean Reserved

Reduce weight that is reserved.

#boolean Amount

Return amount not weight.

Return value:

#number:

Weight of cargo in kg or amount in number of items, if Amount=true.

Initialize Mission Editor waypoints.

Defined in:

OPSGROUP

Parameters:

#number WpIndexMin

#number WpIndexMax

Return value:

self

Check if a unit is an element of the flightgroup.

Defined in:

OPSGROUP

Parameter:

#string unitname

Name of unit.

Return value:

#boolean:

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

Check if a group is in the cargo bay.

Defined in:

OPSGROUP

Parameter:

#OPSGROUP OpsGroup

Group to check.

Return value:

#boolean:

If true, group is in the cargo bay.

Is my carrier reserved.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, space for me was reserved.

Returns a name of a missile category.

Defined in:

OPSGROUP

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.

Set (new) cargo status.

Defined in:

OPSGROUP

Parameter:

#string Status

New status.

Set (new) carrier status.

Defined in:

OPSGROUP

Parameter:

#string Status

New status.

Set passed final waypoint value.

Defined in:

OPSGROUP

Parameters:

#boolean final

If true, final waypoint was passed.

#string comment

Some comment as to why the final waypoint was passed.

Function called when a group is passing a waypoint.

Defined in:

OPSGROUP

Parameters:

#OPSGROUP opsgroup

Ops group object.

#number uid

Waypoint UID.

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

Defined in:

OPSGROUP

On after "QueueUpdate" event.

Defined in:

OPSGROUP

On after "MissionDone" event.

Defined in:

OPSGROUP

Parameters:

#boolean Silently

Remove waypoints by table.remove() and do not update the route.

Remove my carrier.

Defined in:

OPSGROUP

Return value:

self

Remove paused mission from the table.

Defined in:

OPSGROUP

Parameter:

#number AuftragsNummer

Mission ID of the paused mission to remove.

Return value:

self

Respawn the group.

Defined in:

OPSGROUP

Parameters:

#number Delay

Delay in seconds before respawn happens. Default 0.

DCS#Template Template

(optional) The template of the Group retrieved with GROUP:GetTemplate(). If the template is not provided, the template will be retrieved of the group itself.

#boolean Reset

Reset waypoints and reinit group if true.

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

DCS#Task DCSTask

The DCS task.

#boolean SetTask

Set task instead of pushing it.

#number Delay

Delay in seconds. Default nil.

Set status for all elements (except dead ones).

Defined in:

OPSGROUP

Parameter:

#string status

Element status.

Set legion this ops group belongs to.

Defined in:

OPSGROUP

Parameter:

The Legion.

Return value:

self

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

Defined in:

OPSGROUP

Parameter:

The mission table.

Set my carrier.

Defined in:

OPSGROUP

Parameters:

#OPSGROUP CarrierGroup

Carrier group.

#OPSGROUP.Element CarrierElement

Carrier element.

#boolean Reserved

If true, reserve space for me.

Set the template of the group.

Defined in:

OPSGROUP

Parameter:

#table Template

Template to set. Default is from the GROUP.

Return value:

self

Set tasks at this waypoint

Defined in:

OPSGROUP

Parameter:

The waypoint.

Return value:

#number:

Number of tasks.

Simple task function.

Can be used to call a function which has the warehouse and the executing group as parameters.

Defined in:

OPSGROUP

Parameters:

#string Function

The name of the function to call passed as string.

#number uid

Waypoint UID.

On after "Loading" event.

Defined in:

OPSGROUP

Parameter:

#table Cargos

Table of cargos.

Return value:

#table:

Table of sorted cargos.

Sort task queue.

Defined in:

OPSGROUP

Activate/switch ICLS beacon settings.

Defined in:

OPSGROUP

Parameter:

ICLS data table.

Return value:

self

Activate/switch TACAN beacon settings.

Defined in:

OPSGROUP

Parameter:

TACAN data table. Default is the default TACAN settings.

Return value:

self

Function called when a task is done.

Defined in:

OPSGROUP

Parameters:

Group for which the task is done.

#OPSGROUP opsgroup

Ops group.

Task.

Function called when a task is executed.

Defined in:

OPSGROUP

Parameters:

Group which should execute the task.

#OPSGROUP opsgroup

Ops group.

Task.

Transfer cargo from to another carrier.

Defined in:

OPSGROUP

Parameters:

#OPSGROUP CargoGroup

The cargo group to be transferred.

#OPSGROUP CarrierGroup

The new carrier group.

#OPSGROUP.Element CarrierElement

The new carrier element.

Update laser point.

Defined in:

OPSGROUP

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

Defined in:

OPSGROUP

Return value:

self

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

Defined in:

OPSGROUP

Parameters:

Element.

#string newstatus

New status of element

Airbase if applicable.

Update (DCS) task.

Defined in:

OPSGROUP

Parameters:

The mission.

Initialize Mission Editor waypoints.

Defined in:

OPSGROUP

Parameter:

#number n

Waypoint

Triggers the FSM event "MissionCancel" after a delay.

Defined in:

OPSGROUP

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "MissionDone" after a delay.

Defined in:

OPSGROUP

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "MissionExecute" after a delay.

Defined in:

OPSGROUP

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "MissionStart" after a delay.

Defined in:

OPSGROUP

Parameters:

#number delay

Delay in seconds.

The mission.

Triggers the FSM event "Status" after a delay.

Defined in:

OPSGROUP

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "Stop" after a delay.

Stops the OPSGROUP and all its event handlers.

Defined in:

OPSGROUP

Parameter:

#number delay

Delay in seconds.

Triggers the FSM event "TransportCancel" after a delay.

Defined in:

OPSGROUP

Parameters:

#number delay

Delay in seconds.

The transport.

On after "Board" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP CarrierGroup

The carrier group.

The OPSGROUP element

On after "Damaged" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Dead" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Delivered" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The cargo transport assignment.

On after "Destroyed" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "DetectedGroup" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The detected Group.

On after "DetectedGroupNew" event.

Add newly detected group to detected group set.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The detected group.

On after "DetectedUnit" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The detected unit.

On after "DetectedUnitNew" event.

Add newly detected unit to detected unit set.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The detected unit.

On after "ElementDamaged" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementDead" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementDestroyed" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "ElementHit" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

Unit that hit the element or nil.

On after "ElementInUtero" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On after "EnterZone" event.

Sets self.inzones[zonename]=true.

Defined in:

OPSGROUP

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:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number UID

The goto waypoint unique ID.

#number Speed

(Optional) Speed to waypoint in knots.

On after "Hit" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Unit that hit the element or nil.

On after "InUtero" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LaserCode" event.

Changes the LASER code.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Code

Laser code. Default is 1688.

On after "LaserGotLOS" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LaserLostLOS" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LaserOff" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LaserOn" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Target Coordinate. Target can also be any POSITIONABLE from which we can obtain its coordinates.

On after "LaserPause" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LaserResume" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LeaveZone" event.

Sets self.inzones[zonename]=false.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The zone that the group entered.

On after "Load" event.

Carrier loads a cargo group into ints cargo bay.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP CargoGroup

The OPSGROUP loaded as cargo.

The carrier element/unit.

On after "Loading" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "LoadingDone" event.

Carrier has loaded all (possible) cargo at the pickup zone.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "MissionCancel" event.

Cancels the mission.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission to be cancelled.

On after "MissionDone" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission that is done.

On after "MissionExecute" event.

Mission execution began.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission table.

On after "MissionStart" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission table.

On after "OutOfAmmo" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "PassedFinalWaypoint" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "PassingWaypoint" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Waypoint data passed.

On after "PauseMission" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Pickup" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Respawn" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#table Template

The template used to respawn the group. Default is the inital template of the group.

On after "Stop" event.

Defined in:

OPSGROUP

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:

OPSGROUP

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:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "TaskExecute" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Transport" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "TransportCancel" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

transport to be cancelled.

Transport

On after "Unload" event.

Carrier unloads a cargo group from its cargo bay.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP OpsGroup

The OPSGROUP loaded as cargo.

Coordinate were the group is unloaded to.

#boolean Activated

If true, group is active. If false, group is spawned in late activated state.

#number Heading

(Optional) Heading of group in degrees. Default is random heading for each unit.

On after "Unloaded" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP OpsGroupCargo

Cargo OPSGROUP that was unloaded from a carrier.

On after "Unloading" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "UnloadingDone" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "UnpauseMission" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On after "Wait" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Duration

Duration in seconds how long the group will be waiting. Default nil (for ever).

On before "Board" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP CarrierGroup

The carrier group.

The OPSGROUP element

On before "Dead" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "ElementSpawned" event.

Check that element is not in status spawned already.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The flight group element.

On before "LaserOff" event.

Check if LASER is on.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "LaserOn" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Target Coordinate. Target can also be any POSITIONABLE from which we can obtain its coordinates.

On before "LaserResume" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "MissionStart" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

The mission table.

On before "Stop" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "TaskDone" event.

Deny transition if task status is PAUSED.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "TaskExecute" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "Transport" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "Unload" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#OPSGROUP OpsGroup

The OPSGROUP loaded as cargo.

Coordinate were the group is unloaded to.

#number Heading

Heading of group.

On before "Wait" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

#number Duration

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

Field(s)

#string OPSGROUP.ClassName

Name of the class.

#number OPSGROUP.Ndestroyed

Number of destroyed units.

#number OPSGROUP.Nhit

Number of hits taken.

#number OPSGROUP.Nkills

Number kills of this groups.

#number OPSGROUP.Twaiting

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

OPSGROUP.actype

Set type name.

#boolean OPSGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

#OPSGROUP.Ammo OPSGROUP.ammo

Initial ammount of ammo.

#string OPSGROUP.attribute

Generalized attribute.

#OPSGROUP.Callsign OPSGROUP.callsign

Current callsign settings.

#string OPSGROUP.callsignAlias

Callsign alias.

#OPSGROUP.Callsign OPSGROUP.callsignDefault

Default callsign settings.

#string OPSGROUP.callsignName

Callsign name.

#table OPSGROUP.cargoBay

Table containing OPSGROUP loaded into this group.

#string OPSGROUP.cargoStatus

Cargo status of this group acting as cargo.

Ops.OpsTransport#OPSTRANSPORT.TransportZoneCombo OPSGROUP.cargoTZC

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

Ops.OpsTransport#OPSTRANSPORT OPSGROUP.cargoTransport

Current cargo transport assignment.

#number OPSGROUP.cargoTransportUID

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

#table OPSGROUP.cargoqueue

Table containing cargo groups to be transported.

#OPSGROUP.Element OPSGROUP.carrier

Carrier the group is loaded into as cargo.

#OPSGROUP OPSGROUP.carrierGroup

Carrier group transporting this group as cargo.

#OPSGROUP.CarrierLoader OPSGROUP.carrierLoader

Carrier loader parameters.

#string OPSGROUP.carrierStatus

Carrier status of this group acting as cargo carrier.

#OPSGROUP.CarrierLoader OPSGROUP.carrierUnloader

Carrier unloader parameters.

OPSGROUP.category

Category.

Ops.Cohort#COHORT OPSGROUP.cohort

Cohort the group belongs to.

DCS#Controller OPSGROUP.controller

The DCS controller of the group.

Wrapper.Airbase#AIRBASE OPSGROUP.currbase

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

#number OPSGROUP.currentmission

The ID (auftragsnummer) of the currently assigned AUFTRAG.

#number OPSGROUP.currentwp

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

#number OPSGROUP.dTwait

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

DCS#Group OPSGROUP.dcsgroup

The DCS group object.

OPSGROUP.descriptors

Get Descriptors.

Wrapper.Airbase#AIRBASE OPSGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE OPSGROUP.destzone

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

Core.Set#SET_UNIT OPSGROUP.detectedunits

Set of detected units.

#boolean OPSGROUP.detectionOn

If true, detected units of the group are analyzed.

#table OPSGROUP.elements

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

Core.Set#SET_ZONE OPSGROUP.engagedetectedEngageZones

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

Core.Set#SET_ZONE OPSGROUP.engagedetectedNoEngageZones

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

#boolean OPSGROUP.engagedetectedOn

If true, auto engage detected targets.

#number OPSGROUP.engagedetectedRmax

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

#table OPSGROUP.engagedetectedTypes

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

#boolean OPSGROUP.groupinitialized

If true, group parameters were initialized.

#string OPSGROUP.groupname

Name of the group.

#number OPSGROUP.heading

Heading of the group at last status check.

#number OPSGROUP.headingLast

Backup of last heading to monitor changes.

Wrapper.Airbase#AIRBASE OPSGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE OPSGROUP.homezone

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

#OPSGROUP.Beacon OPSGROUP.icls

Current ICLS settings.

#OPSGROUP.Beacon OPSGROUP.iclsDefault

Default ICLS settings.

Core.Set#SET_ZONE OPSGROUP.inzones

Set of zones in which the group is currently in.

#boolean OPSGROUP.isAI

If true, group is purely AI.

#boolean OPSGROUP.isArmygroup

Is an ARMYGROUP.

#boolean OPSGROUP.isDead

If true, the whole group is dead.

#boolean OPSGROUP.isDestroyed

If true, the whole group was destroyed.

OPSGROUP.isEPLRS

Has this a datalink?

#boolean OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

#boolean OPSGROUP.isHelo

If true, this is a helicopter group.

#boolean OPSGROUP.isLateActivated

Is the group late activated.

#boolean OPSGROUP.isMobile

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

#boolean OPSGROUP.isNavygroup

Is a NAVYGROUP.

#boolean OPSGROUP.isSubmarine

If true, this is a submarine group.

#boolean OPSGROUP.isTrain
#boolean OPSGROUP.isUncontrolled

Is the group uncontrolled.

#boolean OPSGROUP.isVTOL

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

#boolean OPSGROUP.ispathfinding

If true, group is on pathfinding route.

Ops.Legion#LEGION OPSGROUP.legion

Legion the group belongs to.

#string OPSGROUP.lid

Class id string for output to DCS log file.

#number OPSGROUP.life
#table OPSGROUP.missionqueue

Queue of missions.

Sound.SRS#MSRS OPSGROUP.msrs

MOOSE SRS wrapper.

#OPSGROUP.MyCarrier OPSGROUP.mycarrier

Carrier group for this group.

#OPSGROUP.Option OPSGROUP.option

Current optional settings.

#OPSGROUP.Option OPSGROUP.optionDefault

Default option settings.

DCS#Vec3 OPSGROUP.orientX

Orientation at last status check.

DCS#Vec3 OPSGROUP.orientXLast

Backup of last orientation to monitor changes.

#boolean OPSGROUP.passedfinalwp

Group has passed the final waypoint.

#table OPSGROUP.pausedmissions

Paused missions.

DCS#Vec3 OPSGROUP.position

Position of the group at last status check.

DCS#Vec3 OPSGROUP.positionLast

Backup of last position vec to monitor changes.

#OPSGROUP.Radio OPSGROUP.radio

Current radio settings.

#OPSGROUP.Radio OPSGROUP.radioDefault

Default radio settings.

#boolean OPSGROUP.rearmOnOutOfAmmo

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

#table OPSGROUP.reconindecies

Init a table.

OPSGROUP.speed

Set speed to next wp.

#number OPSGROUP.speedCruise

Cruising speed in km/h.

#number OPSGROUP.speedMax

Max speed in km/h.

#number OPSGROUP.speedWp

Speed to the next waypoint in m/s.

#OPSGROUP.Spot OPSGROUP.spot

Laser and IR spot.

#OPSGROUP.Beacon OPSGROUP.tacan

Current TACAN settings.

#OPSGROUP.Beacon OPSGROUP.tacanDefault

Default TACAN settings.

#number OPSGROUP.taskcounter

Running number of task ids.

#number OPSGROUP.taskcurrent

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

#table OPSGROUP.taskenroute

Enroute task of the group.

#table OPSGROUP.taskpaused

Paused tasks.

#table OPSGROUP.taskqueue

Queue of tasks.

DCS#Template OPSGROUP.template

Template table of the group.

Core.Timer#TIMER OPSGROUP.timerCheckZone

Timer for check zones.

Core.Timer#TIMER OPSGROUP.timerQueueUpdate

Timer for queue updates.

Core.Timer#TIMER OPSGROUP.timerStatus

Timer for status update.

#number OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

OPSGROUP.travelds

Travel distance since last check.

#number OPSGROUP.traveltime

Time.

#boolean OPSGROUP.useMEtasks

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

#boolean OPSGROUP.useSRS

Use SRS for transmissions.

#number OPSGROUP.verbose

Verbosity level. 0=silent.

#string OPSGROUP.version

OpsGroup version.

#table OPSGROUP.waypoints

Table of waypoints.

#table OPSGROUP.waypoints0

Table of initial waypoints.

#OPSGROUP.WeaponData OPSGROUP.weaponData

Weapon data table with key=BitType.

#number OPSGROUP.wpcounter

Running number counting waypoints.

Function(s)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns the End states.

Defined in:

Return value:

#table:

End states.

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Sub processes.

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

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

Defined in:

Return value:

#table:

Transitions.

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

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.

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

Call handler.

Defined in:

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#string OPSGROUP.ClassName

Name of the class.

#number OPSGROUP.Ndestroyed

Number of destroyed units.

#number OPSGROUP.Nhit

Number of hits taken.

#number OPSGROUP.Nkills

Number kills of this groups.

#number OPSGROUP.Twaiting

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

OPSGROUP.actype

Set type name.

#boolean OPSGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

#OPSGROUP.Ammo OPSGROUP.ammo

Initial ammount of ammo.

#string OPSGROUP.attribute

Generalized attribute.

#OPSGROUP.Callsign OPSGROUP.callsign

Current callsign settings.

#string OPSGROUP.callsignAlias

Callsign alias.

#OPSGROUP.Callsign OPSGROUP.callsignDefault

Default callsign settings.

#string OPSGROUP.callsignName

Callsign name.

#table OPSGROUP.cargoBay

Table containing OPSGROUP loaded into this group.

#string OPSGROUP.cargoStatus

Cargo status of this group acting as cargo.

Ops.OpsTransport#OPSTRANSPORT.TransportZoneCombo OPSGROUP.cargoTZC

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

Ops.OpsTransport#OPSTRANSPORT OPSGROUP.cargoTransport

Current cargo transport assignment.

#number OPSGROUP.cargoTransportUID

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

#table OPSGROUP.cargoqueue

Table containing cargo groups to be transported.

#OPSGROUP.Element OPSGROUP.carrier

Carrier the group is loaded into as cargo.

#OPSGROUP OPSGROUP.carrierGroup

Carrier group transporting this group as cargo.

#OPSGROUP.CarrierLoader OPSGROUP.carrierLoader

Carrier loader parameters.

#string OPSGROUP.carrierStatus

Carrier status of this group acting as cargo carrier.

#OPSGROUP.CarrierLoader OPSGROUP.carrierUnloader

Carrier unloader parameters.

OPSGROUP.category

Category.

Ops.Cohort#COHORT OPSGROUP.cohort

Cohort the group belongs to.

DCS#Controller OPSGROUP.controller

The DCS controller of the group.

Wrapper.Airbase#AIRBASE OPSGROUP.currbase

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

#number OPSGROUP.currentmission

The ID (auftragsnummer) of the currently assigned AUFTRAG.

#number OPSGROUP.currentwp

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

#number OPSGROUP.dTwait

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

DCS#Group OPSGROUP.dcsgroup

The DCS group object.

OPSGROUP.descriptors

Get Descriptors.

Wrapper.Airbase#AIRBASE OPSGROUP.destbase

The destination base of the flight group.

Core.Zone#ZONE OPSGROUP.destzone

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

Core.Set#SET_UNIT OPSGROUP.detectedunits

Set of detected units.

#boolean OPSGROUP.detectionOn

If true, detected units of the group are analyzed.

#table OPSGROUP.elements

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

Core.Set#SET_ZONE OPSGROUP.engagedetectedEngageZones

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

Core.Set#SET_ZONE OPSGROUP.engagedetectedNoEngageZones

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

#boolean OPSGROUP.engagedetectedOn

If true, auto engage detected targets.

#number OPSGROUP.engagedetectedRmax

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

#table OPSGROUP.engagedetectedTypes

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

#boolean OPSGROUP.groupinitialized

If true, group parameters were initialized.

#string OPSGROUP.groupname

Name of the group.

#number OPSGROUP.heading

Heading of the group at last status check.

#number OPSGROUP.headingLast

Backup of last heading to monitor changes.

Wrapper.Airbase#AIRBASE OPSGROUP.homebase

The home base of the flight group.

Core.Zone#ZONE OPSGROUP.homezone

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

#OPSGROUP.Beacon OPSGROUP.icls

Current ICLS settings.

#OPSGROUP.Beacon OPSGROUP.iclsDefault

Default ICLS settings.

Core.Set#SET_ZONE OPSGROUP.inzones

Set of zones in which the group is currently in.

#boolean OPSGROUP.isAI

If true, group is purely AI.

#boolean OPSGROUP.isArmygroup

Is an ARMYGROUP.

#boolean OPSGROUP.isDead

If true, the whole group is dead.

#boolean OPSGROUP.isDestroyed

If true, the whole group was destroyed.

OPSGROUP.isEPLRS

Has this a datalink?

#boolean OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

#boolean OPSGROUP.isHelo

If true, this is a helicopter group.

#boolean OPSGROUP.isLateActivated

Is the group late activated.

#boolean OPSGROUP.isMobile

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

#boolean OPSGROUP.isNavygroup

Is a NAVYGROUP.

#boolean OPSGROUP.isSubmarine

If true, this is a submarine group.

#boolean OPSGROUP.isTrain
#boolean OPSGROUP.isUncontrolled

Is the group uncontrolled.

#boolean OPSGROUP.isVTOL

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

#boolean OPSGROUP.ispathfinding

If true, group is on pathfinding route.

Ops.Legion#LEGION OPSGROUP.legion

Legion the group belongs to.

#string OPSGROUP.lid

Class id string for output to DCS log file.

#number OPSGROUP.life
#table OPSGROUP.missionqueue

Queue of missions.

Sound.SRS#MSRS OPSGROUP.msrs

MOOSE SRS wrapper.

#OPSGROUP.MyCarrier OPSGROUP.mycarrier

Carrier group for this group.

#OPSGROUP.Option OPSGROUP.option

Current optional settings.

#OPSGROUP.Option OPSGROUP.optionDefault

Default option settings.

DCS#Vec3 OPSGROUP.orientX

Orientation at last status check.

DCS#Vec3 OPSGROUP.orientXLast

Backup of last orientation to monitor changes.

#boolean OPSGROUP.passedfinalwp

Group has passed the final waypoint.

#table OPSGROUP.pausedmissions

Paused missions.

DCS#Vec3 OPSGROUP.position

Position of the group at last status check.

DCS#Vec3 OPSGROUP.positionLast

Backup of last position vec to monitor changes.

#OPSGROUP.Radio OPSGROUP.radio

Current radio settings.

#OPSGROUP.Radio OPSGROUP.radioDefault

Default radio settings.

#boolean OPSGROUP.rearmOnOutOfAmmo

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

#table OPSGROUP.reconindecies

Init a table.

OPSGROUP.speed

Set speed to next wp.

#number OPSGROUP.speedCruise

Cruising speed in km/h.

#number OPSGROUP.speedMax

Max speed in km/h.

#number OPSGROUP.speedWp

Speed to the next waypoint in m/s.

#OPSGROUP.Spot OPSGROUP.spot

Laser and IR spot.

#OPSGROUP.Beacon OPSGROUP.tacan

Current TACAN settings.

#OPSGROUP.Beacon OPSGROUP.tacanDefault

Default TACAN settings.

#number OPSGROUP.taskcounter

Running number of task ids.

#number OPSGROUP.taskcurrent

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

#table OPSGROUP.taskenroute

Enroute task of the group.

#table OPSGROUP.taskpaused

Paused tasks.

#table OPSGROUP.taskqueue

Queue of tasks.

DCS#Template OPSGROUP.template

Template table of the group.

Core.Timer#TIMER OPSGROUP.timerCheckZone

Timer for check zones.

Core.Timer#TIMER OPSGROUP.timerQueueUpdate

Timer for queue updates.

Core.Timer#TIMER OPSGROUP.timerStatus

Timer for status update.

#number OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

OPSGROUP.travelds

Travel distance since last check.

#number OPSGROUP.traveltime

Time.

#boolean OPSGROUP.useMEtasks

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

#boolean OPSGROUP.useSRS

Use SRS for transmissions.

#number OPSGROUP.verbose

Verbosity level. 0=silent.

#string OPSGROUP.version

OpsGroup version.

#table OPSGROUP.waypoints

Table of waypoints.

#table OPSGROUP.waypoints0

Table of initial waypoints.

#OPSGROUP.WeaponData OPSGROUP.weaponData

Weapon data table with key=BitType.

#number OPSGROUP.wpcounter

Running number counting 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.

IniObjectCategory

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

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.

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.

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 Core.Event processing Priority.

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

Defined in:

Return value:

#number:

The Core.Event processing Priority.

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, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

Event ID.

#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 Event for an object is triggered.

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

Defined in:

Parameter:

The EventData structure.

BDA.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

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

Defined in:

Parameter:

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.

Discard chair after ejection.

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

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has ejected

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

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

Defined in:

Parameter:

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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

The EventData structure.

Landing quality mark.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

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

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Weapon add.

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

Defined in:

Parameter:

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. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

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

Defined in:

Parameter:

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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

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. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

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. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Trigger zone.

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

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

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

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:

#string:

The Schedule ID 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:

#string:

The Schedule ID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

Set the Class Core.Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

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

Class name.

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

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:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Ammo data.

Field(s)

#number OPSGROUP.Ammo.Bombs

Amount of bombs.

#number OPSGROUP.Ammo.Guns

Amount of gun shells.

#number OPSGROUP.Ammo.Missiles

Amount of missiles.

#number OPSGROUP.Ammo.MissilesAA

Amount of air-to-air missiles.

#number OPSGROUP.Ammo.MissilesAG

Amount of air-to-ground missiles.

#number OPSGROUP.Ammo.MissilesAS

Amount of anti-ship missiles.

#number OPSGROUP.Ammo.MissilesBM

Amount of ballistic missiles.

#number OPSGROUP.Ammo.MissilesCR

Amount of cruise missiles.

#number OPSGROUP.Ammo.MissilesSA

Amount of surfe-to-air missiles.

#number OPSGROUP.Ammo.Rockets

Amount of rockets.

#number OPSGROUP.Ammo.Torpedos

Amount of torpedos.

#number OPSGROUP.Ammo.Total

Total amount of ammo.

Function(s)

Beacon data.

Field(s)

#string OPSGROUP.Beacon.Band

Band "X" or "Y" for TACAN beacon.

#string OPSGROUP.Beacon.BeaconName

Name of the unit acting as beacon.

Wrapper.Unit#UNIT OPSGROUP.Beacon.BeaconUnit

Unit object acting as beacon.

#number OPSGROUP.Beacon.Channel

Channel.

#number OPSGROUP.Beacon.Morse

Morse Code.

#boolean OPSGROUP.Beacon.On

If true, beacon is on, if false, beacon is turned off. If nil, has not been used yet.

Function(s)

Callsign data.

Field(s)

#string OPSGROUP.Callsign.NameSquad

Name of the squad, e.g. "Uzi".

#number OPSGROUP.Callsign.NumberGroup

Group number. First number after name, e.g. "Uzi-1-1".

#number OPSGROUP.Callsign.NumberSquad

Squadron number corresponding to a name like "Uzi".

Function(s)

Cargo group data.

Field(s)

#boolean OPSGROUP.CargoGroup.delivered

If true, group was delivered.

#boolean OPSGROUP.CargoGroup.disembarkActivation

If true, group is activated. If false, group is late activated.

Core.Set#SET_OPSGROUP OPSGROUP.CargoGroup.disembarkCarriers

Carriers where this group is directly disembared to.

Core.Zone#ZONE OPSGROUP.CargoGroup.disembarkZone

Zone where this group is disembarked to.

#string OPSGROUP.CargoGroup.status

Status of the cargo group. Not used yet.

#string OPSGROUP.CargoGroup.type

Type of cargo: "OPSGROUP" or "STORAGE".

#number OPSGROUP.CargoGroup.uid

Unique ID of this cargo data.

Function(s)

Cargo status.

Field(s)

#string OPSGROUP.CargoStatus.ASSIGNED

Cargo is assigned to a carrier. (Not used!)

#string OPSGROUP.CargoStatus.AWAITING

Group is awaiting carrier.

#string OPSGROUP.CargoStatus.BOARDING

Cargo is boarding a carrier.

#string OPSGROUP.CargoStatus.LOADED

Cargo is loaded into a carrier.

#string OPSGROUP.CargoStatus.NOTCARGO

This group is no cargo yet.

Function(s)

Cargo carrier loader parameters.

Field(s)

#number OPSGROUP.CarrierLoader.length

Length of (un-)loading zone in meters.

#string OPSGROUP.CarrierLoader.type

Loader type "Front", "Back", "Left", "Right", "All".

#number OPSGROUP.CarrierLoader.width

Width of (un-)loading zone in meters.

Function(s)

Cargo Carrier status.

Field(s)

#string OPSGROUP.CarrierStatus.LOADED

Carrier has loaded cargo.

#string OPSGROUP.CarrierStatus.LOADING

Carrier is loading cargo.

#string OPSGROUP.CarrierStatus.NOTCARRIER

This group is not a carrier yet.

#string OPSGROUP.CarrierStatus.PICKUP

Carrier is on its way to pickup cargo.

#string OPSGROUP.CarrierStatus.TRANSPORTING

Carrier is transporting cargo.

#string OPSGROUP.CarrierStatus.UNLOADING

Carrier is unloading cargo.

Function(s)

OPS group element.

Field(s)

DCS#Unit OPSGROUP.Element.DCSunit

The DCS unit object.

#number OPSGROUP.Element.Nhit

Number of times the element was hit.

#boolean OPSGROUP.Element.ai

If true, element is AI.

#string OPSGROUP.Element.callsign

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

#table OPSGROUP.Element.cargoBay

Cargo bay.

#number OPSGROUP.Element.category

Aircraft category.

#string OPSGROUP.Element.categoryname

Aircraft category name.

Wrapper.Client#CLIENT OPSGROUP.Element.client

The client if element is occupied by a human player.

DCS#Controller OPSGROUP.Element.controller

The DCS controller of the unit.

#number OPSGROUP.Element.damage

Damage of element in percent.

#boolean OPSGROUP.Element.engineOn

If true, engines were started.

#number OPSGROUP.Element.fuelmass

Mass of fuel in kg.

#number OPSGROUP.Element.heading

Last known heading in degrees.

#number OPSGROUP.Element.height

Height of element in meters.

#number OPSGROUP.Element.length

Length of element in meters.

#number OPSGROUP.Element.life

Life points when last updated.

#number OPSGROUP.Element.life0

Initial life points.

#string OPSGROUP.Element.modex

Tail number.

#string OPSGROUP.Element.name

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

DCS#Vec3 OPSGROUP.Element.orientX

Last known ordientation vector in the direction of the nose X.

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

The parking spot table the element is parking on.

#string OPSGROUP.Element.playerName

Name of player if this is a client.

#table OPSGROUP.Element.pylons

Table of pylons.

#number OPSGROUP.Element.size

Size (max of length, width, height) in meters.

#string OPSGROUP.Element.skill

Skill level.

#string OPSGROUP.Element.status

The element status. See OPSGROUP.ElementStatus.

#string OPSGROUP.Element.typename

Type name.

DCS#Vec3 OPSGROUP.Element.vec3

Last known 3D position vector.

#number OPSGROUP.Element.weight

Current weight including cargo in kg.

#number OPSGROUP.Element.weightCargo

Current cargo weight in kg.

#number OPSGROUP.Element.weightEmpty

Empty weight in kg.

#number OPSGROUP.Element.weightMaxCargo

Max. cargo weight in kg.

#number OPSGROUP.Element.weightMaxTotal

Max. total weight in kg.

#number OPSGROUP.Element.width

Width of element in meters.

Core.Zone#ZONE_POLYGON_BASE OPSGROUP.Element.zoneBoundingbox

Bounding box zone of the element unit.

Function(s)

Status of group element.

Field(s)

#string OPSGROUP.ElementStatus.AIRBORNE

Element is airborne. Either after takeoff or after air start.

#string OPSGROUP.ElementStatus.ARRIVED

Element arrived at its parking spot and shut down its engines.

#string OPSGROUP.ElementStatus.DEAD

Element is dead after it crashed, pilot ejected or pilot dead events.

#string OPSGROUP.ElementStatus.ENGINEON

Element started its engines.

#string OPSGROUP.ElementStatus.INUTERO

Element was not spawned yet or its status is unknown so far.

#string OPSGROUP.ElementStatus.LANDED

Element landed and is taxiing to its parking spot.

#string OPSGROUP.ElementStatus.LANDING

Element is landing.

#string OPSGROUP.ElementStatus.PARKING

Element is parking after spawned on ramp.

#string OPSGROUP.ElementStatus.SPAWNED

Element was spawned into the world.

#string OPSGROUP.ElementStatus.TAKEOFF

Element took of after takeoff event.

#string OPSGROUP.ElementStatus.TAXIING

Element is taxiing after engine startup.

Function(s)

Status of group.

Field(s)

#string OPSGROUP.GroupStatus.AIRBORNE

Element is airborne. Either after takeoff or after air start.

#string OPSGROUP.GroupStatus.ARRIVED

Arrived at its parking spot and shut down its engines.

#string OPSGROUP.GroupStatus.DEAD

Element is dead after it crashed, pilot ejected or pilot dead events.

#string OPSGROUP.GroupStatus.INUTERO

Not spawned yet or its status is unknown so far.

#string OPSGROUP.GroupStatus.LANDED

Landed and is taxiing to its parking spot.

#string OPSGROUP.GroupStatus.LANDING

Landing.

#string OPSGROUP.GroupStatus.PARKING

Parking after spawned on ramp.

#string OPSGROUP.GroupStatus.TAXIING

Taxiing after engine startup.

Function(s)

Element cargo bay data.

Field(s)

#boolean OPSGROUP.MyCargo.reserved

If true, the cargo bay space is reserved but cargo has not actually been loaded yet.

#number OPSGROUP.MyCargo.storageAmount

Amount of storage.

#number OPSGROUP.MyCargo.storageType

Type of storage.

#number OPSGROUP.MyCargo.storageWeight

Weight of storage item.

Function(s)

Data of the carrier that has loaded this group.

Field(s)

#OPSGROUP OPSGROUP.MyCarrier.group

The carrier group.

#boolean OPSGROUP.MyCarrier.reserved

If true, the carrier has caro space reserved for me.

Function(s)

Option data.

Field(s)

#number OPSGROUP.Option.Alarm

Alarm state.

#boolean OPSGROUP.Option.Disperse

Disperse under fire.

#boolean OPSGROUP.Option.EPLRS

data link.

#boolean OPSGROUP.Option.Emission

Emission on/off.

#number OPSGROUP.Option.Formation

Formation.

#boolean OPSGROUP.Option.Immortal

Immortal on/off.

#boolean OPSGROUP.Option.Invisible

Invisible on/off.

#number OPSGROUP.Option.ROE

Rule of engagement.

#number OPSGROUP.Option.ROT

Reaction on threat.

Function(s)

Radio data.

Field(s)

#number OPSGROUP.Radio.Freq

Frequency

#number OPSGROUP.Radio.Modu

Modulation.

#boolean OPSGROUP.Radio.On

If true, radio is on, if false, radio is turned off. If nil, has not been used yet.

Function(s)

Spawn point data.

Field(s)

#table OPSGROUP.Spawnpoint.TerminalIDs

Terminal IDs, where to spawn the group. It is a table of #numbers because a group can consist of multiple units.

Function(s)

Laser and IR spot data.

Field(s)

#boolean OPSGROUP.Spot.CheckLOS

If true, check LOS to target.

#number OPSGROUP.Spot.Code

Laser code.

Core.Point#COORDINATE OPSGROUP.Spot.Coordinate

where the spot is pointing.

DCS#Spot OPSGROUP.Spot.IR

Infra-red spot.

#boolean OPSGROUP.Spot.IRon

If true, turn IR pointer on.

#boolean OPSGROUP.Spot.LOS

No of sight.

#boolean OPSGROUP.Spot.On

If true, the laser is on.

#boolean OPSGROUP.Spot.Paused

If true, laser is paused.

#number OPSGROUP.Spot.TargetType

Type of target: 0=coordinate, 1=static, 2=unit, 3=group.

#number OPSGROUP.Spot.dt

Update time interval in seconds.

#OPSGROUP.Element OPSGROUP.Spot.element

The element of the group that is lasing.

#boolean OPSGROUP.Spot.lostLOS

If true, laser lost LOS.

DCS#Vec3 OPSGROUP.Spot.offset

Local offset of the laser source.

DCS#Vec3 OPSGROUP.Spot.offsetTarget

Offset of the target.

DCS#Vec3 OPSGROUP.Spot.vec3

The 3D positon vector of the laser (and IR) spot.

Function(s)

Task structure.

Field(s)

#number OPSGROUP.Task.backupROE

Rules of engagement that are restored once the task is over.

#table OPSGROUP.Task.dcstask

DCS task structure.

#string OPSGROUP.Task.description

Brief text which describes the task.

#number OPSGROUP.Task.duration

Duration before task is cancelled in seconds. Default never.

#number OPSGROUP.Task.id

Task ID. Running number to get the task.

#boolean OPSGROUP.Task.ismission

This is an AUFTRAG task.

#number OPSGROUP.Task.prio

Priority.

#string OPSGROUP.Task.status

Task status.

Core.UserFlag#USERFLAG OPSGROUP.Task.stopflag

If flag is set to 1 (=true), the task is stopped.

#number OPSGROUP.Task.time

Abs. mission time when to execute the task.

#number OPSGROUP.Task.timestamp

Abs. mission time, when task was started.

#string OPSGROUP.Task.type

Type of task: either SCHEDULED or WAYPOINT.

#number OPSGROUP.Task.waypoint

Waypoint index if task is a waypoint task.

Function(s)

Ops group task status.

Field(s)

#string OPSGROUP.TaskStatus.DONE

Task is done.

#string OPSGROUP.TaskStatus.EXECUTING

Task is being executed.

#string OPSGROUP.TaskStatus.PAUSED

Task is paused.

#string OPSGROUP.TaskStatus.SCHEDULED

Task is scheduled.

Function(s)

Ops group task status.

Field(s)

#string OPSGROUP.TaskType.SCHEDULED

Task is scheduled and will be executed at a given time.

#string OPSGROUP.TaskType.WAYPOINT

Task is executed at a specific waypoint.

Function(s)

Waypoint data.

Field(s)

#string OPSGROUP.Waypoint.action

Waypoint action (turning point, etc.). Ground groups have the formation here.

#number OPSGROUP.Waypoint.alt

Altitude in meters. For submaries use negative sign for depth.

#boolean OPSGROUP.Waypoint.astar

If true, this waypint was found by A* pathfinding algorithm.

#number OPSGROUP.Waypoint.detour

Signifies that this waypoint is not part of the normal route: 0=Hold, 1=Resume Route.

#string OPSGROUP.Waypoint.formation

Ground formation. Similar to action but on/off road.

#boolean OPSGROUP.Waypoint.intowind

If true, this waypoint is a turn into wind route point.

#number OPSGROUP.Waypoint.missionUID

Mission UID (Auftragsnr) this waypoint belongs to.

#string OPSGROUP.Waypoint.name

Waypoint description. Shown in the F10 map.

#number OPSGROUP.Waypoint.npassed

Number of times a groups passed this waypoint.

#boolean OPSGROUP.Waypoint.patrol

Set types.

#number OPSGROUP.Waypoint.roaddist

Distance to closest point on road.

#number OPSGROUP.Waypoint.speed

Speed in m/s.

#table OPSGROUP.Waypoint.task

Waypoint DCS task combo.

#boolean OPSGROUP.Waypoint.temp

If true, this is a temporary waypoint and will be deleted when passed. Also the passing waypoint FSM event is not triggered.

#string OPSGROUP.Waypoint.type

Waypoint type.

#number OPSGROUP.Waypoint.uid

Waypoint's unit id, which is a running number.

#number OPSGROUP.Waypoint.x

Waypoint x-coordinate.

#number OPSGROUP.Waypoint.y

Waypoint y-coordinate.

Function(s)

Weapon range data.

Field(s)

#number OPSGROUP.WeaponData.BitType

Type of weapon.

#number OPSGROUP.WeaponData.RangeMax

Max range in meters.

#number OPSGROUP.WeaponData.RangeMin

Min range in meters.

#number OPSGROUP.WeaponData.ReloadTime

Time to reload in seconds.

Function(s)