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


Banner Image

The OPSGROUP Concept

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

#OPSGROUP OPSGROUP

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


Banner Image

The OPSGROUP Concept

The OPSGROUP class contains common functions used by other classes such as FLIGHGROUP, 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: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.Astar

path finding.

OPSGROUP:CheckTaskDescriptionUnique(description)

Check if task description is unique.

OPSGROUP.ClassName

Name of the class.

OPSGROUP:ClearTasks(DCSTask)

Clear DCS tasks.

OPSGROUP:CountRemainingMissison()

Count remaining missons.

OPSGROUP:CountRemainingTasks()

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

OPSGROUP:CountTasksWaypoint(uid, id)

Count remaining waypoint tasks.

OPSGROUP.Debug

Debug mode. Messages to all about status.

OPSGROUP:Despawn(Delay, NoEventRemoveUnit)

Despawn the group.

OPSGROUP:DespawnElement(Element, Delay, NoEventRemoveUnit)

Despawn an element/unit of the group.

OPSGROUP:Destroy(Delay)

Destroy group.

OPSGROUP.ElementStatus

OPSGROUP:GetAlarmstate()

Get current Alarm State of the group.

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

Get coalition.

OPSGROUP:GetCoordinate(NewObject)

Get current coordinate of the group.

OPSGROUP:GetDCSGroup()

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

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

OPSGROUP:GetElementByName(unitname)

Get the element of a group.

OPSGROUP:GetExpectedSpeed()

Returns the currently expected speed.

OPSGROUP:GetGroup()

Get MOOSE GROUP object.

OPSGROUP:GetHeading()

Get current heading 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()

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

Get current orientation of the first unit in the group.

OPSGROUP:GetOrientationX()

Get current 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:GetVec2()

Get current 2D position vector of the group.

OPSGROUP:GetVec3()

Get current 3D position vector of the group.

OPSGROUP:GetVelocity()

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

Initialize Mission Editor waypoints.

OPSGROUP:IsActive()

Check if group is activated.

OPSGROUP:IsAlive()

Check if group is alive.

OPSGROUP:IsDead()

Check if group is dead.

OPSGROUP:IsEngaging()

Check if the group is engaging another unit or group.

OPSGROUP:IsExist()

Check if group is exists.

OPSGROUP:IsInUtero()

Check if group is in state in utero.

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

Check if the group is currently rearming.

OPSGROUP:IsRetreating()

Check if the group is currently retreating.

OPSGROUP:IsSpawned()

Check if group is in state spawned.

OPSGROUP:IsStopped()

Check if FSM is stopped.

OPSGROUP:IsUncontrolled()

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

OPSGROUP:MarkWaypoints(Duration)

Mark waypoints on F10 map.

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

Number kills of this groups.

OPSGROUP:PushTask(DCSTask)

Push DCS task.

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:Route(waypoints, delay)

Route group along waypoints.

OPSGROUP:RouteToMission(mission, delay)

Route group to mission.

OPSGROUP:SelfDestruction(Delay, ExplosionPower)

Self destruction of group.

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:SetDefaultCallsign(CallsignName, CallsignNumber)

Set default callsign.

OPSGROUP:SetDefaultFormation(Formation)

Set default formation.

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

Set default ICLS parameters.

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:SetLaser(Code, CheckLOS, IROff, UpdateTime)

Set LASER parameters.

OPSGROUP:SetLaserTarget(Target)

Set LASER target.

OPSGROUP:SetTask(DCSTask)

Set DCS task.

OPSGROUP:SetVerbosity(VerbosityLevel)

Set verbosity level.

OPSGROUP:Status()

Triggers the FSM event "Status".

OPSGROUP:SwitchAlarmstate(alarmstate)

Set current Alarm State of the group.

OPSGROUP:SwitchCallsign(CallsignName, CallsignNumber)

Switch to a specific callsign.

OPSGROUP:SwitchFormation(Formation)

Switch to a specific formation.

OPSGROUP:SwitchICLS(Channel, Morse, UnitName)

Activate/switch ICLS beacon settings.

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

OPSGROUP:TurnOffICLS()

Deactivate ICLS beacon.

OPSGROUP:TurnOffRadio()

Turn radio off.

OPSGROUP:TurnOffTACAN()

Deactivate TACAN beacon.

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

Check damage.

OPSGROUP:_CheckDetectedUnits()

Check detected units.

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:_CreateWaypoint(Waypoint, waypoint)

Enhance waypoint table.

OPSGROUP:_GetNextMission()

Get next mission.

OPSGROUP:_GetNextTask()

Get next task in queue.

OPSGROUP:_GetROEName(roe)

