Banner Image

Module Tasking.Task_A2G_Dispatcher

Tasking -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.

Features:

  • Dynamically assign tasks to human players based on detected targets.
  • Dynamically change the tasks as the tactical situation evolves during the mission.
  • Dynamically assign (CAS) Close Air Support tasks for human players.
  • Dynamically assign (BAI) Battlefield Air Interdiction tasks for human players.
  • Dynamically assign (SEAD) Supression of Enemy Air Defense tasks for human players to eliminate G2A missile threats.
  • Define and use an EWR (Early Warning Radar) network.
  • Define different ranges to engage upon intruders.
  • Keep task achievements.
  • Score task achievements.--

Author: FlightControl

Contributions:


Global(s)

Global TASK_A2G_DISPATCHER

Orchestrates dynamic A2G Task Dispatching based on the detection results of a linked Detection object.

#TASK_A2G_DISPATCHER TASK_A2G_DISPATCHER

Orchestrates dynamic A2G Task Dispatching based on the detection results of a linked Detection object.

It uses the Tasking System within the MOOSE framework, which is a multi-player Tasking Orchestration system. It provides a truly dynamic battle environment for pilots and ground commanders to engage upon, in a true co-operation environment wherein Multiple Teams will collaborate in Missions to achieve a common Mission Goal.

The A2G dispatcher will dispatch the A2G Tasks to a defined Set of Wrapper.Groups that will be manned by Players.
We call this the AttackSet of the A2G dispatcher. So, the Players are seated in the Clients of the Wrapper.Group Set.

Depending on the actions of the enemy, preventive tasks are dispatched to the players to orchestrate the engagement in a true co-operation. The detection object will group the detected targets by its grouping method, and integrates a Set of Wrapper.Groups that are Recce vehicles or air units. We call this the RecceSet of the A2G dispatcher.

Depending on the current detected tactical situation, different task types will be dispatched to the Players seated in the AttackSet.. There are currently 3 Task Types implemented in the TASK_A2G_DISPATCHER:

  • SEAD Task: Dispatched when there are ground based Radar Emitters detected within an area.
  • CAS Task: Dispatched when there are no ground based Radar Emitters within the area, but there are friendly ground Units within 6 km from the enemy.
  • BAI Task: Dispatched when there are no ground based Radar Emitters within the area, and there aren't friendly ground Units within 6 km from the enemy.

0. Tactical Situations

This chapters provides some insights in the tactical situations when certain Task Types are created. The Task Types are depending on the enemy positions that were detected, and the current location of friendly units.

In the demonstration mission [TAD-A2G-000 - AREAS - Detection test], the tactical situation is a demonstration how the A2G detection works. This example will be taken further in the explanation in the following chapters.

The red coalition are the players, the blue coalition is the enemy.

Red reconnaissance vehicles and airborne units are detecting the targets. We call this the RecceSet as explained above, which is a Set of Groups that have a group name starting with Recce (configured in the mission script).

Red attack units are responsible for executing the mission for the command center. We call this the AttackSet, which is a Set of Groups with a group name starting with Attack (configured in the mission script). These units are setup in this demonstration mission to be ground vehicles and airplanes. For demonstration purposes, the attack airplane is stationed on the ground to explain the messages and the menus properly. Further test missions demonstrate the A2G task dispatcher from within air.

Depending upon the detection results, the A2G dispatcher will create different tasks.

0.1. SEAD Task

A SEAD Task is dispatched when there are ground based Radar Emitters detected within an area.

  • Once all Radar Emitting Units have been destroyed, the Task will convert into a BAI or CAS task!
  • A CAS and BAI task may be converted into a SEAD task, once a radar has been detected within the area!

0.2. CAS Task

A CAS Task is dispatched when there are no ground based Radar Emitters within the area, but there are friendly ground Units within 6 km from the enemy.

  • After the detection of the CAS task, if the friendly Units are destroyed, the CAS task will convert into a BAI task!
  • Only ground Units are taken into account. Airborne units are ships are not considered friendlies that require Close Air Support.

0.3. BAI Task

A BAI Task is dispatched when there are no ground based Radar Emitters within the area, and there aren't friendly ground Units within 6 km from the enemy.

  • A BAI task may be converted into a CAS task if friendly Ground Units approach within 6 km range!

1. Player Experience

The A2G dispatcher is residing under a CommandCenter, which is orchestrating a Mission. As a result, you'll find for DCS World missions that implement the A2G dispatcher a Command Center Menu and under this one or more Mission Menus.

