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) Suppression 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 Functional.Detection object. |
Orchestrates dynamic A2G Task Dispatching based on the detection results of a linked Functional.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 Core.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 Wrapper.Clients of the Wrapper.Group Core.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 Core.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 Tasking.CommandCenter, which is orchestrating a Tasking.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 Tactical 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 % 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 Core.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:
- A Tasking.CommandCenter object. The master communication channel.
- A Tasking.Mission object. Each task belongs to a Mission.
- A Functional.Detection object. There are several detection grouping methods to choose from.
- A Tasking.Task_A2G_Dispatcher object. The master A2G task dispatcher.
- A Core.Set of Wrapper.Group objects that will detect the enemy, the RecceSet. This is attached to the Functional.Detection object.
- A Core.Set of Wrapper.Group objects that will attack the enemy, the AttackSet. This is attached to the Tasking.Task_A2G_Dispatcher object.
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 receive the dispatched Tasks. The DetectionAreas will report any detected enemies to the TaskDispatcher.
Developer Note
Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE Therefore, this class is considered to be deprecated
Type(s)
| Fields and Methods inherited from TASK_A2G_DISPATCHER | Description |
|---|---|
|
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. |
|
Creates a CAS task when there are targets for it. |
|
|
Evaluates the removal of the Task from the Mission. |
|
|
Creates a SEAD task when there are targets for it. |
|
|
TASK_A2G_DISPATCHER constructor. |
|
TASK_A2G_DISPATCHER:OnAfterAssign(From, Event, To, Task, TaskUnit, PlayerName) |
OnAfter Transition Handler for Event Assign. |
|
Assigns tasks in relation to the detected items to the Core.Set#SET_GROUP. |
|
|
The groups to which the FAC will report to. |
|
|
Set flashing player messages on or off |
| Fields and Methods inherited from DETECTION_MANAGER | Description |
|---|---|
|
The command center that is used to communicate with the players. |
|
|
The DETECTION_BASE object that is used to report the detected objects. |
|
|
Get the command center to communicate actions to the players. |
|
|
Get the reporting message display time. |
|
|
Send an information message to the players reporting to the command center. |
|
|
FAC constructor. |
|
|
Aborted Handler OnAfter for DETECTION_MANAGER |
|
|
Cancelled Handler OnAfter for DETECTION_MANAGER |
|
|
Failed Handler OnAfter for DETECTION_MANAGER |
|
|
Start Handler OnAfter for DETECTION_MANAGER |
|
|
Stop Handler OnAfter for DETECTION_MANAGER |
|
|
Success Handler OnAfter for DETECTION_MANAGER |
|
|
Start Handler OnBefore for DETECTION_MANAGER |
|
|
Stop Handler OnBefore for DETECTION_MANAGER |
|
|
Reports the detected items to the Core.Set#SET_GROUP. |
|
|
Set a command center to communicate actions to the players reporting to the command center. |
|
|
The groups to which the FAC will report to. |
|
TASK_A2G_DISPATCHER:SetRefreshTimeInterval(RefreshTimeInterval) |
Set the reporting time interval. |
|
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. |
|
Start Trigger for DETECTION_MANAGER |
|
|
Stop Trigger for DETECTION_MANAGER |
|
|
Start Asynchronous Trigger for DETECTION_MANAGER |
|
|
Stop Asynchronous Trigger for DETECTION_MANAGER |
|
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End state. |
|
TASK_A2G_DISPATCHER:AddProcess(From, Event, Process, ReturnEvents) |
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
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. |
|
Add a new transition rule to the FSM. |
|
|
Call scheduler. |
|
|
Name of the class. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Scores. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
TASK_A2G_DISPATCHER:_call_handler(step, trigger, params, EventName) |
Call handler. |
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Current state name. |
|
|
Check if FSM is in state. |
|
|
Options. |
|
|
Subs. |
| Fields and Methods inherited from BASE | Description |
|---|---|
|
The ID number of the class. |
|
|
The name of the class. |
|
|
The name of the class concatenated with the ID number of the class. |
|
|
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, IniObjectCategory) |
Creation of a Crash Event. |
TASK_A2G_DISPATCHER:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
TASK_A2G_DISPATCHER:CreateEventDynamicCargoLoaded(DynamicCargo) |
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event. |
TASK_A2G_DISPATCHER:CreateEventDynamicCargoRemoved(DynamicCargo) |
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event. |
TASK_A2G_DISPATCHER:CreateEventDynamicCargoUnloaded(DynamicCargo) |
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event. |
TASK_A2G_DISPATCHER:CreateEventNewDynamicCargo(DynamicCargo) |
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event. |
TASK_A2G_DISPATCHER:CreateEventPlayerEnterAircraft(PlayerUnit) |
Creation of a |
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:CreateEventUnitLost(EventTime, Initiator) |
Creation of a Crash Event. |
|
Log an exception which will be traced always. |
|
|
Returns the event dispatcher |
|
|
Remove all subscribed events |
|
|
Trace a function call. |
|
|
Trace a function call level 2. |
|
|
Trace a function call level 3. |
|
|
Get the ClassID of the class instance. |
|
|
Get the ClassName of the class instance. |
|
|
Get the ClassName + ClassID of the class instance. |
|
|
Get the Class Core.Event processing Priority. |
|
|
This is the worker method to retrieve the Parent class. |
|
|
Get a Value given a Key from the Object. |
|
|
Subscribe to a DCS Event. |
|
|
Log an information which will be traced always. |
|
|
This is the worker method to inherit from a parent class. |
|
|
This is the worker method to check if an object is an (sub)instance of a class. |
|
|
Enquires if tracing is on (for the class). |
|
|
BASE constructor. |
|
|
Occurs when an Event for an object is triggered. |
|
|
BDA. |
|
|
Occurs when a ground unit captures either an airbase or a farp. |
|
|
Occurs when any object is spawned into the mission. |
|
|
Occurs when any aircraft crashes into the ground and is completely destroyed. |
|
|
Occurs when an object is dead. |
|
|
Unknown precisely what creates this event, likely tied into newer damage model. |
|
TASK_A2G_DISPATCHER:OnEventDiscardChairAfterEjection(EventData) |
Discard chair after ejection. |
|
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo. |
|
|
Occurs when a dynamic cargo crate is removed. |
|
|
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when any aircraft shuts down its engines. |
|
|
Occurs when any aircraft starts its engines. |
|
|
Occurs whenever an object is hit by a weapon. |
|
|
Occurs when any system fails on a human controlled aircraft. |
|
|
Occurs on the death of a unit. |
|
|
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
Landing quality mark. |
|
|
Occurs when a new mark was added. |
|
|
Occurs when a mark text was changed. |
|
|
Occurs when a mark was removed. |
|
|
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu. |
|
|
Weapon add. |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
Occurs when a player enters a slot and takes control of an aircraft. |
|
|
Occurs when any player assumes direct control of a unit. |
|
|
Occurs when any player relieves control of a unit to the AI. |
|
|
Occurs when an aircraft connects with a tanker and begins taking on fuel. |
|
|
Occurs when an aircraft is finished taking fuel. |
|
|
Occurs when any modification to the "Score" as seen on the debrief menu would occur. |
|
|
Occurs when any unit stops firing its weapon. |
|
|
Occurs when any unit begins firing a weapon that has a high rate of fire. |
|
|
Occurs whenever any unit in a mission fires a weapon. |
|
|
Occurs when an aircraft takes off from an airbase, farp, or ship. |
|
|
Trigger zone. |
|
|
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. |
|
Stops the Schedule. |
|
|
Set the Class Core.Event processing Priority. |
|
|
Set a state or property of the Object given a Key and a Value. |
|
|
Trace a function logic level 1. |
|
|
Trace a function logic level 2. |
|
|
Trace a function logic level 3. |
|
|
Trace all methods in MOOSE |
|
|
Set tracing for a class |
|
|
Set tracing for a specific method of class |
|
|
Set trace level |
|
|
Set trace off. |
|
|
Set trace on. |
|
|
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. |
|
|
UnSubscribe to a DCS event. |
|
TASK_A2G_DISPATCHER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
TASK_A2G_DISPATCHER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
TASK_A2G_DISPATCHER class.
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Creates a BAI task when there are targets for it.
Defined in:
TASK_A2G_DISPATCHER
Parameters:
Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
FriendlyCoalition
Return values:
Creates a CAS task when there are targets for it.
Defined in:
TASK_A2G_DISPATCHER
Parameter:
Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
Return values:
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:
Tasking.Mission#MISSION Mission
Tasking.Task#TASK Task
#boolean DetectedItemID
#boolean DetectedItemChange
TaskIndex
DetectedItemChanged
Return value:
Creates a SEAD task when there are targets for it.
Defined in:
TASK_A2G_DISPATCHER
Parameter:
Functional.Detection#DETECTION_AREAS.DetectedItem DetectedItem
Return values:
TASK_A2G_DISPATCHER constructor.
Defined in:
TASK_A2G_DISPATCHER
Parameters:
Tasking.Mission#MISSION Mission
The mission for which the task dispatching is done.
Core.Set#SET_GROUP SetGroup
The set of groups that can join the tasks within the mission.
Functional.Detection#DETECTION_BASE Detection
The detection results that are used to dynamically assign new tasks to human players.
Return value:
self
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.
Wrapper.Unit#UNIT TaskUnit
#string PlayerName
Assigns tasks in relation to the detected items to the Core.Set#SET_GROUP.
Defined in:
TASK_A2G_DISPATCHER
Parameter:
Functional.Detection#DETECTION_BASE Detection
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
Set flashing player messages on or off
Defined in:
TASK_A2G_DISPATCHER
Parameter:
#boolean onoff
Set messages on (true) or off (false)
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Get the command center to communicate actions to the players.
Defined in:
Return value:
The command center.
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:
self
FAC constructor.
Defined in:
Parameters:
Core.Set#SET_GROUP SetGroup
Functional.Detection#DETECTION_BASE Detection
Return value:
self
Aborted Handler OnAfter for DETECTION_MANAGER
Cancelled Handler OnAfter for DETECTION_MANAGER
Failed Handler OnAfter for DETECTION_MANAGER
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
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:
Reports the detected items to the Core.Set#SET_GROUP.
Set a command center to communicate actions to the players reporting to the command center.
Defined in:
Parameter:
Tasking.CommandCenter#COMMANDCENTER CommandCenter
The command center.
Return value:
self
Set the reporting time interval.
Defined in:
Parameter:
#number RefreshTimeInterval
The interval in seconds when a report needs to be done.
Return value:
self
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:
self
Set a command center to communicate actions to the players reporting to the command center.
Defined in:
Parameters:
DispatcherMainMenuText
DispatcherMenuText
Return value:
self
Start Trigger for DETECTION_MANAGER
Defined in:
Stop Trigger for DETECTION_MANAGER
Defined in:
Start Asynchronous Trigger for DETECTION_MANAGER
Stop Asynchronous Trigger for DETECTION_MANAGER
Field(s)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Adds an End state.
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
Core.Fsm#FSM_PROCESS Process
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.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
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.
Sets the start state of the FSM.
Add to map.
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.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
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)
The DETECTION_BASE object that is used to report the detected objects.
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT 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.
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.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
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()
Get a Value given a Key from the Object.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS EventID
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.
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).
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
Occurs when an Event for an object is triggered.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.
Occurs when a ground unit captures either an airbase or a farp.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed
Occurs when an object is dead.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.
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.
Discard chair after ejection.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a dynamic cargo crate is removed.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure
Occurs on the death of a unit.
Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark text was changed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark was removed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.
Occurs when any modification to the "Score" as seen on the debrief menu would occur.
There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Occurs when the game thinks an object is destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that is was destroyed.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#string SchedulerID
(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
Set the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
Trace a function logic level 1.
Can be anywhere within the function logic.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
Set trace level
Set trace off.
Set trace on.
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.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
(Internal) Serialize arguments
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
The main event handling function...
This function captures all events generated for the class.