Get name of ROE corresponding to the numerical value.

OPSGROUP:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

OPSGROUP._PassingWaypoint(group, 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:_SetElementStatusAll(status)

Set status for all elements (except dead ones).

OPSGROUP:_SetWaypointTasks(Waypoint)

Set tasks at this waypoint

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

Initialize Mission Editor waypoints.

OPSGROUP:__Status(delay)

Triggers the FSM event "Status" after a delay.

OPSGROUP:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

OPSGROUP.adinfinitum

Resume route at first waypoint when final waypoint is reached.

OPSGROUP.ammo

Initial ammount of ammo.

OPSGROUP.attribute

Generalized attribute.

OPSGROUP.callsign

Current callsign settings.

OPSGROUP.callsignDefault

Default callsign settings.

OPSGROUP.checkzones

Set of zones.

OPSGROUP.coordinate

Current coordinate.

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

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

If true, group is airplane or helicopter.

OPSGROUP.isArmygroup

Is an ARMYGROUP.

OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

OPSGROUP.isGround

If true, group is some ground unit.

OPSGROUP.isLateActivated

Is the group late activated.

OPSGROUP.isNaval

If true, group is ships or submarine.

OPSGROUP.isNavygroup

Is a NAVYGROUP.

OPSGROUP.isUncontrolled

Is the group uncontrolled.

OPSGROUP.ispathfinding

If true, group is on pathfinding route.

OPSGROUP.lid

Class id string for output to DCS log file.

OPSGROUP.life

OPSGROUP.missionpaused

Paused mission.

OPSGROUP.missionqueue

Queue of missions.

OPSGROUP:onafterDead(From, Event, To)

On after "Dead" 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:onafterElementDead(From, Event, To, Element)

On after "ElementDead" event.

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

On after "ElementDestroyed" event.

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

On after "EnterZone" event.

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

On after "GotoWaypoint" 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: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:onafterPassingWaypoint(From, Event, To, Waypoint)

On after "PassingWaypoint" event.

OPSGROUP:onafterPauseMission(From, Event, To)

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

On after "UnpauseMission" event.

OPSGROUP:onbeforeDead(From, Event, To)

On before "Dead" 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:onbeforeTaskDone(From, Event, To, Task)

On before "TaskDone" 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.outofRockets

OPSGROUP.outoffBombs

OPSGROUP.outoffGuns

OPSGROUP.outoffMissiles

OPSGROUP.outoffRockets

OPSGROUP.passedfinalwp

Group has passed the final waypoint.

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

Group is being respawned.

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

OPSGROUP.timerCheckZone

Timer for check zones.

OPSGROUP.timerQueueUpdate

Timer for queue updates.

OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

OPSGROUP.travelds

OPSGROUP.traveltime

Time.

OPSGROUP.velocity

OPSGROUP.velocityLast

OPSGROUP.verbose

Verbosity level. 0=silent.

OPSGROUP.version

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

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)

Creation of a Crash Event.

OPSGROUP:CreateEventDead(EventTime, Initiator)

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 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 object is completely destroyed.

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:OnEventEjection(EventData)

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

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 initiator : The unit that has landed place: Object that the unit landed on.

OPSGROUP:OnEventLandingAfterEjection(EventData)

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

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

OPSGROUP:OnEventMissionStart(EventData)

Occurs when a mission starts

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

Stops the Schedule.

OPSGROUP.Scheduler

OPSGROUP:SetEventPriority(EventPriority)

Set the Class 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:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

OPSGROUP.__

OPSGROUP:onEvent(event)

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

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

Name of group element, e.g. Uzi 11.

OPSGROUP.Callsign.NameSquad

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

OPSGROUP.Callsign.NumberElement

Element number.Second number after name, e.g. "Uzi-1-1"

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

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

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

OPSGROUP.Element.status

The element status.

OPSGROUP.Element.typename

Type name.

OPSGROUP.Element.unit

The UNIT object.

OPSGROUP.Element.width

Width of element in meters.

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

OPSGROUP.EnrouteTask.DCStask

DCS task structure table.

OPSGROUP.EnrouteTask.WaypointIndex

Waypoint number at which the enroute task is added.

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

Formation.

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

Priority.

OPSGROUP.Task.status

Task status.

OPSGROUP.Task.stopflag

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

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

If true, this waypoint is not part of the normal 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.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.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.

#boolean OPSGROUP.Debug

Debug mode. Messages to all about status.

#number OPSGROUP.Ndestroyed

Number of destroyed units.

#number OPSGROUP.Nkills

Number kills of this groups.

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