For example, if there are 2 Command Centers (CC). Each CC is controlling a couple of Missions, the Radio Menu Structure could look like this:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Gori]
   F1. Mission "Alpha (Primary)"
   F2. Mission "Beta (Secondary)"
   F3. Mission "Gamma (Tactical)"
 F1. Command Center [Lima]
   F1. Mission "Overlord (High)"

Command Center [Gori] is controlling Mission "Alpha", "Beta", "Gamma". Alpha is the Primary mission, Beta the Secondary and there is a Tacical mission Gamma. Command Center [Lima] is controlling Missions "Overlord", which needs to be executed with High priority.

1.1. Mission Menu (Under the Command Center Menu)

The Mission Menu controls the information of the mission, including the:

  • Mission Briefing: A briefing of the Mission in text, which will be shown as a message.
  • Mark Task Locations: A summary of each Task will be shown on the map as a marker.
  • Create Task Reports: A menu to create various reports of the current tasks dispatched by the A2G dispatcher.
  • Create Mission Reports: A menu to create various reports on the current mission.

For CC [Lima], Mission "Overlord", the menu structure could look like this:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Lima]
   F1. Mission "Overlord"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports

1.1.1. Mission Briefing Menu

The Mission Briefing Menu will show in text a summary description of the overall mission objectives and expectations. Note that the Mission Briefing is not the briefing of a specific task, but rather provides an overall strategy and tactical situation, and explains the mission goals.

1.1.2. Mark Task Locations Menu

The Mark Task Locations Menu will mark the location indications of the Tasks on the map, if this intelligence is known by the Command Center. For A2G tasks this information will always be know, but it can be that for other tasks a location intelligence will be less relevant. Note that each Planned task and each Engaged task will be marked. Completed, Failed and Cancelled tasks are not marked. Depending on the task type, a summary information is shown to bring to the player the relevant information for situational awareness.

1.1.3. Task Reports Menu

The Task Reports Menu is a sub menu, that allows to create various reports:

  • Tasks Summary: This report will list all the Tasks that are or were active within the mission, indicating its status.
  • Planned Tasks: This report will list all the Tasks that are in status Planned, which are Tasks not assigned to any player, and are ready to be executed.
  • Assigned Tasks: This report will list all the Tasks that are in status Assigned, which are Tasks assigned to (a) player(s) and are currently executed.
  • Successful Tasks: This report will list all the Tasks that are in status Success, which are Tasks executed by (a) player(s) and are completed successfully.
  • Failed Tasks: This report will list all the Tasks that are in status Success, which are Tasks executed by (a) player(s) and that have failed.

The information shown of the tasks will vary according the underlying task type, but are self explanatory.

For CC [Gori], Mission "Alpha", the Task Reports menu structure could look like this:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Gori]
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
       F1. Tasks Summary
       F2. Planned Tasks
       F3. Assigned Tasks
       F4. Successful Tasks
       F5. Failed Tasks
     F4. Mission Reports

Note that these reports provide an "overview" of the tasks. Detailed information of the task can be retrieved using the Detailed Report on the Task Menu. (See later).

1.1.4. Mission Reports Menu

The Mission Reports Menu is a sub menu, that provides options to retrieve further information on the current Mission:

  • Report Mission Progress: Shows the progress of the current Mission. Each Task has a %-tage of completion.
  • Report Players per Task: Show which players are engaged on which Task within the Mission.

For CC |Gori|, Mission "Alpha", the Mission Reports menu structure could look like this:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Gori]
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports
       F1. Report Mission Progress
       F2. Report Players per Task

1.2. Task Management Menus

Very important to remember is: Multiple Players can be assigned to the same Task, but from the player perspective, the Player can only be assigned to one Task per Mission at the same time! Consider this like the two major modes in which a player can be in. He can be free of tasks or he can be assigned to a Task. Depending on whether a Task has been Planned or Assigned to a Player (Group), the Mission Menu will contain extra Menus to control specific Tasks.

1.2.1. Join a Planned Task

If the Player has not yet been assigned to a Task within the Mission, the Mission Menu will contain additionally a:

  • Join Planned Task Menu: This menu structure allows the player to join a planned task (a Task with status Planned).

For CC |Gori|, Mission "Alpha", the menu structure could look like this:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Gori]
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports
     F5. Join Planned Task

The F5. Join Planned Task allows the player to join a Planned Task and take an engagement in the running Mission.

1.2.2. Manage an Assigned Task