#OPSGROUP.Callsign OPSGROUP.callsignDefault

Default callsign settings.

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

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.

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

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

If true, group is airplane or helicopter.

#boolean OPSGROUP.isArmygroup

Is an ARMYGROUP.

#boolean OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

#boolean OPSGROUP.isGround

If true, group is some ground unit.

#boolean OPSGROUP.isLateActivated

Is the group late activated.

#boolean OPSGROUP.isNaval

If true, group is ships or submarine.

#boolean OPSGROUP.isNavygroup

Is a NAVYGROUP.

#boolean OPSGROUP.isUncontrolled

Is the group uncontrolled.

#boolean OPSGROUP.ispathfinding

If true, group is on pathfinding route.

#string OPSGROUP.lid

Class id string for output to DCS log file.

#number OPSGROUP.life
#table OPSGROUP.missionqueue

Queue of missions.

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

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

Group is being respawned.

OPSGROUP.speed

Set speed.

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

#table OPSGROUP.template

Template of the group.

Core.Timer#TIMER OPSGROUP.timerCheckZone

Timer for check zones.

Core.Timer#TIMER OPSGROUP.timerQueueUpdate

Timer for queue updates.

#number OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

#number OPSGROUP.traveltime

Time.

#number OPSGROUP.verbose

Verbosity level. 0=silent.

#string OPSGROUP.version

NavyGroup 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

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

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

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

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 waypoint tasks.

Defined in:

OPSGROUP

Parameters:

#number uid

Unique waypoint ID.

id

Return value:

#number:

Number of waypoint tasks.

Despawn the group.

The whole group is despawned and (optionally) a "Remove Unit" event is generated for all current units of the group.

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

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

Get current Alarm State of the group.

Defined in:

OPSGROUP

Return value:

#number:

Current Alarm State.

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

Defined in:

OPSGROUP

Return value:

#number:

Coalition side of carrier.

Get current coordinate of the group.

Defined in:

OPSGROUP

Parameter:

#boolean NewObject

Create a new coordiante object.

Return value:

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

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

Returns the currently expected speed.

Defined in:

OPSGROUP

Return value:

#number:

Expected speed in m/s.

Get MOOSE GROUP object.

Defined in:

OPSGROUP

Return value:

Moose group object.

Get current heading of the group.

Defined in:

OPSGROUP

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 (average) life points of the group.

Defined in:

OPSGROUP

Return values:

#number:

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

#number:

Initial life points.

Get mission by its id (auftragsnummer).

Defined in:

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 current orientation of the first unit in the group.

Defined in:

OPSGROUP

Return values:

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

Orientation Y pointing "upwards".

Orientation Z perpendicular to the "nose".

Get current orientation of the first unit in the group.

Defined in:

OPSGROUP

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 current 2D position vector of the group.

Defined in:

OPSGROUP

Return value:

Vector with x,y components.

Get current 3D position vector of the group.

Defined in:

OPSGROUP

Return value:

Vector with x,y,z components.

Get current velocity of the group.

Defined in:

OPSGROUP

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

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.

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.

Initialize Mission Editor waypoints.

Defined in:

OPSGROUP

Return value:

self

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

Defined in:

OPSGROUP

Return value:

#boolean:

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

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 group is in state in utero.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is not spawned yet.

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

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is rearming.

Check if the group is currently retreating.

Defined in:

OPSGROUP

Return value:

#boolean:

If true, group is retreating.

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

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

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.

Push DCS task.

Defined in:

OPSGROUP

Parameter:

#table DCSTask

DCS task structure.

Return value:

self

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

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

Return value:

#number:

Relative fuel in percent.

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

Defined in:

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

Defined in:

OPSGROUP

Parameters:

#number CallsignName

Callsign name.

#number CallsignNumber

Callsign number.

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

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

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

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

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

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

Defined in:

OPSGROUP

Return value:

self

Check detected units.

Defined in:

OPSGROUP

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.

Enhance waypoint table.

Defined in:

OPSGROUP

Parameters:

data.

waypoint

Return value:

Modified waypoint data.

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 name of ROE corresponding to the numerical value.

Defined in:

OPSGROUP

Parameter:

roe

Return value:

#string:

Name of ROE.

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.

Function called when a group is passing a waypoint.

Defined in:

OPSGROUP

Parameters:

Group that passed the waypoint.

#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

Set status for all elements (except dead ones).

Defined in:

OPSGROUP

Parameter:

#string status

Element status.

Set tasks at this waypoint

Defined in:

OPSGROUP

Parameter:

The waypoint.

Return value:

#number:

Number of tasks.

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.

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.

Initialize Mission Editor waypoints.

Defined in:

OPSGROUP

Parameter:

#number n

Waypoint

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.

On after "Dead" 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 "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 "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.

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

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

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

On before "Dead" event.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

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

Deny transition if task status is PAUSED.

Defined in:

OPSGROUP

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string OPSGROUP.ClassName

Name of the class.

#boolean OPSGROUP.Debug

Debug mode. Messages to all about status.

#number OPSGROUP.Ndestroyed

Number of destroyed units.

#number OPSGROUP.Nkills

Number kills of this groups.

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

#OPSGROUP.Callsign OPSGROUP.callsignDefault

Default callsign settings.

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

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.

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

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

If true, group is airplane or helicopter.

#boolean OPSGROUP.isArmygroup

Is an ARMYGROUP.

#boolean OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

#boolean OPSGROUP.isGround

If true, group is some ground unit.

#boolean OPSGROUP.isLateActivated

Is the group late activated.

#boolean OPSGROUP.isNaval

If true, group is ships or submarine.

#boolean OPSGROUP.isNavygroup

Is a NAVYGROUP.

#boolean OPSGROUP.isUncontrolled

Is the group uncontrolled.

#boolean OPSGROUP.ispathfinding

If true, group is on pathfinding route.

#string OPSGROUP.lid

Class id string for output to DCS log file.

#number OPSGROUP.life
#table OPSGROUP.missionqueue

Queue of missions.

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

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

Group is being respawned.

OPSGROUP.speed

Set speed.

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

#table OPSGROUP.template

Template of the group.

Core.Timer#TIMER OPSGROUP.timerCheckZone

Timer for check zones.

Core.Timer#TIMER OPSGROUP.timerQueueUpdate

Timer for queue updates.

#number OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

#number OPSGROUP.traveltime

Time.

#number OPSGROUP.verbose

Verbosity level. 0=silent.

#string OPSGROUP.version

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

Parameter:

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

#boolean OPSGROUP.Debug

Debug mode. Messages to all about status.

#number OPSGROUP.Ndestroyed

Number of destroyed units.

#number OPSGROUP.Nkills

Number kills of this groups.

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

#OPSGROUP.Callsign OPSGROUP.callsignDefault

Default callsign settings.

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

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.

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

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

If true, group is airplane or helicopter.

#boolean OPSGROUP.isArmygroup

Is an ARMYGROUP.

#boolean OPSGROUP.isFlightgroup

Is a FLIGHTGROUP.

#boolean OPSGROUP.isGround

If true, group is some ground unit.

#boolean OPSGROUP.isLateActivated

Is the group late activated.

#boolean OPSGROUP.isNaval

If true, group is ships or submarine.

#boolean OPSGROUP.isNavygroup

Is a NAVYGROUP.

#boolean OPSGROUP.isUncontrolled

Is the group uncontrolled.

#boolean OPSGROUP.ispathfinding

If true, group is on pathfinding route.

#string OPSGROUP.lid

Class id string for output to DCS log file.

#number OPSGROUP.life
#table OPSGROUP.missionqueue

Queue of missions.

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

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

Group is being respawned.

OPSGROUP.speed

Set speed.

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

#table OPSGROUP.template

Template of the group.

Core.Timer#TIMER OPSGROUP.timerCheckZone

Timer for check zones.

Core.Timer#TIMER OPSGROUP.timerQueueUpdate

Timer for queue updates.

#number OPSGROUP.traveldist

Distance traveled in meters. This is a lower bound.

#number OPSGROUP.traveltime

Time.

#number OPSGROUP.verbose

Verbosity level. 0=silent.

#string OPSGROUP.version

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

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a 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 Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

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 object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

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

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

Defined in:

Parameter:

The EventData structure.

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

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

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.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Event ID.

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event

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

Name of group element, e.g. Uzi 11.

#string OPSGROUP.Callsign.NameSquad

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

#number OPSGROUP.Callsign.NumberElement

Element number.Second number after name, e.g. "Uzi-1-1"

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

OPS group element.

Field(s)

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

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

#string OPSGROUP.Element.status

The element status.

#string OPSGROUP.Element.typename

Type name.

#number OPSGROUP.Element.width

Width of element in meters.

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)

Enroute task.

Field(s)

DCS#Task OPSGROUP.EnrouteTask.DCStask

DCS task structure table.

#number OPSGROUP.EnrouteTask.WaypointIndex

Waypoint number at which the enroute task is added.

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.

#number OPSGROUP.Option.Formation

Formation.

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

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

Has line 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.

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

#boolean OPSGROUP.Waypoint.detour

If true, this waypoint is not part of the normal 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.

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

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