If the Player has been assigned to one Task within the Mission, the Mission Menu will contain an extra:

  • Assigned Task TaskName Menu: This menu structure allows the player to take actions on the currently engaged task.

In this example, the Group currently seated by the player is not assigned yet to a Task. The Player has the option to assign itself to a Planned Task using menu option F5 under the Mission Menu "Alpha".

This would be an example menu structure, for CC |Gori|, Mission "Alpha", when a player would have joined Task CAS.001:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Gori]
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports
     F5. Assigned Task CAS.001

The F5. Assigned Task TaskName allows the player to control the current Assigned Task and take further actions.

1.3. Join Planned Task Menu

The Join Planned Task Menu contains the different Planned A2G Tasks in a structured Menu Hierarchy. The Menu Hierarchy is structuring the Tasks per Task Type, and then by Task Name (ID).

For example, for CC [Gori], Mission "Alpha", if a Mission "ALpha" contains 5 Planned Tasks, which would be:

  • 2 CAS Tasks
  • 1 BAI Task
  • 2 SEAD Tasks

the Join Planned Task Menu Hierarchy could look like this:

 Radio MENU Structure (F10. Other)

 F1. Command Center [Gori]
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports
     F5. Join Planned Task
       F2. BAI
         F1. BAI.001
       F1. CAS
         F1. CAS.002
       F3. SEAD
         F1. SEAD.003
         F2. SEAD.004
         F3. SEAD.005

An example from within a running simulation:

Each Task Type Menu would have a list of the Task Menus underneath. Each Task Menu (eg. CAS.001) has a detailed Task Menu structure to control the specific task!

1.3.1. Planned Task Menu

Each Planned Task Menu will allow for the following actions:

  • Report Task Details: Provides a detailed report on the Planned Task.
  • Mark Task Location on Map: Mark the approximate location of the Task on the Map, if relevant.
  • Join Task: Join the Task. This is THE menu option to let a Player join the Task, and to engage within the Mission.

The Join Planned Task Menu could look like this for for CC |Gori|, Mission "Alpha":

 Radio MENU Structure (F10. Other)

 F1. Command Center |Gori|
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports
     F5. Join Planned Task
       F1. CAS
         F1. CAS.001
           F1. Report Task Details
           F2. Mark Task Location on Map
           F3. Join Task

The Join Task is THE menu option to let a Player join the Task, and to engage within the Mission.

1.4. Assigned Task Menu

The Assigned Task Menu allows to control the current assigned task within the Mission.

Depending on the Type of Task, the following menu options will be available:

  • Report Task Details: Provides a detailed report on the Planned Task.
  • Mark Task Location on Map: Mark the approximate location of the Task on the Map, if relevant.
  • Abort Task: Abort the current assigned Task: This menu option lets the player abort the Task.

For example, for CC |Gori|, Mission "Alpha", the Assigned Menu could be:

 F1. Command Center |Gori|
   F1. Mission "Alpha"
     F1. Mission Briefing
     F2. Mark Task Locations on Map
     F3. Task Reports
     F4. Mission Reports
     F5. Assigned Task
       F1. Report Task Details
       F2. Mark Task Location on Map
       F3. Abort Task

Task abortion will result in the Task to be Cancelled, and the Task may be Replanned. However, this will depend on the setup of each Mission.

1.5. Messages

During game play, different messages are displayed. These messages provide an update of the achievements made, and the state wherein the task is.

The various reports can be used also to retrieve the current status of the mission and its tasks.

The Settings menu provides additional options to control the timing of the messages. There are:

  • Status messages, which are quick status updates. The settings menu allows to switch off these messages.
  • Information messages, which are shown a bit longer, as they contain important information.
  • Summary reports, which are quick reports showing a high level summary.
  • Overview reports, which are providing the essential information. It provides an overview of a greater thing, and may take a bit of time to read.
  • Detailed reports, which provide with very detailed information. It takes a bit longer to read those reports, so the display of those could be a bit longer.

2. TASK_A2G_DISPATCHER constructor

The TASK_A2G_DISPATCHER.New() method creates a new TASK_A2G_DISPATCHER instance.

3. Usage

To use the TASK_A2G_DISPATCHER class, you need:

Below an example mission declaration that is defines a Task A2G Dispatcher object.

-- Declare the Command Center 
local HQ = GROUP
  :FindByName( "HQ", "Bravo HQ" )

local CommandCenter = COMMANDCENTER
  :New( HQ, "Lima" )

-- Declare the Mission for the Command Center.
local Mission = MISSION
  :New( CommandCenter, "Overlord", "High", "Attack Detect Mission Briefing", coalition.side.RED )

-- Define the RecceSet that will detect the enemy.
local RecceSet = SET_GROUP
  :New()
  :FilterPrefixes( "FAC" )
  :FilterCoalitions("red")
  :FilterStart()

-- Setup the detection. We use DETECTION_AREAS to detect and group the enemies within areas of 3 km radius.
local DetectionAreas = DETECTION_AREAS
  :New( RecceSet, 3000 )  -- The RecceSet will detect the enemies.

-- Setup the AttackSet, which is a SET_GROUP.
-- The SET_GROUP is a dynamic collection of GROUP objects.  
local AttackSet = SET_GROUP
  :New()  -- Create the SET_GROUP object.
  :FilterCoalitions( "red" ) -- Only incorporate the RED coalitions.
  :FilterPrefixes( "Attack" ) -- Only incorporate groups that start with the name Attack.
  :FilterStart() -- Enable the dynamic filtering. From this moment the AttackSet will contain all groups that are red and start with the name Attack.

-- Now we have everything to setup the main A2G TaskDispatcher.
TaskDispatcher = TASK_A2G_DISPATCHER
  :New( Mission, AttackSet, DetectionAreas ) -- We assign the TaskDispatcher under Mission. The AttackSet will engage the enemy and will recieve the dispatched Tasks. The DetectionAreas will report any detected enemies to the TaskDispatcher.

Type(s)

Fields and Methods inherited from TASK_A2G_DISPATCHER Description

TASK_A2G_DISPATCHER.Detection

The DETECTION_BASE object that is used to report the detected objects.

TASK_A2G_DISPATCHER:EvaluateBAI(DetectedItem, FriendlyCoalition)

Creates a BAI task when there are targets for it.

TASK_A2G_DISPATCHER:EvaluateCAS(DetectedItem)

Creates a CAS task when there are targets for it.

TASK_A2G_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedItemID, DetectedItemChange, TaskIndex, DetectedItemChanged)

Evaluates the removal of the Task from the Mission.

TASK_A2G_DISPATCHER:EvaluateSEAD(DetectedItem)

Creates a SEAD task when there are targets for it.

TASK_A2G_DISPATCHER.Mission

TASK_A2G_DISPATCHER:New(Mission, SetGroup, Detection)

TASK_A2G_DISPATCHER constructor.

TASK_A2G_DISPATCHER:OnAfterAssign(From, Event, To, Task, TaskUnit, PlayerName)

OnAfter Transition Handler for Event Assign.

TASK_A2G_DISPATCHER:ProcessDetected(Detection)

Assigns tasks in relation to the detected items to the Core.Set#SET_GROUP.

TASK_A2G_DISPATCHER:RemoveTask(TaskIndex)

TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

Fields and Methods inherited from DETECTION_MANAGER Description

TASK_A2G_DISPATCHER.CC

The command center that is used to communicate with the players.

TASK_A2G_DISPATCHER.Detection

The DETECTION_BASE object that is used to report the detected objects.

TASK_A2G_DISPATCHER:GetCommandCenter()

Get the command center to communicate actions to the players.

TASK_A2G_DISPATCHER:GetReportDisplayTime()

Get the reporting message display time.

TASK_A2G_DISPATCHER:MessageToPlayers(Squadron, Message, SoundFile, SoundDuration, SoundPath, DefenderGroup)

Send an information message to the players reporting to the command center.

TASK_A2G_DISPATCHER:New(SetGroup, Detection)

FAC constructor.

TASK_A2G_DISPATCHER:OnAfterAborted(From, Event, To, Task)

Aborted Handler OnAfter for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnAfterCancelled(From, Event, To, Task)

Cancelled Handler OnAfter for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnAfterFailed(From, Event, To, Task)

Failed Handler OnAfter for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnAfterStart(From, Event, To)

Start Handler OnAfter for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnAfterStop(From, Event, To)

Stop Handler OnAfter for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnAfterSuccess(From, Event, To, Task)

Success Handler OnAfter for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnBeforeStart(From, Event, To)

Start Handler OnBefore for DETECTION_MANAGER

TASK_A2G_DISPATCHER:OnBeforeStop(From, Event, To)

Stop Handler OnBefore for DETECTION_MANAGER

TASK_A2G_DISPATCHER:ProcessDetected(Detection)

Reports the detected items to the Core.Set#SET_GROUP.

TASK_A2G_DISPATCHER:SetCommandCenter(CommandCenter)

Set a command center to communicate actions to the players reporting to the command center.

TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

TASK_A2G_DISPATCHER:SetRefreshTimeInterval(RefreshTimeInterval)

Set the reporting time interval.

TASK_A2G_DISPATCHER:SetReportDisplayTime(ReportDisplayTime)

Set the reporting message display time.

TASK_A2G_DISPATCHER:SetTacticalMenu(DispatcherMainMenuText, DispatcherMenuText)

Set a command center to communicate actions to the players reporting to the command center.

TASK_A2G_DISPATCHER:Start()

Start Trigger for DETECTION_MANAGER

TASK_A2G_DISPATCHER:Stop()

Stop Trigger for DETECTION_MANAGER

TASK_A2G_DISPATCHER._RefreshTimeInterval

TASK_A2G_DISPATCHER._ReportDisplayTime

TASK_A2G_DISPATCHER:__Start(Delay)

Start Asynchronous Trigger for DETECTION_MANAGER

TASK_A2G_DISPATCHER:__Stop(Delay)

Stop Asynchronous Trigger for DETECTION_MANAGER

TASK_A2G_DISPATCHER:onafterReport(From, Event, To)

TASK_A2G_DISPATCHER:onafterStart(From, Event, To)

Fields and Methods inherited from FSM Description

TASK_A2G_DISPATCHER:AddEndState(State)

Adds an End state.

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

TASK_A2G_DISPATCHER:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

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

Adds a score for the FSM_PROCESS to be achieved.

TASK_A2G_DISPATCHER:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

TASK_A2G_DISPATCHER.CallScheduler

TASK_A2G_DISPATCHER.Events

TASK_A2G_DISPATCHER:GetCurrentState()

TASK_A2G_DISPATCHER:GetEndStates()

Returns the End states.

TASK_A2G_DISPATCHER:GetProcess(From, Event)

TASK_A2G_DISPATCHER:GetProcesses()

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

TASK_A2G_DISPATCHER:GetScores()

Returns a table with the scores defined.

TASK_A2G_DISPATCHER:GetStartState()

Returns the start state of the FSM.

TASK_A2G_DISPATCHER:GetState()

TASK_A2G_DISPATCHER:GetSubs()

Returns a table with the Subs defined.

TASK_A2G_DISPATCHER:GetTransitions()

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

TASK_A2G_DISPATCHER:Is(State)

TASK_A2G_DISPATCHER:LoadCallBacks(CallBackTable)

TASK_A2G_DISPATCHER:New()

Creates a new FSM object.

TASK_A2G_DISPATCHER.Scores

TASK_A2G_DISPATCHER:SetProcess(From, Event, Fsm)

TASK_A2G_DISPATCHER:SetStartState(State)

Sets the start state of the FSM.

TASK_A2G_DISPATCHER._EndStates

TASK_A2G_DISPATCHER._EventSchedules

TASK_A2G_DISPATCHER._Processes

TASK_A2G_DISPATCHER._Scores

TASK_A2G_DISPATCHER._StartState

TASK_A2G_DISPATCHER._Transitions

TASK_A2G_DISPATCHER:_add_to_map(Map, Event)

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

TASK_A2G_DISPATCHER:_create_transition(EventName)

TASK_A2G_DISPATCHER:_delayed_transition(EventName)

TASK_A2G_DISPATCHER:_eventmap(Events, EventStructure)

TASK_A2G_DISPATCHER:_gosub(ParentFrom, ParentEvent)

TASK_A2G_DISPATCHER:_handler(EventName, ...)

TASK_A2G_DISPATCHER:_isendstate(Current)

TASK_A2G_DISPATCHER:_submap(subs, sub, name)

TASK_A2G_DISPATCHER:can(e)

TASK_A2G_DISPATCHER:cannot(e)

TASK_A2G_DISPATCHER.current

TASK_A2G_DISPATCHER.endstates

TASK_A2G_DISPATCHER:is(state)

TASK_A2G_DISPATCHER.options

TASK_A2G_DISPATCHER.subs

Fields and Methods inherited from BASE Description

TASK_A2G_DISPATCHER.ClassID

The ID number of the class.

TASK_A2G_DISPATCHER.ClassName

The name of the class.

TASK_A2G_DISPATCHER.ClassNameAndID

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

TASK_A2G_DISPATCHER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

TASK_A2G_DISPATCHER:CreateEventCrash(EventTime, Initiator)

Creation of a Crash Event.

TASK_A2G_DISPATCHER:CreateEventDead(EventTime, Initiator)

Creation of a Dead Event.

TASK_A2G_DISPATCHER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

TASK_A2G_DISPATCHER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

TASK_A2G_DISPATCHER:E(Arguments)

Log an exception which will be traced always.

TASK_A2G_DISPATCHER:EventDispatcher()

Returns the event dispatcher

TASK_A2G_DISPATCHER:EventRemoveAll()

Remove all subscribed events

TASK_A2G_DISPATCHER:F(Arguments)

Trace a function call.

TASK_A2G_DISPATCHER:F2(Arguments)

Trace a function call level 2.

TASK_A2G_DISPATCHER:F3(Arguments)

Trace a function call level 3.

TASK_A2G_DISPATCHER:GetClassID()

Get the ClassID of the class instance.

TASK_A2G_DISPATCHER:GetClassName()

Get the ClassName of the class instance.

TASK_A2G_DISPATCHER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

TASK_A2G_DISPATCHER:GetEventPriority()

Get the Class Event processing Priority.

TASK_A2G_DISPATCHER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

TASK_A2G_DISPATCHER:GetState(Object, Key)

Get a Value given a Key from the Object.

TASK_A2G_DISPATCHER:HandleEvent(Event, EventFunction)

Subscribe to a DCS Event.

TASK_A2G_DISPATCHER:I(Arguments)

Log an information which will be traced always.

TASK_A2G_DISPATCHER:Inherit(Child, Parent)

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

TASK_A2G_DISPATCHER:IsInstanceOf(ClassName)

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

TASK_A2G_DISPATCHER:IsTrace()

Enquires if tracing is on (for the class).

TASK_A2G_DISPATCHER:New()

BASE constructor.

TASK_A2G_DISPATCHER:OnEvent(EventData)

Occurs when an object is completely destroyed.

TASK_A2G_DISPATCHER:OnEventBaseCaptured(EventData)

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

TASK_A2G_DISPATCHER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

TASK_A2G_DISPATCHER:OnEventCrash(EventData)

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

TASK_A2G_DISPATCHER:OnEventDead(EventData)

Occurs when an object is dead.

TASK_A2G_DISPATCHER:OnEventDetailedFailure(EventData)

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

TASK_A2G_DISPATCHER:OnEventEjection(EventData)

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

TASK_A2G_DISPATCHER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

TASK_A2G_DISPATCHER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

TASK_A2G_DISPATCHER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

TASK_A2G_DISPATCHER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

TASK_A2G_DISPATCHER:OnEventKill(EventData)

Occurs on the death of a unit.

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

TASK_A2G_DISPATCHER:OnEventLandingAfterEjection(EventData)

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

TASK_A2G_DISPATCHER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

TASK_A2G_DISPATCHER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

TASK_A2G_DISPATCHER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

TASK_A2G_DISPATCHER:OnEventMissionEnd(EventData)

Occurs when a mission ends

TASK_A2G_DISPATCHER:OnEventMissionStart(EventData)

Occurs when a mission starts

TASK_A2G_DISPATCHER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

TASK_A2G_DISPATCHER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

TASK_A2G_DISPATCHER:OnEventPlayerLeaveUnit(EventData)

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

TASK_A2G_DISPATCHER:OnEventRefueling(EventData)

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

TASK_A2G_DISPATCHER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

TASK_A2G_DISPATCHER:OnEventScore(EventData)

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

TASK_A2G_DISPATCHER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

TASK_A2G_DISPATCHER:OnEventShootingStart(EventData)

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

TASK_A2G_DISPATCHER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

TASK_A2G_DISPATCHER:OnEventTakeoff(EventData)

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

TASK_A2G_DISPATCHER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

TASK_A2G_DISPATCHER:ScheduleStop(SchedulerFunction)

Stops the Schedule.

TASK_A2G_DISPATCHER.Scheduler

TASK_A2G_DISPATCHER:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

TASK_A2G_DISPATCHER:SetState(Object, Key, Value)

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

TASK_A2G_DISPATCHER:T(Arguments)

Trace a function logic level 1.

TASK_A2G_DISPATCHER:T2(Arguments)

Trace a function logic level 2.

TASK_A2G_DISPATCHER:T3(Arguments)

Trace a function logic level 3.

TASK_A2G_DISPATCHER:TraceAll(TraceAll)

Trace all methods in MOOSE

TASK_A2G_DISPATCHER:TraceClass(Class)

Set tracing for a class

TASK_A2G_DISPATCHER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

TASK_A2G_DISPATCHER:TraceLevel(Level)

Set trace level

TASK_A2G_DISPATCHER:TraceOff()

Set trace off.

TASK_A2G_DISPATCHER:TraceOn()

Set trace on.

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

TASK_A2G_DISPATCHER:UnHandleEvent(Event)

UnSubscribe to a DCS event.

TASK_A2G_DISPATCHER._

TASK_A2G_DISPATCHER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

TASK_A2G_DISPATCHER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

TASK_A2G_DISPATCHER.__

TASK_A2G_DISPATCHER:onEvent(event)

TASK_A2G_DISPATCHER class.

Field(s)

Functional.Detection#DETECTION_BASE TASK_A2G_DISPATCHER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

Function(s)

Creates a BAI task when there are targets for it.

Defined in:

TASK_A2G_DISPATCHER

Parameters:

FriendlyCoalition

Return values:

TargetSetUnit: The target set of units.

#nil:

If there are no targets to be set.

Creates a CAS task when there are targets for it.

Defined in:

TASK_A2G_DISPATCHER

Parameter:

Return values:

TargetSetUnit: The target set of units.

#nil:

If there are no targets to be set.

Evaluates the removal of the Task from the Mission.

Can only occur when the DetectedItem is Changed AND the state of the Task is "Planned".

Defined in:

TASK_A2G_DISPATCHER

Parameters:

#boolean DetectedItemID

#boolean DetectedItemChange

TaskIndex

DetectedItemChanged

Return value:

Creates a SEAD task when there are targets for it.

Defined in:

TASK_A2G_DISPATCHER

Parameter:

Return values:

TargetSetUnit: The target set of units.

#nil:

If there are no targets to be set.

TASK_A2G_DISPATCHER constructor.

Defined in:

TASK_A2G_DISPATCHER

Parameters:

The mission for which the task dispatching is done.

The set of groups that can join the tasks within the mission.

The detection results that are used to dynamically assign new tasks to human players.

Return value:

OnAfter Transition Handler for Event Assign.

Defined in:

TASK_A2G_DISPATCHER

Parameters:

#string From

The From State string.

#string Event

The Event string.

#string To

The To State string.

#string PlayerName

Assigns tasks in relation to the detected items to the Core.Set#SET_GROUP.

Defined in:

TASK_A2G_DISPATCHER

Parameter:

The detection created by the Functional.Detection#DETECTION_BASE derived object.

Return value:

#boolean:

Return true if you want the task assigning to continue... false will cancel the loop.

Defined in:

TASK_A2G_DISPATCHER

Parameter:

TaskIndex

Field(s)

Functional.Detection#DETECTION_BASE TASK_A2G_DISPATCHER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

Function(s)

Get the command center to communicate actions to the players.

Get the reporting message display time.

Defined in:

Return value:

#number:

ReportDisplayTime The display time in seconds when a report needs to be done.

Send an information message to the players reporting to the command center.

Defined in:

Parameters:

#table Squadron

The squadron table.

#string Message

The message to be sent.

#string SoundFile

The name of the sound file .wav or .ogg.

#number SoundDuration

The duration of the sound.

#string SoundPath

The path pointing to the folder in the mission file.

Wrapper.Group#GROUP DefenderGroup

The defender group sending the message.

Return value:

Aborted Handler OnAfter for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Cancelled Handler OnAfter for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Failed Handler OnAfter for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Start Handler OnAfter for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Stop Handler OnAfter for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Success Handler OnAfter for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Start Handler OnBefore for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Stop Handler OnBefore for DETECTION_MANAGER

Defined in:

Parameters:

#string From

#string Event

#string To

Return value:

#boolean:

Set a command center to communicate actions to the players reporting to the command center.

Defined in:

Parameter:

The command center.

Return value:

Set the reporting time interval.

Defined in:

Parameter:

#number RefreshTimeInterval

The interval in seconds when a report needs to be done.

Return value:

Set the reporting message display time.

Defined in:

Parameter:

#number ReportDisplayTime

The display time in seconds when a report needs to be done.

Return value:

Set a command center to communicate actions to the players reporting to the command center.

Defined in:

Parameters:

DispatcherMainMenuText

DispatcherMenuText

Return value:

Start Trigger for DETECTION_MANAGER

Stop Trigger for DETECTION_MANAGER

Start Asynchronous Trigger for DETECTION_MANAGER

Defined in:

Parameter:

#number Delay

Stop Asynchronous Trigger for DETECTION_MANAGER

Defined in:

Parameter:

#number Delay

Field(s)

Functional.Detection#DETECTION_BASE TASK_A2G_DISPATCHER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

Function(s)

Adds an End state.

Defined in:

Parameter:

State

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

An sub-process FSM.

#table ReturnEvents

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

Return value:

The SubFSM.

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

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

#string ScoreText

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

#number Score

is a number providing the score of the status.

Return value:

#FSM:

self

Add a new transition rule to the FSM.

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

Defined in:

Parameters:

#table From

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

#string Event

The Event name.

#string To

The To state.

Returns the End states.

Defined in:

Defined in:

Parameters:

From

Event

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

Defined in:

Return value:

#table:

Returns a table with the scores defined.

Defined in:

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

Returns a table with the Subs defined.

Defined in:

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

Defined in:

Return value:

#table:

Defined in:

Parameter:

State

Defined in:

Parameter:

CallBackTable

Creates a new FSM object.

Defined in:

Return value:

#FSM:

Defined in:

Parameters:

From

Event

Fsm

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

Defined in:

Parameters:

Map

Event

Defined in:

Parameters:

step

trigger

params

EventName

Defined in:

Parameters:

Events

EventStructure

Defined in:

Parameters:

ParentFrom

ParentEvent

Defined in:

Parameters:

EventName

...

Defined in:

Parameters:

subs

sub

name

Defined in:

Parameter:

e

Defined in:

Parameter:

e

Defined in:

Parameter:

state

Field(s)

Functional.Detection#DETECTION_BASE TASK_A2G_DISPATCHER.Detection

The DETECTION_BASE object that is used to report the detected objects.

Core.Set#SET_GROUP TASK_A2G_DISPATCHER.SetGroup

The groups to which the FAC will report to.

Function(s)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Returns the event dispatcher

Defined in:

Return value:

Remove all subscribed events

Defined in:

Return value:

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

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

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

Get the Class Event processing Priority.

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

Defined in:

Return value:

#number:

The Event processing Priority.

This is the worker method to retrieve the Parent class.

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

self:GetParent(self):ParentMethod()


Defined in:

Parameters:

#BASE Child

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

#BASE FromClass

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

Return value:

Get a Value given a Key from the Object.

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

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

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

Return value:

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

Subscribe to a DCS Event.

Defined in:

Parameters:

#function EventFunction

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

Return value:

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

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

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

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

Examples:

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

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

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

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

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

Defined in:

Parameter:

ClassName

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

Return value:

#boolean:

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

BASE constructor.

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

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

Defined in:

Return value:

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that has crashed

Defined in:

Parameter:

The EventData structure.

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

The EventData structure.

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

Will update this page when new information become available.

  • initiator: The unit that had the failure.

Defined in:

Parameter:

The EventData structure.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

The EventData structure.

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

The EventData structure.

Occurs whenever an object is hit by a weapon.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

The EventData structure.

Occurs on the death of a unit.

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

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

Defined in:

Parameter:

The EventData structure.

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

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

The EventData structure.

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

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

The EventData structure.

Occurs when a mission ends

Defined in:

Parameter:

The EventData structure.

Occurs when a mission starts

Defined in:

Parameter:

The EventData structure.

Occurs when the pilot of an aircraft is killed.

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

Defined in:

Parameter:

The EventData structure.

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that the player left.

Defined in:

Parameter:

The EventData structure.

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

The EventData structure.

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

The EventData structure.

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

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

Defined in:

Parameter:

The EventData structure.

Occurs when the game thinks an object is destroyed.

  • initiator: The unit that is was destroyed.

Defined in:

Parameter:

The EventData structure.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Schedule a new time event.

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

Defined in:

Parameters:

#number Start

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

#number Repeat

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

#number RandomizeFactor

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

#number Stop

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

#function SchedulerFunction

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

#table ...

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

Return value:

#number:

The ScheduleID of the planned schedule.

Stops the Schedule.

Defined in:

Parameter:

#function SchedulerFunction

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

Set the Class Event processing Priority.

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

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

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

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

Defined in:

Parameters:

Object

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

Key

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

Value

The value to is stored in the object.

Return value:

The Value set.

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

Set tracing for a class

Defined in:

Parameter:

#string Class

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

Set trace level

Defined in:

Parameter:

#number Level

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

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

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

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

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

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

UnSubscribe to a DCS event.

Defined in:

Parameter:

Return value:

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

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

Defined in:

Parameter:

event