diff --git a/Moose Training/Documentation/AIBalancer.html b/Moose Training/Documentation/AIBalancer.html deleted file mode 100644 index 530e7a3be..000000000 --- a/Moose Training/Documentation/AIBalancer.html +++ /dev/null @@ -1,594 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module AIBalancer

- -

This module contains the AIBALANCER class.

- - - -
- -

1) AIBalancer#AIBALANCER class, extends Base#BASE

-

The AIBalancer#AIBALANCER class controls the dynamic spawning of AI GROUPS depending on a SETCLIENT. -There will be as many AI GROUPS spawned as there at CLIENTS in SETCLIENT not spawned. -The AIBalancer uses the PatrolZone#PATROLZONE class to make AI patrol an zone until the fuel treshold is reached.

- -

1.1) AIBALANCER construction method:

-

Create a new AIBALANCER object with the AIBALANCER.New method:

- - - -

1.2) AIBALANCER returns AI to Airbases:

-

You can configure to have the AI to return to:

- - - -

1.3) AIBALANCER allows AI to patrol specific zones:

-

Use AIBalancer#AIBALANCER.SetPatrolZone() to specify a zone where the AI needs to patrol.

- -
- -

API CHANGE HISTORY

- -

The underlying change log documents the API changes. Please read this carefully. The following notation is used:

- -
    -
  • Added parts are expressed in bold type face.
    • -
  • Removed parts are expressed in italic type face.
    • -
- -

Hereby the change log:

- -

2016-08-17: SPAWN:InitCleanUp( SpawnCleanUpInterval ) replaces SPAWN:CleanUp( SpawnCleanUpInterval )

- -
    -
  • Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
    • -
  • This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.
    • -
- -
- -

AUTHORS and CONTRIBUTIONS

- -

Contributions:

- -
    -

  • Dutch_Baron (James): Who you can search on the Eagle Dynamics Forums.
    - Working together with James has resulted in the creation of the AIBALANCER class.
    - James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)

    • -

  • SNAFU: - Had a couple of mails with the guys to validate, if the same concept in the GCI/CAP script could be reworked within MOOSE. - None of the script code has been used however within the new AIBALANCER moose class.

    • -
- -

Authors:

- -
    -
  • FlightControl: Framework Design & Programming
    • -
- - -

Global(s)

- - - - - -
AIBALANCER - -
-

Type AIBALANCER

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AIBALANCER.AIGroups - -
AIBALANCER.ClassName - -
AIBALANCER:GetPatrolZone() -

Get the PatrolZone object assigned by the AIBalancer object.

-
AIBALANCER:New(SetClient, SpawnAI) -

Creates a new AIBALANCER object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.

-
AIBALANCER.PatrolZone - -
AIBALANCER.PatrolZones - -
AIBALANCER.ReturnAirbaseSet - -
AIBALANCER:ReturnToHomeAirbase(ReturnTresholdRange) -

Returns the AI to the home Airbase#AIRBASE.

-
AIBALANCER:ReturnToNearestAirbases(ReturnTresholdRange, ReturnAirbaseSet) -

Returns the AI to the nearest friendly Airbase#AIRBASE.

-
AIBALANCER.ReturnTresholdRange - -
AIBALANCER.SetClient - -
AIBALANCER:SetPatrolZone(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) -

Let the AI patrol a Zone with a given Speed range and Altitude range.

-
AIBALANCER.SpawnAI - -
AIBALANCER.ToHomeAirbase - -
AIBALANCER.ToNearestAirbase - -
AIBALANCER:_ClientAliveMonitorScheduler() - -
- -

Global(s)

-
-
- - #AIBALANCER - -AIBALANCER - -
-
- - - -
-
-

Type AIBalancer

- -

Type AIBALANCER

- -

AIBALANCER class

- -

Field(s)

-
-
- - - -AIBALANCER.AIGroups - -
-
- - - -
-
-
-
- - #string - -AIBALANCER.ClassName - -
-
- - - -
-
-
-
- - -AIBALANCER:GetPatrolZone() - -
-
- -

Get the PatrolZone object assigned by the AIBalancer object.

- -

Return value

- -

PatrolZone#PATROLZONE: -PatrolZone The PatrolZone where the AI needs to patrol.

- -
-
-
-
- - -AIBALANCER:New(SetClient, SpawnAI) - -
-
- -

Creates a new AIBALANCER object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.

- -

Parameters

-
    -
  • - -

    SetClient : -A SET_CLIENT object that will contain the CLIENT objects to be monitored if they are alive or not (joined by a player).

    - -
    • -
  • - -

    SpawnAI : -A SPAWN object that will spawn the AI units required, balancing the SetClient.

    - -
    • -
-

Return value

- -

#AIBALANCER: -self

- -
-
-
-
- - PatrolZone#PATROLZONE - -AIBALANCER.PatrolZone - -
-
- - - -
-
-
-
- - - -AIBALANCER.PatrolZones - -
-
- - - -
-
-
-
- - Set#SET_AIRBASE - -AIBALANCER.ReturnAirbaseSet - -
-
- - - -
-
-
-
- - -AIBALANCER:ReturnToHomeAirbase(ReturnTresholdRange) - -
-
- -

Returns the AI to the home Airbase#AIRBASE.

- -

Parameter

- -
-
-
-
- - -AIBALANCER:ReturnToNearestAirbases(ReturnTresholdRange, ReturnAirbaseSet) - -
-
- -

Returns the AI to the nearest friendly Airbase#AIRBASE.

- -

Parameters

- -
-
-
-
- - DCSTypes#Distance - -AIBALANCER.ReturnTresholdRange - -
-
- - - -
-
-
-
- - Set#SET_CLIENT - -AIBALANCER.SetClient - -
-
- - - -
-
-
-
- - -AIBALANCER:SetPatrolZone(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Let the AI patrol a Zone with a given Speed range and Altitude range.

- -

Parameters

-
    -
  • - -

    PatrolZone#PATROLZONE PatrolZone : -The PatrolZone where the AI needs to patrol.

    - -
    • -
  • - -

    PatrolFloorAltitude :

    - -
    • -
  • - -

    PatrolCeilingAltitude :

    - -
    • -
  • - -

    PatrolMinSpeed :

    - -
    • -
  • - -

    PatrolMaxSpeed :

    - -
    • -
-

Return value

- -

PatrolZone#PATROLZONE: -self

- -
-
-
-
- - Spawn#SPAWN - -AIBALANCER.SpawnAI - -
-
- - - -
-
-
-
- - #boolean - -AIBALANCER.ToHomeAirbase - -
-
- - - -
-
-
-
- - #boolean - -AIBALANCER.ToNearestAirbase - -
-
- - - -
-
-
-
- - -AIBALANCER:_ClientAliveMonitorScheduler() - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/AI_PatrolZone.html b/Moose Training/Documentation/AI_PatrolZone.html deleted file mode 100644 index f42d1ae48..000000000 --- a/Moose Training/Documentation/AI_PatrolZone.html +++ /dev/null @@ -1,732 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module AI_PatrolZone

- -

This module contains the AI_PATROLZONE class.

- - - -
- -

1) #AI_PATROLZONE class, extends StateMachine#STATEMACHINE

-

The #AI_PATROLZONE class implements the core functions to patrol a Zone by an AIR Controllable. -The patrol algorithm works that for each airplane patrolling, upon arrival at the patrol zone, -a random point is selected as the route point within the 3D space, within the given boundary limits. -The airplane will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits. -Upon arrival at the random 3D point, a new 3D random point will be selected within the patrol zone using the given limits. -This cycle will continue until a fuel treshold has been reached by the airplane. -When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.

- -

1.1) AI_PATROLZONE constructor:

- - - -

1.2) AI_PATROLZONE state machine:

-

The AI_PATROLZONE is a state machine: it manages the different events and states of the AIControllable it is controlling.

- -

1.2.1) AI_PATROLZONE Events:

- -
    -
  • AI_PATROLZONE.Route( AIControllable ): A new 3D route point is selected and the AIControllable will fly towards that point with the given speed.
    • -
  • AI_PATROLZONE.Patrol( AIControllable ): The AIControllable reports it is patrolling. This event is called every 30 seconds.
    • -
  • AI_PATROLZONE.RTB( AIControllable ): The AIControllable will report return to base.
    • -
  • AI_PATROLZONE.End( AIControllable ): The end of the AI_PATROLZONE process.
    • -
  • AI_PATROLZONE.Dead( AIControllable ): The AIControllable is dead. The AI_PATROLZONE process will be ended.
    • -
- -

1.2.2) AI_PATROLZONE States:

- -
    -
  • Route: A new 3D route point is selected and the AIControllable will fly towards that point with the given speed.
    • -
  • Patrol: The AIControllable is patrolling. This state is set every 30 seconds, so every 30 seconds, a state transition function can be used.
    • -
  • RTB: The AIControllable reports it wants to return to the base.
    • -
  • Dead: The AIControllable is dead ...
    • -
  • End: The process has come to an end.
    • -
- -

1.2.3) AI_PATROLZONE state transition functions:

- -

State transition functions can be set by the mission designer customizing or improving the behaviour of the state. -There are 2 moments when state transition functions will be called by the state machine:

- -
    -

  • Before the state transition. - The state transition function needs to start with the name OnBefore + the name of the state. - If the state transition function returns false, then the processing of the state transition will not be done! - If you want to change the behaviour of the AIControllable at this event, return false, - but then you'll need to specify your own logic using the AIControllable!

    • -

  • After the state transition. - The state transition function needs to start with the name OnAfter + the name of the state. - These state transition functions need to provide a return value, which is specified at the function description.

    • -
- -

An example how to manage a state transition for an AI_PATROLZONE object Patrol for the state RTB:

- -
 local PatrolZoneGroup = GROUP:FindByName( "Patrol Zone" )
- local PatrolZone = ZONE_POLYGON:New( "PatrolZone", PatrolZoneGroup )
-
- local PatrolSpawn = SPAWN:New( "Patrol Group" )
- local PatrolGroup = PatrolSpawn:Spawn()
-
- local Patrol = AI_PATROLZONE:New( PatrolZone, 3000, 6000, 300, 600 )
- Patrol:SetControllable( PatrolGroup )
- Patrol:ManageFuel( 0.2, 60 )
-
- -

OnBeforeRTB( AIGroup ) will be called by the AI_PATROLZONE object when the AIGroup reports RTB, but before the RTB default action is processed by the AI_PATROLZONE object.

- -
 --- State transition function for the AI\_PATROLZONE **Patrol** object
- -- @param #AI_PATROLZONE self 
- -- @param Controllable#CONTROLLABLE AIGroup
- -- @return #boolean If false is returned, then the OnAfter state transition function will not be called.
- function Patrol:OnBeforeRTB( AIGroup )
-   AIGroup:MessageToRed( "Returning to base", 20 )
- end
-
- -

OnAfterRTB( AIGroup ) will be called by the AI_PATROLZONE object when the AIGroup reports RTB, but after the RTB default action was processed by the AI_PATROLZONE object.

- -
 --- State transition function for the AI\_PATROLZONE **Patrol** object
- -- @param #AI_PATROLZONE self 
- -- @param Controllable#CONTROLLABLE AIGroup
- -- @return #Controllable#CONTROLLABLE The new AIGroup object that is set to be patrolling the zone.
- function Patrol:OnAfterRTB( AIGroup )
-   return PatrolSpawn:Spawn()
- end 
-
- -

1.3) Manage the AI_PATROLZONE parameters:

-

The following methods are available to modify the parameters of a AI_PATROLZONE object:

- - - -

1.3) Manage the out of fuel in the AI_PATROLZONE:

-

When the AIControllable is out of fuel, it is required that a new AIControllable is started, before the old AIControllable can return to the home base. -Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the AIControllable will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROLZONE. -Once the time is finished, the old AIControllable will return to the base. -Use the method AI_PATROLZONE.ManageFuel() to have this proces in place.

- -
- -

API CHANGE HISTORY

- -

The underlying change log documents the API changes. Please read this carefully. The following notation is used:

- -
    -
  • Added parts are expressed in bold type face.
    • -
  • Removed parts are expressed in italic type face.
    • -
- -

Hereby the change log:

- -

2016-08-17: AI_PATROLZONE:New( PatrolSpawn, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed ) replaces AI_PATROLZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed )

- -

2016-07-01: Initial class and API.

- -
- -

AUTHORS and CONTRIBUTIONS

- -

Contributions:

- -
    -
  • DutchBaron: Testing.
    • -
  • Pikey: Testing and API concept review.
    • -
- -

Authors:

- -
    -
  • FlightControl: Design & Programming.
    • -
- - - -

Global(s)

- - - - - - - - - -
AI_PATROLZONE - -
_NewPatrolRoute(AIControllable) - -
-

Type AI_PATROLZONE

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AI_PATROLZONE.AIControllable -

The Controllable patrolling.

-
AI_PATROLZONE.ClassName - -
AI_PATROLZONE:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) -

When the AIControllable is out of fuel, it is required that a new AIControllable is started, before the old AIControllable can return to the home base.

-
AI_PATROLZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) -

Creates a new AI_PATROLZONE object

-
AI_PATROLZONE.PatrolCeilingAltitude -

The highest altitude in meters where to execute the patrol.

-
AI_PATROLZONE.PatrolFloorAltitude -

The lowest altitude in meters where to execute the patrol.

-
AI_PATROLZONE.PatrolFuelTresholdPercentage - -
AI_PATROLZONE.PatrolManageFuel - -
AI_PATROLZONE.PatrolMaxSpeed -

The maximum speed of the Controllable in km/h.

-
AI_PATROLZONE.PatrolMinSpeed -

The minimum speed of the Controllable in km/h.

-
AI_PATROLZONE.PatrolOutOfFuelOrbitTime - -
AI_PATROLZONE.PatrolZone -

The Zone where the patrol needs to be executed.

-
AI_PATROLZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) -

Sets the floor and ceiling altitude of the patrol.

-
AI_PATROLZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed) -

Sets (modifies) the minimum and maximum speed of the patrol.

-
AI_PATROLZONE:onenterPatrol() - -
AI_PATROLZONE:onenterRoute() -

Defines a new patrol route using the AI_PatrolZone parameters and settings.

-
- -

Global(s)

-
-
- - #AI_PATROLZONE - -AI_PATROLZONE - -
-
- - - -
-
-
-
- - -_NewPatrolRoute(AIControllable) - -
-
- - - -

Parameter

- -
-
-

Type AI_PatrolZone

- -

Type AI_PATROLZONE

- -

AI_PATROLZONE class

- -

Field(s)

-
-
- - Controllable#CONTROLLABLE - -AI_PATROLZONE.AIControllable - -
-
- -

The Controllable patrolling.

- -
-
-
-
- - #string - -AI_PATROLZONE.ClassName - -
-
- - - -
-
-
-
- - -AI_PATROLZONE:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) - -
-
- -

When the AIControllable is out of fuel, it is required that a new AIControllable is started, before the old AIControllable can return to the home base.

- - -

Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the AIControllable will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROLZONE. -Once the time is finished, the old AIControllable will return to the base.

- -

Parameters

-
    -
  • - -

    #number PatrolFuelTresholdPercentage : -The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.

    - -
    • -
  • - -

    #number PatrolOutOfFuelOrbitTime : -The amount of seconds the out of fuel AIControllable will orbit before returning to the base.

    - -
    • -
-

Return value

- -

#AI_PATROLZONE: -self

- -
-
-
-
- - -AI_PATROLZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Creates a new AI_PATROLZONE object

- -

Parameters

- -

Return value

- -

#AI_PATROLZONE: -self

- -

Usage:

- 
-- Define a new AI_PATROLZONE Object. This PatrolArea will patrol an AIControllable within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
-PatrolZone = ZONE:New( 'PatrolZone' )
-PatrolSpawn = SPAWN:New( 'Patrol Group' )
-PatrolArea = AI_PATROLZONE:New( PatrolZone, 3000, 6000, 600, 900 )
- -
-
-
-
- - DCSTypes#Altitude - -AI_PATROLZONE.PatrolCeilingAltitude - -
-
- -

The highest altitude in meters where to execute the patrol.

- -
-
-
-
- - DCSTypes#Altitude - -AI_PATROLZONE.PatrolFloorAltitude - -
-
- -

The lowest altitude in meters where to execute the patrol.

- -
-
-
-
- - - -AI_PATROLZONE.PatrolFuelTresholdPercentage - -
-
- - - -
-
-
-
- - #boolean - -AI_PATROLZONE.PatrolManageFuel - -
-
- - - -
-
-
-
- - DCSTypes#Speed - -AI_PATROLZONE.PatrolMaxSpeed - -
-
- -

The maximum speed of the Controllable in km/h.

- -
-
-
-
- - DCSTypes#Speed - -AI_PATROLZONE.PatrolMinSpeed - -
-
- -

The minimum speed of the Controllable in km/h.

- -
-
-
-
- - - -AI_PATROLZONE.PatrolOutOfFuelOrbitTime - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -AI_PATROLZONE.PatrolZone - -
-
- -

The Zone where the patrol needs to be executed.

- -
-
-
-
- - -AI_PATROLZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) - -
-
- -

Sets the floor and ceiling altitude of the patrol.

- -

Parameters

-
    -
  • - -

    DCSTypes#Altitude PatrolFloorAltitude : -The lowest altitude in meters where to execute the patrol.

    - -
    • -
  • - -

    DCSTypes#Altitude PatrolCeilingAltitude : -The highest altitude in meters where to execute the patrol.

    - -
    • -
-

Return value

- -

#AI_PATROLZONE: -self

- -
-
-
-
- - -AI_PATROLZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Sets (modifies) the minimum and maximum speed of the patrol.

- -

Parameters

- -

Return value

- -

#AI_PATROLZONE: -self

- -
-
-
-
- - -AI_PATROLZONE:onenterPatrol() - -
-
- - - -
-
-
-
- - -AI_PATROLZONE:onenterRoute() - -
-
- -

Defines a new patrol route using the AI_PatrolZone parameters and settings.

- -

Return value

- -

#AI_PATROLZONE: -self

- -
-
- -
- -
- - diff --git a/Moose Training/Documentation/DetectionManager.html b/Moose Training/Documentation/DetectionManager.html deleted file mode 100644 index 068bd6e39..000000000 --- a/Moose Training/Documentation/DetectionManager.html +++ /dev/null @@ -1,1113 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module DetectionManager

- -

This module contains the DETECTION_MANAGER class and derived classes.

- - - -
- -

1) DetectionManager#DETECTION_MANAGER class, extends Base#BASE

-

The DetectionManager#DETECTION_MANAGER class defines the core functions to report detected objects to groups. -Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour.

- -

1.1) DETECTION_MANAGER constructor:

-

* DetectionManager#DETECTION_MANAGER.New(): Create a new DETECTION_MANAGER instance.

- -

1.2) DETECTION_MANAGER reporting:

-

Derived DETECTION_MANAGER classes will reports detected units using the method DetectionManager#DETECTION_MANAGER.ReportDetected(). This method implements polymorphic behaviour.

- -

The time interval in seconds of the reporting can be changed using the methods DetectionManager#DETECTION_MANAGER.SetReportInterval(). -To control how long a reporting message is displayed, use DetectionManager#DETECTION_MANAGER.SetReportDisplayTime(). -Derived classes need to implement the method DetectionManager#DETECTION_MANAGER.GetReportDisplayTime() to use the correct display time for displayed messages during a report.

- -

Reporting can be started and stopped using the methods DetectionManager#DETECTION_MANAGER.StartReporting() and DetectionManager#DETECTION_MANAGER.StopReporting() respectively. -If an ad-hoc report is requested, use the method DetectionManager#DETECTION_MANAGER().

- -

The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds.

- -
- -

2) DetectionManager#DETECTION_REPORTING class, extends DetectionManager#DETECTION_MANAGER

-

The DetectionManager#DETECTION_REPORTING class implements detected units reporting. Reporting can be controlled using the reporting methods available in the DetectionManager#DETECTION_MANAGER class.

- -

2.1) DETECTION_REPORTING constructor:

-

The DetectionManager#DETECTION_REPORTING.New() method creates a new DETECTION_REPORTING instance.

- -
- -

3) #DETECTION_DISPATCHER class, extends #DETECTION_MANAGER

-

The #DETECTION_DISPATCHER class implements the dynamic dispatching of tasks upon groups of detected units determined a Set of FAC (groups). -The FAC will detect units, will group them, and will dispatch Tasks to groups. Depending on the type of target detected, different tasks will be dispatched. -Find a summary below describing for which situation a task type is created:

- -
    -
  • CAS Task: Is created when there are enemy ground units within range of the FAC, while there are friendly units in the FAC perimeter.
    • -
  • BAI Task: Is created when there are enemy ground units within range of the FAC, while there are NO other friendly units within the FAC perimeter.
    • -
  • SEAD Task: Is created when there are enemy ground units wihtin range of the FAC, with air search radars.
    • -
- -

Other task types will follow...

- -

3.1) DETECTION_DISPATCHER constructor:

-

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

- -
- -

Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing

-

Author: FlightControl - Framework Design & Programming

- - -

Global(s)

- - - - - - - - - - - - - -
DETECTION_DISPATCHER - -
DETECTION_MANAGER - -
DETECTION_REPORTING - -
-

Type DETECTION_DISPATCHER

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DETECTION_DISPATCHER.ClassName - -
DETECTION_DISPATCHER.CommandCenter - -
DETECTION_DISPATCHER.Detection -

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

-
DETECTION_DISPATCHER:EvaluateBAI(DetectedArea, FriendlyCoalition) -

Creates a BAI task when there are targets for it.

-
DETECTION_DISPATCHER:EvaluateCAS(DetectedArea) -

Creates a CAS task when there are targets for it.

-
DETECTION_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedArea) -

Evaluates the removal of the Task from the Mission.

-
DETECTION_DISPATCHER:EvaluateSEAD(DetectedArea) -

Creates a SEAD task when there are targets for it.

-
DETECTION_DISPATCHER.Mission - -
DETECTION_DISPATCHER:New(SetGroup, Detection, Mission, CommandCenter) -

DETECTION_DISPATCHER constructor.

-
DETECTION_DISPATCHER:ProcessDetected(Detection) -

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

-
DETECTION_DISPATCHER.SetGroup -

The groups to which the FAC will report to.

-
- -

Type DETECTION_MANAGER

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DETECTION_MANAGER.ClassName - -
DETECTION_MANAGER.Detection -

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

-
DETECTION_MANAGER.FacScheduler - -
DETECTION_MANAGER:GetReportDisplayTime() -

Get the reporting message display time.

-
DETECTION_MANAGER:New(SetGroup, Detection) -

FAC constructor.

-
DETECTION_MANAGER:ReportDetected(Detection) -

Reports the detected items to the Set#SET_GROUP.

-
DETECTION_MANAGER:Schedule(DelayTime, ReportInterval) -

Schedule the FAC reporting.

-
DETECTION_MANAGER.SetGroup -

The groups to which the FAC will report to.

-
DETECTION_MANAGER:SetReportDisplayTime(ReportDisplayTime) -

Set the reporting message display time.

-
DETECTION_MANAGER:SetReportInterval(ReportInterval) -

Set the reporting time interval.

-
DETECTION_MANAGER:_FacScheduler(SchedulerName) -

Report the detected Unit#UNITs detected within the Detection#DETECTION_BASE object to the Set#SET_GROUPs.

-
DETECTION_MANAGER._ReportDisplayTime - -
DETECTION_MANAGER._ReportInterval - -
DETECTION_MANAGER._ScheduleDelayTime - -
- -

Type DETECTION_REPORTING

- - - - - - - - - - - - - - - - - - - - - - - - - -
DETECTION_REPORTING.ClassName - -
DETECTION_REPORTING.Detection -

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

-
DETECTION_REPORTING:GetDetectedItemsText(DetectedSet) -

Creates a string of the detected items in a Detection.

-
DETECTION_REPORTING:New(SetGroup, Detection) -

DETECTION_REPORTING constructor.

-
DETECTION_REPORTING:ProcessDetected(Group, Detection) -

Reports the detected items to the Set#SET_GROUP.

-
DETECTION_REPORTING.SetGroup -

The groups to which the FAC will report to.

-
- -

Global(s)

-
-
- - #DETECTION_DISPATCHER - -DETECTION_DISPATCHER - -
-
- - - -
-
-
-
- - #DETECTION_MANAGER - -DETECTION_MANAGER - -
-
- - - -
-
-
-
- - #DETECTION_REPORTING - -DETECTION_REPORTING - -
-
- - - -
-
-

Type DetectionManager

- -

Type DETECTION_DISPATCHER

- -

DETECTION_DISPATCHER class.

- -

Field(s)

-
-
- - #string - -DETECTION_DISPATCHER.ClassName - -
-
- - - -
-
-
-
- - Group#GROUP - -DETECTION_DISPATCHER.CommandCenter - -
-
- - - -
-
-
-
- - Detection#DETECTION_BASE - -DETECTION_DISPATCHER.Detection - -
-
- -

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

- -
-
-
-
- - -DETECTION_DISPATCHER:EvaluateBAI(DetectedArea, FriendlyCoalition) - -
-
- -

Creates a BAI task when there are targets for it.

- -

Parameters

- -

Return value

- -

Task#TASK_BASE:

- - -
-
-
-
- - -DETECTION_DISPATCHER:EvaluateCAS(DetectedArea) - -
-
- -

Creates a CAS task when there are targets for it.

- -

Parameter

- -

Return value

- -

Task#TASK_BASE:

- - -
-
-
-
- - -DETECTION_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedArea) - -
-
- -

Evaluates the removal of the Task from the Mission.

- - -

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

- -

Parameters

- -

Return value

- -

Task#TASK_BASE:

- - -
-
-
-
- - -DETECTION_DISPATCHER:EvaluateSEAD(DetectedArea) - -
-
- -

Creates a SEAD task when there are targets for it.

- -

Parameter

- -

Return values

-
    -
  1. - -

    Set#SET_UNIT: -TargetSetUnit: The target set of units.

    - -
    2. -
  2. - -

    #nil: -If there are no targets to be set.

    - -
    3. -
-
-
-
-
- - Mission#MISSION - -DETECTION_DISPATCHER.Mission - -
-
- - - -
-
-
-
- - -DETECTION_DISPATCHER:New(SetGroup, Detection, Mission, CommandCenter) - -
-
- -

DETECTION_DISPATCHER constructor.

- -

Parameters

- -

Return value

- -

#DETECTION_DISPATCHER: -self

- -
-
-
-
- - -DETECTION_DISPATCHER:ProcessDetected(Detection) - -
-
- -

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

- -

Parameter

- -

Return value

- -

#boolean: -Return true if you want the task assigning to continue... false will cancel the loop.

- -
-
-
-
- - Set#SET_GROUP - -DETECTION_DISPATCHER.SetGroup - -
-
- -

The groups to which the FAC will report to.

- -
-
- -

Type DETECTION_MANAGER

- -

DETECTION_MANAGER class.

- -

Field(s)

-
-
- - #string - -DETECTION_MANAGER.ClassName - -
-
- - - -
-
-
-
- - Detection#DETECTION_BASE - -DETECTION_MANAGER.Detection - -
-
- -

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

- -
-
-
-
- - - -DETECTION_MANAGER.FacScheduler - -
-
- - - -
-
-
-
- - -DETECTION_MANAGER:GetReportDisplayTime() - -
-
- -

Get the reporting message display time.

- -

Return value

- -

#number: -ReportDisplayTime The display time in seconds when a report needs to be done.

- -
-
-
-
- - -DETECTION_MANAGER:New(SetGroup, Detection) - -
-
- -

FAC constructor.

- -

Parameters

- -

Return value

- -

#DETECTION_MANAGER: -self

- -
-
-
-
- - -DETECTION_MANAGER:ReportDetected(Detection) - -
-
- -

Reports the detected items to the Set#SET_GROUP.

- -

Parameter

- -

Return value

- -

#DETECTION_MANAGER: -self

- -
-
-
-
- - -DETECTION_MANAGER:Schedule(DelayTime, ReportInterval) - -
-
- -

Schedule the FAC reporting.

- -

Parameters

-
    -
  • - -

    #number DelayTime : -The delay in seconds to wait the reporting.

    - -
    • -
  • - -

    #number ReportInterval : -The repeat interval in seconds for the reporting to happen repeatedly.

    - -
    • -
-

Return value

- -

#DETECTION_MANAGER: -self

- -
-
-
-
- - Set#SET_GROUP - -DETECTION_MANAGER.SetGroup - -
-
- -

The groups to which the FAC will report to.

- -
-
-
-
- - -DETECTION_MANAGER:SetReportDisplayTime(ReportDisplayTime) - -
-
- -

Set the reporting message display time.

- -

Parameter

-
    -
  • - -

    #number ReportDisplayTime : -The display time in seconds when a report needs to be done.

    - -
    • -
-

Return value

- -

#DETECTION_MANAGER: -self

- -
-
-
-
- - -DETECTION_MANAGER:SetReportInterval(ReportInterval) - -
-
- -

Set the reporting time interval.

- -

Parameter

-
    -
  • - -

    #number ReportInterval : -The interval in seconds when a report needs to be done.

    - -
    • -
-

Return value

- -

#DETECTION_MANAGER: -self

- -
-
-
-
- - -DETECTION_MANAGER:_FacScheduler(SchedulerName) - -
-
- -

Report the detected Unit#UNITs detected within the Detection#DETECTION_BASE object to the Set#SET_GROUPs.

- -

Parameter

-
    -
  • - -

    SchedulerName :

    - -
    • -
-
-
-
-
- - - -DETECTION_MANAGER._ReportDisplayTime - -
-
- - - -
-
-
-
- - - -DETECTION_MANAGER._ReportInterval - -
-
- - - -
-
-
-
- - - -DETECTION_MANAGER._ScheduleDelayTime - -
-
- - - -
-
- -

Type DETECTION_REPORTING

- -

DETECTION_REPORTING class.

- -

Field(s)

-
-
- - #string - -DETECTION_REPORTING.ClassName - -
-
- - - -
-
-
-
- - Detection#DETECTION_BASE - -DETECTION_REPORTING.Detection - -
-
- -

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

- -
-
-
-
- - -DETECTION_REPORTING:GetDetectedItemsText(DetectedSet) - -
-
- -

Creates a string of the detected items in a Detection.

- -

Parameter

- -

Return value

- -

#DETECTION_MANAGER: -self

- -
-
-
-
- - -DETECTION_REPORTING:New(SetGroup, Detection) - -
-
- -

DETECTION_REPORTING constructor.

- -

Parameters

- -

Return value

- -

#DETECTION_REPORTING: -self

- -
-
-
-
- - -DETECTION_REPORTING:ProcessDetected(Group, Detection) - -
-
- -

Reports the detected items to the Set#SET_GROUP.

- -

Parameters

- -

Return value

- -

#boolean: -Return true if you want the reporting to continue... false will cancel the reporting loop.

- -
-
-
-
- - Set#SET_GROUP - -DETECTION_REPORTING.SetGroup - -
-
- -

The groups to which the FAC will report to.

- -
-
- -
- -
- - diff --git a/Moose Training/Documentation/PatrolZone.html b/Moose Training/Documentation/PatrolZone.html deleted file mode 100644 index 1b45eec4b..000000000 --- a/Moose Training/Documentation/PatrolZone.html +++ /dev/null @@ -1,717 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module PatrolZone

- -

This module contains the PATROLZONE class.

- - - -
- -

1) #PATROLZONE class, extends Base#BASE

-

The #PATROLZONE class implements the core functions to patrol a Zone by air units. -The PATROLZONE class will guide the airplanes towards the patrolzone. -The patrol algorithm works that for each airplane patrolling, upon arrival at the patrol zone, -a random point is selected as the route point within the 3D space, within the given boundary limits. -The airplane will fly towards the random point using a randomly selected speed within given boundary limits. -Upon arrival at the random point, a new random point will be selected within the patrol zone within boundary limits. -This cycle will continue until a fuel treshold has been reached by the airplane. -When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.

- -

1.1) PATROLZONE constructor:

-

PATROLZONE.New(): Creates a new PATROLZONE object.

- -

1.2) Modify the PATROLZONE parameters:

-

The following methods are available to modify the parameters of a PATROLZONE object:

- - - -

1.3) Manage the out of fuel in the PATROLZONE:

-

When the PatrolGroup is out of fuel, it is required that a new PatrolGroup is started, before the old PatrolGroup can return to the home base. -Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the PatrolGroup will continue for a given time its patrol task in orbit, while a new PatrolGroup is targetted to the PATROLZONE. -Once the time is finished, the old PatrolGroup will return to the base. -Use the method PATROLZONE.ManageFuel() to have this proces in place.

- -
- -

API CHANGE HISTORY

- -

The underlying change log documents the API changes. Please read this carefully. The following notation is used:

- -
    -
  • Added parts are expressed in bold type face.
    • -
  • Removed parts are expressed in italic type face.
    • -
- -

Hereby the change log:

- -

2016-08-17: PATROLZONE:New( PatrolSpawn, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed ) replaces PATROLZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed )

- -

2016-07-01: Initial class and API.

- -
- -

AUTHORS and CONTRIBUTIONS

- -

Contributions:

- -
    -
  • DutchBaron: Testing.
    • -
- -

Authors:

- -
    -
  • FlightControl: Design & Programming
    • -
- - - -

Global(s)

- - - - - - - - - -
PATROLZONE - -
_NewPatrolRoute(PatrolGroup) - -
-

Type PATROLZONE

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PATROLZONE.ClassName - -
PATROLZONE:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) -

When the PatrolGroup is out of fuel, it is required that a new PatrolGroup is started, before the old PatrolGroup can return to the home base.

-
PATROLZONE:New(PatrolSpawn, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) -

Creates a new PATROLZONE object, taking a Group object as a parameter.

-
PATROLZONE:NewPatrolRoute() -

Defines a new patrol route using the PatrolZone parameters and settings.

-
PATROLZONE.PatrolCeilingAltitude -

The highest altitude in meters where to execute the patrol.

-
PATROLZONE.PatrolFloorAltitude -

The lowest altitude in meters where to execute the patrol.

-
PATROLZONE.PatrolFuelTresholdPercentage - -
PATROLZONE.PatrolGroup -

The Group patrolling.

-
PATROLZONE.PatrolGroupTemplateName - -
PATROLZONE.PatrolManageFuel - -
PATROLZONE.PatrolMaxSpeed -

The maximum speed of the Group in km/h.

-
PATROLZONE.PatrolMinSpeed -

The minimum speed of the Group in km/h.

-
PATROLZONE.PatrolOutOfFuelMonitor - -
PATROLZONE.PatrolOutOfFuelOrbitTime - -
PATROLZONE.PatrolZone -

The Zone where the patrol needs to be executed.

-
PATROLZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) -

Sets the floor and ceiling altitude of the patrol.

-
PATROLZONE:SetGroup(PatrolGroup) -

Set the Group to act as the Patroller.

-
PATROLZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed) -

Sets (modifies) the minimum and maximum speed of the patrol.

-
- -

Global(s)

-
-
- - #PATROLZONE - -PATROLZONE - -
-
- - - -
-
-
-
- - -_NewPatrolRoute(PatrolGroup) - -
-
- - - -

Parameter

- -
-
-

Type PatrolZone

- -

Type PATROLZONE

- -

PATROLZONE class

- -

Field(s)

-
-
- - #string - -PATROLZONE.ClassName - -
-
- - - -
-
-
-
- - -PATROLZONE:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) - -
-
- -

When the PatrolGroup is out of fuel, it is required that a new PatrolGroup is started, before the old PatrolGroup can return to the home base.

- - -

Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the PatrolGroup will continue for a given time its patrol task in orbit, while a new PatrolGroup is targetted to the PATROLZONE. -Once the time is finished, the old PatrolGroup will return to the base.

- -

Parameters

-
    -
  • - -

    #number PatrolFuelTresholdPercentage : -The treshold in percentage (between 0 and 1) when the PatrolGroup is considered to get out of fuel.

    - -
    • -
  • - -

    #number PatrolOutOfFuelOrbitTime : -The amount of seconds the out of fuel PatrolGroup will orbit before returning to the base.

    - -
    • -
-

Return value

- -

#PATROLZONE: -self

- -
-
-
-
- - -PATROLZONE:New(PatrolSpawn, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Creates a new PATROLZONE object, taking a Group object as a parameter.

- - -

The GROUP needs to be alive.

- -

Parameters

-
    -
  • - -

    Spawn#SPAWN PatrolSpawn : -The SPAWN object to spawn new group objects when required due to the fuel treshold.

    - -
    • -
  • - -

    Zone#ZONE_BASE PatrolZone : -The Zone where the patrol needs to be executed.

    - -
    • -
  • - -

    DCSTypes#Altitude PatrolFloorAltitude : -The lowest altitude in meters where to execute the patrol.

    - -
    • -
  • - -

    DCSTypes#Altitude PatrolCeilingAltitude : -The highest altitude in meters where to execute the patrol.

    - -
    • -
  • - -

    DCSTypes#Speed PatrolMinSpeed : -The minimum speed of the Group in km/h.

    - -
    • -
  • - -

    DCSTypes#Speed PatrolMaxSpeed : -The maximum speed of the Group in km/h.

    - -
    • -
-

Return value

- -

#PATROLZONE: -self

- -

Usage:

- 
-- Define a new PATROLZONE Object. This PatrolArea will patrol a group within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
-PatrolZone = ZONE:New( 'PatrolZone' )
-PatrolSpawn = SPAWN:New( "Patrol Group" )
-PatrolArea = PATROLZONE:New( PatrolSpawn, PatrolZone, 3000, 6000, 600, 900 )
- -
-
-
-
- - -PATROLZONE:NewPatrolRoute() - -
-
- -

Defines a new patrol route using the PatrolZone parameters and settings.

- -

Return value

- -

#PATROLZONE: -self

- -
-
-
-
- - DCSTypes#Altitude - -PATROLZONE.PatrolCeilingAltitude - -
-
- -

The highest altitude in meters where to execute the patrol.

- -
-
-
-
- - DCSTypes#Altitude - -PATROLZONE.PatrolFloorAltitude - -
-
- -

The lowest altitude in meters where to execute the patrol.

- -
-
-
-
- - - -PATROLZONE.PatrolFuelTresholdPercentage - -
-
- - - -
-
-
-
- - Group#GROUP - -PATROLZONE.PatrolGroup - -
-
- -

The Group patrolling.

- -
-
-
-
- - - -PATROLZONE.PatrolGroupTemplateName - -
-
- - - -
-
-
-
- - #boolean - -PATROLZONE.PatrolManageFuel - -
-
- - - -
-
-
-
- - DCSTypes#Speed - -PATROLZONE.PatrolMaxSpeed - -
-
- -

The maximum speed of the Group in km/h.

- -
-
-
-
- - DCSTypes#Speed - -PATROLZONE.PatrolMinSpeed - -
-
- -

The minimum speed of the Group in km/h.

- -
-
-
-
- - - -PATROLZONE.PatrolOutOfFuelMonitor - -
-
- - - -
-
-
-
- - - -PATROLZONE.PatrolOutOfFuelOrbitTime - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -PATROLZONE.PatrolZone - -
-
- -

The Zone where the patrol needs to be executed.

- -
-
-
-
- - -PATROLZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) - -
-
- -

Sets the floor and ceiling altitude of the patrol.

- -

Parameters

-
    -
  • - -

    DCSTypes#Altitude PatrolFloorAltitude : -The lowest altitude in meters where to execute the patrol.

    - -
    • -
  • - -

    DCSTypes#Altitude PatrolCeilingAltitude : -The highest altitude in meters where to execute the patrol.

    - -
    • -
-

Return value

- -

#PATROLZONE: -self

- -
-
-
-
- - -PATROLZONE:SetGroup(PatrolGroup) - -
-
- -

Set the Group to act as the Patroller.

- -

Parameter

- -

Return value

- -

#PATROLZONE: -self

- -
-
-
-
- - -PATROLZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Sets (modifies) the minimum and maximum speed of the patrol.

- -

Parameters

- -

Return value

- -

#PATROLZONE: -self

- -
-
- -
- -
- - diff --git a/Moose Training/Documentation/Process.html b/Moose Training/Documentation/Process.html deleted file mode 100644 index e6dee540c..000000000 --- a/Moose Training/Documentation/Process.html +++ /dev/null @@ -1,415 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Process

- - - -

Global(s)

- - - - - -
PROCESS - -
-

Type PROCESS

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS:AddScore(Task, State, ScoreText, Score, ProcessStatus) -

Adds a score for the PROCESS to be achieved.

-
PROCESS.ClassName - -
PROCESS.MissionMenu - -
PROCESS:New(ProcessName, Task, ProcessUnit, FSMT) -

Instantiates a new TASK Base.

-
PROCESS.NextEvent - -
PROCESS:OnStateChange(ProcessUnit, Event, From, To) -

StateMachine callback function for a PROCESS

-
PROCESS.ProcessGroup - -
PROCESS.ProcessName - -
PROCESS.Scores - -
PROCESS.Task - -
- -

Global(s)

-
-
- - #PROCESS - -PROCESS - -
-
- - - -
-
-

Type Process

- -

Type PROCESS

- -

The PROCESS class

- -

Field(s)

-
-
- - -PROCESS:AddScore(Task, State, ScoreText, Score, ProcessStatus) - -
-
- -

Adds a score for the PROCESS to be achieved.

- -

Parameters

-
    -
  • - -

    Task#TASK_BASE Task : -The task for which the process needs to account score.

    - -
    • -
  • - -

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

    - -
    • -
  • - -

    ProcessStatus :

    - -
    • -
-

Return value

- -

#PROCESS: -self

- -
-
-
-
- - #string - -PROCESS.ClassName - -
-
- - - -
-
-
-
- - Menu#MENU_GROUP - -PROCESS.MissionMenu - -
-
- - - -
-
-
-
- - -PROCESS:New(ProcessName, Task, ProcessUnit, FSMT) - -
-
- -

Instantiates a new TASK Base.

- - -

Should never be used. Interface Class.

- -

Parameters

-
    -
  • - -

    #string ProcessName :

    - -
    • -
  • - -

    Task#TASK_BASE Task :

    - -
    • -
  • - -

    Unit#UNIT ProcessUnit :

    - -
    • -
  • - -

    FSMT :

    - -
    • -
-

Return value

- -

#PROCESS: -self

- -
-
-
-
- - -PROCESS.NextEvent - -
-
- - - -
-
-
-
- - -PROCESS:OnStateChange(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - Group#GROUP - -PROCESS.ProcessGroup - -
-
- - - -
-
-
-
- - #string - -PROCESS.ProcessName - -
-
- - - -
-
-
-
- - - -PROCESS.Scores - -
-
- - - -
-
-
-
- - Task#TASK_BASE - -PROCESS.Task - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/Process_Destroy.html b/Moose Training/Documentation/Process_Destroy.html deleted file mode 100644 index e7b84b99d..000000000 --- a/Moose Training/Documentation/Process_Destroy.html +++ /dev/null @@ -1,692 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Process_Destroy

- - - -

Global(s)

- - - - - -
PROCESS_DESTROY - -
-

Type PROCESS_DESTROY

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS_DESTROY.ClassName - -
PROCESS_DESTROY.DisplayCategory - -
PROCESS_DESTROY.DisplayCount - -
PROCESS_DESTROY.DisplayInterval - -
PROCESS_DESTROY.DisplayMessage - -
PROCESS_DESTROY.DisplayTime - -
PROCESS_DESTROY:EventDead(Event) - -
PROCESS_DESTROY.Fsm - -
PROCESS_DESTROY:New(Task, ProcessUnit, TargetSetUnit, ProcessName) -

Creates a new DESTROY process.

-
PROCESS_DESTROY:OnDestroyed(Fsm, Event, From, To) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY:OnHitTarget(Fsm, Event, From, To, Event) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY:OnKilled(Fsm, Event, From, To, DCSEvent) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY:OnMoreTargets(Fsm, Event, From, To) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY:OnRestart(Fsm, Event, From, To) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY:OnStart(Fsm, Event, From, To) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY:OnWaiting(Fsm, Event, From, To) -

StateMachine callback function for a PROCESS

-
PROCESS_DESTROY.ProcessUnit - -
PROCESS_DESTROY.TargetSetUnit - -
- -

Global(s)

-
-
- - #PROCESS_DESTROY - -PROCESS_DESTROY - -
-
- - - -
-
-

Type Process_Destroy

- -

Type PROCESS_DESTROY

- -

PROCESS_DESTROY class

- -

Field(s)

-
-
- - #string - -PROCESS_DESTROY.ClassName - -
-
- - - -
-
-
-
- - #string - -PROCESS_DESTROY.DisplayCategory - -
-
- - - - -

Targets is the default display category

- -
-
-
-
- - #number - -PROCESS_DESTROY.DisplayCount - -
-
- - - -
-
-
-
- - #number - -PROCESS_DESTROY.DisplayInterval - -
-
- - - -
-
-
-
- - #boolean - -PROCESS_DESTROY.DisplayMessage - -
-
- - - -
-
-
-
- - #number - -PROCESS_DESTROY.DisplayTime - -
-
- - - - -

10 seconds is the default

- -
-
-
-
- - -PROCESS_DESTROY:EventDead(Event) - -
-
- - - -

Parameter

- -
-
-
-
- - - -PROCESS_DESTROY.Fsm - -
-
- - - -
-
-
-
- - -PROCESS_DESTROY:New(Task, ProcessUnit, TargetSetUnit, ProcessName) - -
-
- -

Creates a new DESTROY process.

- -

Parameters

- -

Return value

- -

#PROCESS_DESTROY: -self

- -
-
-
-
- - -PROCESS_DESTROY:OnDestroyed(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - -PROCESS_DESTROY:OnHitTarget(Fsm, Event, From, To, Event) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - -PROCESS_DESTROY:OnKilled(Fsm, Event, From, To, DCSEvent) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - -PROCESS_DESTROY:OnMoreTargets(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - -PROCESS_DESTROY:OnRestart(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - -PROCESS_DESTROY:OnStart(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - -PROCESS_DESTROY:OnWaiting(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a PROCESS

- -

Parameters

- -
-
-
-
- - Unit#UNIT - -PROCESS_DESTROY.ProcessUnit - -
-
- - - -
-
-
-
- - Set#SET_UNIT - -PROCESS_DESTROY.TargetSetUnit - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/Process_PatrolZone.html b/Moose Training/Documentation/Process_PatrolZone.html deleted file mode 100644 index 6f663e3f1..000000000 --- a/Moose Training/Documentation/Process_PatrolZone.html +++ /dev/null @@ -1,786 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Process_PatrolZone

- -

(AI) Make AI patrol routes or zones.

- - - -
- -

1) #PROCESS_PATROLZONE class, extends StateMachine#STATEMACHINE

-

The #PROCESS_PATROLZONE class implements the core functions to patrol a Zone by an AIR Controllable Group. -The patrol algorithm works that for each airplane patrolling, upon arrival at the patrol zone, -a random point is selected as the route point within the 3D space, within the given boundary limits. -The airplane will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits. -Upon arrival at the random 3D point, a new 3D random point will be selected within the patrol zone using the given limits. -This cycle will continue until a fuel treshold has been reached by the airplane. -When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.

- -

1.1) PROCESS_PATROLZONE constructor:

- - - -

1.2) PROCESS_PATROLZONE state machine:

-

The PROCESS_PATROLZONE is a state machine: it manages the different events and states of the AIControllable it is controlling.

- -

1.2.1) PROCESS_PATROLZONE Events:

- -
    -
  • PROCESS_PATROLZONE.Route( AIControllable ): A new 3D route point is selected and the AIControllable will fly towards that point with the given speed.
    • -
  • PROCESS_PATROLZONE.Patrol( AIControllable ): The AIControllable reports it is patrolling. This event is called every 30 seconds.
    • -
  • PROCESS_PATROLZONE.RTB( AIControllable ): The AIControllable will report return to base.
    • -
  • PROCESS_PATROLZONE.End( AIControllable ): The end of the PROCESS_PATROLZONE process.
    • -
  • PROCESS_PATROLZONE.Dead( AIControllable ): The AIControllable is dead. The PROCESS_PATROLZONE process will be ended.
    • -
- -

1.2.2) PROCESS_PATROLZONE States:

- -
    -
  • Route: A new 3D route point is selected and the AIControllable will fly towards that point with the given speed.
    • -
  • Patrol: The AIControllable is patrolling. This state is set every 30 seconds, so every 30 seconds, a state transition function can be used.
    • -
  • RTB: The AIControllable reports it wants to return to the base.
    • -
  • Dead: The AIControllable is dead ...
    • -
  • End: The process has come to an end.
    • -
- -

1.2.3) PROCESS_PATROLZONE state transition functions:

- -

State transition functions can be set by the mission designer customizing or improving the behaviour of the state. -There are 2 moments when state transition functions will be called by the state machine:

- -
    -

  • Before the state transition. - The state transition function needs to start with the name OnBefore + the name of the state. - If the state transition function returns false, then the processing of the state transition will not be done! - If you want to change the behaviour of the AIControllable at this event, return false, - but then you'll need to specify your own logic using the AIControllable!

    • -

  • After the state transition. - The state transition function needs to start with the name OnAfter + the name of the state. - These state transition functions need to provide a return value, which is specified at the function description.

    • -
- -

An example how to manage a state transition for an PROCESS_PATROLZONE object Patrol for the state RTB:

- -
 local PatrolZoneGroup = GROUP:FindByName( "Patrol Zone" )
- local PatrolZone = ZONE_POLYGON:New( "PatrolZone", PatrolZoneGroup )
-
- local PatrolSpawn = SPAWN:New( "Patrol Group" )
- local PatrolGroup = PatrolSpawn:Spawn()
-
- local Patrol = PROCESS_PATROLZONE:New( PatrolZone, 3000, 6000, 300, 600 )
- Patrol:SetControllable( PatrolGroup )
- Patrol:ManageFuel( 0.2, 60 )
-
- -

OnBeforeRTB( AIGroup ) will be called by the PROCESS_PATROLZONE object when the AIGroup reports RTB, but before the RTB default action is processed by the PROCESS_PATROLZONE object.

- -
 --- State transition function for the PROCESS\_PATROLZONE **Patrol** object
- -- @param #PROCESS_PATROLZONE self 
- -- @param Controllable#CONTROLLABLE AIGroup
- -- @return #boolean If false is returned, then the OnAfter state transition function will not be called.
- function Patrol:OnBeforeRTB( AIGroup )
-   AIGroup:MessageToRed( "Returning to base", 20 )
- end
-
- -

OnAfterRTB( AIGroup ) will be called by the PROCESS_PATROLZONE object when the AIGroup reports RTB, but after the RTB default action was processed by the PROCESS_PATROLZONE object.

- -
 --- State transition function for the PROCESS\_PATROLZONE **Patrol** object
- -- @param #PROCESS_PATROLZONE self 
- -- @param Controllable#CONTROLLABLE AIGroup
- -- @return #Controllable#CONTROLLABLE The new AIGroup object that is set to be patrolling the zone.
- function Patrol:OnAfterRTB( AIGroup )
-   return PatrolSpawn:Spawn()
- end 
-
- -

1.3) Manage the PROCESS_PATROLZONE parameters:

-

The following methods are available to modify the parameters of a PROCESS_PATROLZONE object:

- - - -

1.3) Manage the out of fuel in the PROCESS_PATROLZONE:

-

When the AIControllable is out of fuel, it is required that a new AIControllable is started, before the old AIControllable can return to the home base. -Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the AIControllable will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the PROCESS_PATROLZONE. -Once the time is finished, the old AIControllable will return to the base. -Use the method PROCESS_PATROLZONE.ManageFuel() to have this proces in place.

- -
- -

API CHANGE HISTORY

- -

The underlying change log documents the API changes. Please read this carefully. The following notation is used:

- -
    -
  • Added parts are expressed in bold type face.
    • -
  • Removed parts are expressed in italic type face.
    • -
- -

Hereby the change log:

- -

2016-09-01: Initial class and API.

- -
- -

AUTHORS and CONTRIBUTIONS

- -

Contributions:

- -
    -
  • DutchBaron: Testing.
    • -
  • Pikey: Testing and API concept review.
    • -
- -

Authors:

- -
    -
  • FlightControl: Design & Programming.
    • -
- - - -

Global(s)

- - - - - - - - - -
PROCESS_PATROLZONE - -
_NewPatrolRoute(AIControllable) - -
-

Type PROCESS_PATROLZONE

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS_PATROLZONE.AIControllable -

The Controllable patrolling.

-
PROCESS_PATROLZONE.ClassName - -
PROCESS_PATROLZONE:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) -

When the AIControllable is out of fuel, it is required that a new AIControllable is started, before the old AIControllable can return to the home base.

-
PROCESS_PATROLZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) -

Creates a new PROCESS_PATROLZONE object

-
PROCESS_PATROLZONE:OnAfterRoute(Controllable) -

OnAfter State Transition Function

-
PROCESS_PATROLZONE:OnBeforeRoute(Controllable) -

OnBefore State Transition Function

-
PROCESS_PATROLZONE.PatrolCeilingAltitude -

The highest altitude in meters where to execute the patrol.

-
PROCESS_PATROLZONE.PatrolFloorAltitude -

The lowest altitude in meters where to execute the patrol.

-
PROCESS_PATROLZONE.PatrolFuelTresholdPercentage - -
PROCESS_PATROLZONE.PatrolManageFuel - -
PROCESS_PATROLZONE.PatrolMaxSpeed -

The maximum speed of the Controllable in km/h.

-
PROCESS_PATROLZONE.PatrolMinSpeed -

The minimum speed of the Controllable in km/h.

-
PROCESS_PATROLZONE.PatrolOutOfFuelOrbitTime - -
PROCESS_PATROLZONE.PatrolZone -

The Zone where the patrol needs to be executed.

-
PROCESS_PATROLZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) -

Sets the floor and ceiling altitude of the patrol.

-
PROCESS_PATROLZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed) -

Sets (modifies) the minimum and maximum speed of the patrol.

-
PROCESS_PATROLZONE:onenterPatrol() - -
PROCESS_PATROLZONE:onenterRoute() -

Defines a new patrol route using the Process_PatrolZone parameters and settings.

-
- -

Global(s)

-
-
- - #PROCESS_PATROLZONE - -PROCESS_PATROLZONE - -
-
- - - -
-
-
-
- - -_NewPatrolRoute(AIControllable) - -
-
- - - -

Parameter

- -
-
-

Type Process_PatrolZone

- -

Type PROCESS_PATROLZONE

- -

PROCESS_PATROLZONE class

- -

Field(s)

-
-
- - Controllable#CONTROLLABLE - -PROCESS_PATROLZONE.AIControllable - -
-
- -

The Controllable patrolling.

- -
-
-
-
- - #string - -PROCESS_PATROLZONE.ClassName - -
-
- - - -
-
-
-
- - -PROCESS_PATROLZONE:ManageFuel(PatrolFuelTresholdPercentage, PatrolOutOfFuelOrbitTime) - -
-
- -

When the AIControllable is out of fuel, it is required that a new AIControllable is started, before the old AIControllable can return to the home base.

- - -

Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated. -When the fuel treshold is reached, the AIControllable will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the PROCESS_PATROLZONE. -Once the time is finished, the old AIControllable will return to the base.

- -

Parameters

-
    -
  • - -

    #number PatrolFuelTresholdPercentage : -The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.

    - -
    • -
  • - -

    #number PatrolOutOfFuelOrbitTime : -The amount of seconds the out of fuel AIControllable will orbit before returning to the base.

    - -
    • -
-

Return value

- -

#PROCESS_PATROLZONE: -self

- -
-
-
-
- - -PROCESS_PATROLZONE:New(PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Creates a new PROCESS_PATROLZONE object

- -

Parameters

- -

Return value

- -

#PROCESS_PATROLZONE: -self

- -

Usage:

- 
-- Define a new PROCESS_PATROLZONE Object. This PatrolArea will patrol an AIControllable within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
-PatrolZone = ZONE:New( 'PatrolZone' )
-PatrolSpawn = SPAWN:New( 'Patrol Group' )
-PatrolArea = PROCESS_PATROLZONE:New( PatrolZone, 3000, 6000, 600, 900 )
- -
-
-
-
- - -PROCESS_PATROLZONE:OnAfterRoute(Controllable) - -
-
- -

OnAfter State Transition Function

- -

Parameter

- -
-
-
-
- - -PROCESS_PATROLZONE:OnBeforeRoute(Controllable) - -
-
- -

OnBefore State Transition Function

- -

Parameter

- -

Return value

- -

#boolean:

- - -
-
-
-
- - DCSTypes#Altitude - -PROCESS_PATROLZONE.PatrolCeilingAltitude - -
-
- -

The highest altitude in meters where to execute the patrol.

- -
-
-
-
- - DCSTypes#Altitude - -PROCESS_PATROLZONE.PatrolFloorAltitude - -
-
- -

The lowest altitude in meters where to execute the patrol.

- -
-
-
-
- - - -PROCESS_PATROLZONE.PatrolFuelTresholdPercentage - -
-
- - - -
-
-
-
- - #boolean - -PROCESS_PATROLZONE.PatrolManageFuel - -
-
- - - -
-
-
-
- - DCSTypes#Speed - -PROCESS_PATROLZONE.PatrolMaxSpeed - -
-
- -

The maximum speed of the Controllable in km/h.

- -
-
-
-
- - DCSTypes#Speed - -PROCESS_PATROLZONE.PatrolMinSpeed - -
-
- -

The minimum speed of the Controllable in km/h.

- -
-
-
-
- - - -PROCESS_PATROLZONE.PatrolOutOfFuelOrbitTime - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -PROCESS_PATROLZONE.PatrolZone - -
-
- -

The Zone where the patrol needs to be executed.

- -
-
-
-
- - -PROCESS_PATROLZONE:SetAltitude(PatrolFloorAltitude, PatrolCeilingAltitude) - -
-
- -

Sets the floor and ceiling altitude of the patrol.

- -

Parameters

-
    -
  • - -

    DCSTypes#Altitude PatrolFloorAltitude : -The lowest altitude in meters where to execute the patrol.

    - -
    • -
  • - -

    DCSTypes#Altitude PatrolCeilingAltitude : -The highest altitude in meters where to execute the patrol.

    - -
    • -
-

Return value

- -

#PROCESS_PATROLZONE: -self

- -
-
-
-
- - -PROCESS_PATROLZONE:SetSpeed(PatrolMinSpeed, PatrolMaxSpeed) - -
-
- -

Sets (modifies) the minimum and maximum speed of the patrol.

- -

Parameters

- -

Return value

- -

#PROCESS_PATROLZONE: -self

- -
-
-
-
- - -PROCESS_PATROLZONE:onenterPatrol() - -
-
- - - -
-
-
-
- - -PROCESS_PATROLZONE:onenterRoute() - -
-
- -

Defines a new patrol route using the Process_PatrolZone parameters and settings.

- -

Return value

- -

#PROCESS_PATROLZONE: -self

- -
-
- -
- -
- - diff --git a/Moose Training/Documentation/Process_Smoke.html b/Moose Training/Documentation/Process_Smoke.html deleted file mode 100644 index 0115dd96c..000000000 --- a/Moose Training/Documentation/Process_Smoke.html +++ /dev/null @@ -1,487 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Process_Smoke

- - - -

Global(s)

- - - - - -
PROCESS_SMOKE_TARGETS - -
-

Type PROCESS_SMOKE_TARGETS

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS_SMOKE_TARGETS.ClassName - -
PROCESS_SMOKE_TARGETS.Menu - -
PROCESS_SMOKE_TARGETS.MenuSmokeBlue - -
PROCESS_SMOKE_TARGETS.MenuSmokeGreen - -
PROCESS_SMOKE_TARGETS.MenuSmokeOrange - -
PROCESS_SMOKE_TARGETS.MenuSmokeRed - -
PROCESS_SMOKE_TARGETS.MenuSmokeWhite - -
PROCESS_SMOKE_TARGETS:New(Task, Unit, ProcessUnit, TargetSetUnit, TargetZone) -

Creates a new task assignment state machine.

-
PROCESS_SMOKE_TARGETS:OnSmoking(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_SMOKE_TARGETS:OnStart(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_SMOKE_TARGETS.ProcessUnit - -
PROCESS_SMOKE_TARGETS.TargetSetUnit - -
PROCESS_SMOKE_TARGETS.TargetZone - -
PROCESS_SMOKE_TARGETS.Task - -
- -

Global(s)

-
-
- - #PROCESS_SMOKE_TARGETS - -PROCESS_SMOKE_TARGETS - -
-
- - - -
-
-

Type Process_Smoke

- -

Type PROCESS_SMOKE_TARGETS

- -

PROCESSSMOKETARGETS class

- -

Field(s)

-
-
- - #string - -PROCESS_SMOKE_TARGETS.ClassName - -
-
- - - -
-
-
-
- - - -PROCESS_SMOKE_TARGETS.Menu - -
-
- - - -
-
-
-
- - - -PROCESS_SMOKE_TARGETS.MenuSmokeBlue - -
-
- - - -
-
-
-
- - - -PROCESS_SMOKE_TARGETS.MenuSmokeGreen - -
-
- - - -
-
-
-
- - - -PROCESS_SMOKE_TARGETS.MenuSmokeOrange - -
-
- - - -
-
-
-
- - - -PROCESS_SMOKE_TARGETS.MenuSmokeRed - -
-
- - - -
-
-
-
- - - -PROCESS_SMOKE_TARGETS.MenuSmokeWhite - -
-
- - - -
-
-
-
- - -PROCESS_SMOKE_TARGETS:New(Task, Unit, ProcessUnit, TargetSetUnit, TargetZone) - -
-
- -

Creates a new task assignment state machine.

- - -

The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.

- -

Parameters

-
    -
  • - -

    Task#TASK Task :

    - -
    • -
  • - -

    Unit#UNIT Unit :

    - -
    • -
  • - -

    ProcessUnit :

    - -
    • -
  • - -

    TargetSetUnit :

    - -
    • -
  • - -

    TargetZone :

    - -
    • -
-

Return value

- -

#PROCESSSMOKETARGETS: -self

- -
-
-
-
- - -PROCESS_SMOKE_TARGETS:OnSmoking(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - -PROCESS_SMOKE_TARGETS:OnStart(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - Unit#UNIT - -PROCESS_SMOKE_TARGETS.ProcessUnit - -
-
- - - -
-
-
-
- - Set#SET_UNIT - -PROCESS_SMOKE_TARGETS.TargetSetUnit - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -PROCESS_SMOKE_TARGETS.TargetZone - -
-
- - - -
-
-
-
- - Task#TASK_BASE - -PROCESS_SMOKE_TARGETS.Task - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/STAGE.html b/Moose Training/Documentation/STAGE.html deleted file mode 100644 index 20f8f296e..000000000 --- a/Moose Training/Documentation/STAGE.html +++ /dev/null @@ -1,867 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module STAGE

- -

Stages within a TASK within a MISSION.

- - -

All of the STAGE functionality is considered internally administered and not to be used by any Mission designer.

- -

Global(s)

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CargoStatic - -
STAGE - -
STAGEARRIVE - -
STAGEBRIEF - -
STAGEDONE - -
STAGEGROUPSDESTROYED - -
STAGELANDED - -
STAGELANDING - -
STAGELOAD - -
STAGEROUTE - -
STAGESTART - -
STAGEUNLOAD - -
STAGE_CARGO_INIT - -
STAGE_CARGO_LOAD - -
_TransportStage - -
_TransportStageAction - -
_TransportStageTime - -
-

Type STAGE

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
STAGE.ClassName - -
STAGE:Execute(Mission, Client, Task) - -
STAGE:Executing(Mission, Client, Task) - -
STAGE.FREQUENCY - -
STAGE.Frequency - -
STAGE.MSG - -
STAGE.MessageCount - -
STAGE.MessageFlash - -
STAGE.MessageInterval - -
STAGE.MessageShow - -
STAGE.MessageShown - -
STAGE.Name - -
STAGE:New() - -
STAGE.StageType - -
STAGE:Validate(Mission, Client, Task) - -
STAGE.WaitTime - -
- -

Type STAGEBRIEF

- - - - - -
STAGEBRIEF.StageBriefingTime - -
- -

Global(s)

-
-
- - - -CargoStatic - -
-
- - - -
-
-
-
- - #STAGE - -STAGE - -
-
- - - -
-
-
-
- - - -STAGEARRIVE - -
-
- - - -
-
-
-
- - - -STAGEBRIEF - -
-
- - - -
-
-
-
- - - -STAGEDONE - -
-
- - - -
-
-
-
- - - -STAGEGROUPSDESTROYED - -
-
- - - -
-
-
-
- - - -STAGELANDED - -
-
- - - -
-
-
-
- - - -STAGELANDING - -
-
- - - -
-
-
-
- - - -STAGELOAD - -
-
- - - -
-
-
-
- - - -STAGEROUTE - -
-
- - - -
-
-
-
- - - -STAGESTART - -
-
- - - -
-
-
-
- - - -STAGEUNLOAD - -
-
- - - -
-
-
-
- - - -STAGE_CARGO_INIT - -
-
- - - -
-
-
-
- - - -STAGE_CARGO_LOAD - -
-
- - - -
-
-
-
- - - -_TransportStage - -
-
- - - - -

_TransportStage: Defines the different stages of which of transport missions can be in. This table is internal and is used to control the sequence of messages, actions and flow.

- -
    -
  • _TransportStage.START
    • -
  • _TransportStage.ROUTE
    • -
  • _TransportStage.LAND
    • -
  • _TransportStage.EXECUTE
    • -
  • _TransportStage.DONE
    • -
  • _TransportStage.REMOVE - --
    • -
- -
-
-
-
- - - -_TransportStageAction - -
-
- - - -
-
-
-
- - - -_TransportStageTime - -
-
- - - -
-
-

Type STAGE

-

Field(s)

-
-
- - #string - -STAGE.ClassName - -
-
- - - -
-
-
-
- - -STAGE:Execute(Mission, Client, Task) - -
-
- - - -

Parameters

-
    -
  • - -

    Mission :

    - -
    • -
  • - -

    Client :

    - -
    • -
  • - -

    Task :

    - -
    • -
-
-
-
-
- - -STAGE:Executing(Mission, Client, Task) - -
-
- - - -

Parameters

-
    -
  • - -

    Mission :

    - -
    • -
  • - -

    Client :

    - -
    • -
  • - -

    Task :

    - -
    • -
-
-
-
-
- - - -STAGE.FREQUENCY - -
-
- - - -
-
-
-
- - #number - -STAGE.Frequency - -
-
- - - -
-
-
-
- - - -STAGE.MSG - -
-
- - - -
-
-
-
- - #number - -STAGE.MessageCount - -
-
- - - -
-
-
-
- - #boolean - -STAGE.MessageFlash - -
-
- - - -
-
-
-
- - #number - -STAGE.MessageInterval - -
-
- - - -
-
-
-
- - #boolean - -STAGE.MessageShow - -
-
- - - -
-
-
-
- - - -STAGE.MessageShown - -
-
- - - -
-
-
-
- - #string - -STAGE.Name - -
-
- - - -
-
-
-
- - -STAGE:New() - -
-
- - - -
-
-
-
- - #string - -STAGE.StageType - -
-
- - - -
-
-
-
- - -STAGE:Validate(Mission, Client, Task) - -
-
- - - -

Parameters

-
    -
  • - -

    Mission :

    - -
    • -
  • - -

    Client :

    - -
    • -
  • - -

    Task :

    - -
    • -
-
-
-
-
- - #number - -STAGE.WaitTime - -
-
- - - -
-
- -

Type STAGEARRIVE

- -

Type STAGEBRIEF

-

Field(s)

-
-
- - - -STAGEBRIEF.StageBriefingTime - -
-
- - - -
-
- -

Type STAGELANDING

- -

Type STAGEROUTE

- -

Type STAGEUNLOAD

- -
- -
- - diff --git a/Moose Training/Documentation/StateMachine.html b/Moose Training/Documentation/StateMachine.html deleted file mode 100644 index ad966ec66..000000000 --- a/Moose Training/Documentation/StateMachine.html +++ /dev/null @@ -1,1224 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module StateMachine

- -

This module contains the STATEMACHINE class.

- - -

This development is based on a state machine implementation made by Conroy Kyle. -The state machine can be found here: https://github.com/kyleconroy/lua-state-machine

- -

I've taken the development and enhanced it to make the state machine hierarchical... -It is a fantastic development, this module.

- -
- -

1) Workflow#STATEMACHINE class, extends Base#BASE

- -

1.1) Add or remove objects from the STATEMACHINE

- -

Global(s)

- - - - - - - - - - - - - - - - - - - - - -
STATEMACHINE - -
STATEMACHINE_CONTROLLABLE - -
STATEMACHINE_PROCESS - -
STATEMACHINE_SET - -
STATEMACHINE_TASK - -
-

Type STATEMACHINE

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
STATEMACHINE.ClassName - -
STATEMACHINE:LoadCallBacks(CallBackTable) - -
STATEMACHINE:New(options) -

Creates a new STATEMACHINE object.

-
STATEMACHINE:_add_to_map(map, event) - -
STATEMACHINE:_call_handler(handler, params) - -
STATEMACHINE:_create_transition(EventName) - -
STATEMACHINE:_delayed_transition(EventName) - -
STATEMACHINE:_gosub(parentstate, parentevent) - -
STATEMACHINE:_handler(EventName, ...) - -
STATEMACHINE:_isendstate(state) - -
STATEMACHINE:_submap(subs, sub, name) - -
STATEMACHINE:can(e) - -
STATEMACHINE:cannot(e) - -
STATEMACHINE:is(state) - -
STATEMACHINE:todot(filename) - -
- -

Type STATEMACHINE_CONTROLLABLE

- - - - - - - - - - - - - - - - - - - - - - - - - -
STATEMACHINE_CONTROLLABLE.ClassName - -
STATEMACHINE_CONTROLLABLE.Controllable - -
STATEMACHINE_CONTROLLABLE:GetControllable() -

Gets the CONTROLLABLE object that the STATEMACHINE_CONTROLLABLE governs.

-
STATEMACHINE_CONTROLLABLE:New(FSMT, Controllable) -

Creates a new STATEMACHINE_CONTROLLABLE object.

-
STATEMACHINE_CONTROLLABLE:SetControllable(Controllable, FSMControllable) -

Sets the CONTROLLABLE object that the STATEMACHINE_CONTROLLABLE governs.

-
STATEMACHINE_CONTROLLABLE:_call_handler(handler, params) - -
- -

Type STATEMACHINE_PROCESS

- - - - - - - - - - - - - - - - - -
STATEMACHINE_PROCESS.ClassName - -
STATEMACHINE_PROCESS:New(FSMT) -

Creates a new STATEMACHINE_PROCESS object.

-
STATEMACHINE_PROCESS.Process - -
STATEMACHINE_PROCESS:_call_handler(handler, params) - -
- -

Type STATEMACHINE_SET

- - - - - - - - - - - - - - - - - - - - - -
STATEMACHINE_SET.ClassName - -
STATEMACHINE_SET:Get() -

Gets the SETBASE object that the STATEMACHINESET governs.

-
STATEMACHINE_SET:New(FSMT, Set_SET_BASE, FSMSet) -

Creates a new STATEMACHINE_SET object.

-
STATEMACHINE_SET.Set - -
STATEMACHINE_SET:_call_handler(handler, params) - -
- -

Type STATEMACHINE_TASK

- - - - - - - - - - - - - - - - - -
STATEMACHINE_TASK.ClassName - -
STATEMACHINE_TASK:New(FSMT, Task, TaskUnit) -

Creates a new STATEMACHINE_TASK object.

-
STATEMACHINE_TASK.Task - -
STATEMACHINE_TASK:_call_handler(handler, params) - -
- -

Global(s)

-
-
- - #STATEMACHINE - -STATEMACHINE - -
-
- - - -
-
-
-
- - #STATEMACHINE_CONTROLLABLE - -STATEMACHINE_CONTROLLABLE - -
-
- - - -
-
-
-
- - #STATEMACHINE_PROCESS - -STATEMACHINE_PROCESS - -
-
- - - -
-
-
-
- - #STATEMACHINE_SET - -STATEMACHINE_SET - -
-
- - - -
-
-
-
- - #STATEMACHINE_TASK - -STATEMACHINE_TASK - -
-
- - - -
-
-

Type StateMachine

- -

Type STATEMACHINE

- -

STATEMACHINE class

- -

Field(s)

-
-
- - #string - -STATEMACHINE.ClassName - -
-
- - - -
-
-
-
- - -STATEMACHINE:LoadCallBacks(CallBackTable) - -
-
- - - -

Parameter

-
    -
  • - -

    CallBackTable :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:New(options) - -
-
- -

Creates a new STATEMACHINE object.

- -

Parameter

-
    -
  • - -

    options :

    - -
    • -
-

Return value

- -

#STATEMACHINE:

- - -
-
-
-
- - -STATEMACHINE:_add_to_map(map, event) - -
-
- - - -

Parameters

-
    -
  • - -

    map :

    - -
    • -
  • - -

    event :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_call_handler(handler, params) - -
-
- - - -

Parameters

-
    -
  • - -

    handler :

    - -
    • -
  • - -

    params :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_create_transition(EventName) - -
-
- - - -

Parameter

-
    -
  • - -

    EventName :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_delayed_transition(EventName) - -
-
- - - -

Parameter

-
    -
  • - -

    EventName :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_gosub(parentstate, parentevent) - -
-
- - - -

Parameters

-
    -
  • - -

    parentstate :

    - -
    • -
  • - -

    parentevent :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_handler(EventName, ...) - -
-
- - - -

Parameters

-
    -
  • - -

    EventName :

    - -
    • -
  • - -

    ... :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_isendstate(state) - -
-
- - - -

Parameter

-
    -
  • - -

    state :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:_submap(subs, sub, name) - -
-
- - - -

Parameters

-
    -
  • - -

    subs :

    - -
    • -
  • - -

    sub :

    - -
    • -
  • - -

    name :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:can(e) - -
-
- - - -

Parameter

-
    -
  • - -

    e :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:cannot(e) - -
-
- - - -

Parameter

-
    -
  • - -

    e :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:is(state) - -
-
- - - -

Parameter

-
    -
  • - -

    state :

    - -
    • -
-
-
-
-
- - -STATEMACHINE:todot(filename) - -
-
- - - -

Parameter

-
    -
  • - -

    filename :

    - -
    • -
-
-
- -

Type STATEMACHINE_CONTROLLABLE

- -

STATEMACHINE_CONTROLLABLE class

- -

Field(s)

-
-
- - #string - -STATEMACHINE_CONTROLLABLE.ClassName - -
-
- - - -
-
-
-
- - Controllable#CONTROLLABLE - -STATEMACHINE_CONTROLLABLE.Controllable - -
-
- - - -
-
-
-
- - -STATEMACHINE_CONTROLLABLE:GetControllable() - -
-
- -

Gets the CONTROLLABLE object that the STATEMACHINE_CONTROLLABLE governs.

- -

Return value

- -

Controllable#CONTROLLABLE:

- - -
-
-
-
- - -STATEMACHINE_CONTROLLABLE:New(FSMT, Controllable) - -
-
- -

Creates a new STATEMACHINE_CONTROLLABLE object.

- -

Parameters

-
    -
  • - -

    #table FSMT : -Finite State Machine Table

    - -
    • -
  • - -

    Controllable#CONTROLLABLE Controllable : -(optional) The CONTROLLABLE object that the STATEMACHINE_CONTROLLABLE governs.

    - -
    • -
-

Return value

- -

#STATEMACHINE_CONTROLLABLE:

- - -
-
-
-
- - -STATEMACHINE_CONTROLLABLE:SetControllable(Controllable, FSMControllable) - -
-
- -

Sets the CONTROLLABLE object that the STATEMACHINE_CONTROLLABLE governs.

- -

Parameters

- -

Return value

- -

#STATEMACHINE_CONTROLLABLE:

- - -
-
-
-
- - -STATEMACHINE_CONTROLLABLE:_call_handler(handler, params) - -
-
- - - -

Parameters

-
    -
  • - -

    handler :

    - -
    • -
  • - -

    params :

    - -
    • -
-
-
- -

Type STATEMACHINE_PROCESS

- -

STATEMACHINE_PROCESS class

- -

Field(s)

-
-
- - #string - -STATEMACHINE_PROCESS.ClassName - -
-
- - - -
-
-
-
- - -STATEMACHINE_PROCESS:New(FSMT) - -
-
- -

Creates a new STATEMACHINE_PROCESS object.

- -

Parameter

-
    -
  • - -

    FSMT :

    - -
    • -
-

Return value

- -

#STATEMACHINE_PROCESS:

- - -
-
-
-
- - Process#PROCESS - -STATEMACHINE_PROCESS.Process - -
-
- - - -
-
-
-
- - -STATEMACHINE_PROCESS:_call_handler(handler, params) - -
-
- - - -

Parameters

-
    -
  • - -

    handler :

    - -
    • -
  • - -

    params :

    - -
    • -
-
-
- -

Type STATEMACHINE_SET

- -

STATEMACHINE_SET class

- -

Field(s)

-
-
- - #string - -STATEMACHINE_SET.ClassName - -
-
- - - -
-
-
-
- - -STATEMACHINE_SET:Get() - -
-
- -

Gets the SETBASE object that the STATEMACHINESET governs.

- -

Return value

- -

Set#SET_BASE:

- - -
-
-
-
- - -STATEMACHINE_SET:New(FSMT, Set_SET_BASE, FSMSet) - -
-
- -

Creates a new STATEMACHINE_SET object.

- -

Parameters

-
    -
  • - -

    #table FSMT : -Finite State Machine Table

    - -
    • -
  • - -

    SetSETBASE : -FSMSet (optional) The Set object that the STATEMACHINE_SET governs.

    - -
    • -
  • - -

    FSMSet :

    - -
    • -
-

Return value

- -

#STATEMACHINE_SET:

- - -
-
-
-
- - Set#SET_BASE - -STATEMACHINE_SET.Set - -
-
- - - -
-
-
-
- - -STATEMACHINE_SET:_call_handler(handler, params) - -
-
- - - -

Parameters

-
    -
  • - -

    handler :

    - -
    • -
  • - -

    params :

    - -
    • -
-
-
- -

Type STATEMACHINE_TASK

- -

STATEMACHINE_TASK class

- -

Field(s)

-
-
- - #string - -STATEMACHINE_TASK.ClassName - -
-
- - - -
-
-
-
- - -STATEMACHINE_TASK:New(FSMT, Task, TaskUnit) - -
-
- -

Creates a new STATEMACHINE_TASK object.

- -

Parameters

- -

Return value

- -

#STATEMACHINE_TASK:

- - -
-
-
-
- - Task#TASK_BASE - -STATEMACHINE_TASK.Task - -
-
- - - -
-
-
-
- - -STATEMACHINE_TASK:_call_handler(handler, params) - -
-
- - - -

Parameters

-
    -
  • - -

    handler :

    - -
    • -
  • - -

    params :

    - -
    • -
-
-
- -
- -
- - diff --git a/Moose Training/Documentation/Task_Assign.html b/Moose Training/Documentation/Task_Assign.html deleted file mode 100644 index 122e20e49..000000000 --- a/Moose Training/Documentation/Task_Assign.html +++ /dev/null @@ -1,802 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Task_Assign

- -

This module contains the PROCESS_ASSIGN classes.

- - - -
- -

1) TaskAssign#TASKASSIGN_ACCEPT class, extends Task#TASK_BASE

-

The TaskAssign#TASKASSIGN_ACCEPT class accepts by default a task for a player. No player intervention is allowed to reject the task.

- -

2) TaskAssign#TASKASSIGNMENUACCEPT class, extends Task#TASK_BASE

-

The TaskAssign#TASKASSIGNMENUACCEPT class accepts a task when the player accepts the task through an added menu option. -This assignment type is useful to conditionally allow the player to choose whether or not he would accept the task. -The assignment type also allows to reject the task.

- - - - - - - -

Global(s)

- - - - - - - - - -
PROCESS_ASSIGN_ACCEPT - -
PROCESS_ASSIGN_MENU_ACCEPT - -
-

Type PROCESS_ASSIGN_ACCEPT

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS_ASSIGN_ACCEPT.ClassName - -
PROCESS_ASSIGN_ACCEPT.Fsm - -
PROCESS_ASSIGN_ACCEPT:New(Task, Unit, ProcessUnit, TaskBriefing) -

Creates a new task assignment state machine.

-
PROCESS_ASSIGN_ACCEPT:OnAssigned(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_ASSIGN_ACCEPT.ProcessUnit - -
PROCESS_ASSIGN_ACCEPT.TargetZone - -
PROCESS_ASSIGN_ACCEPT.Task - -
PROCESS_ASSIGN_ACCEPT.TaskBriefing - -
- -

Type PROCESS_ASSIGN_MENU_ACCEPT

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS_ASSIGN_MENU_ACCEPT.ClassName - -
PROCESS_ASSIGN_MENU_ACCEPT.Fsm - -
PROCESS_ASSIGN_MENU_ACCEPT.Menu - -
PROCESS_ASSIGN_MENU_ACCEPT.MenuAcceptTask - -
PROCESS_ASSIGN_MENU_ACCEPT:MenuAssign() -

Menu function.

-
PROCESS_ASSIGN_MENU_ACCEPT:MenuReject() -

Menu function.

-
PROCESS_ASSIGN_MENU_ACCEPT.MenuRejectTask - -
PROCESS_ASSIGN_MENU_ACCEPT.MenuText - -
PROCESS_ASSIGN_MENU_ACCEPT:New(Task, Unit, ProcessUnit, TaskBriefing) -

Creates a new task assignment state machine.

-
PROCESS_ASSIGN_MENU_ACCEPT:OnAssign(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_ASSIGN_MENU_ACCEPT:OnReject(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_ASSIGN_MENU_ACCEPT:OnStart(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_ASSIGN_MENU_ACCEPT.ProcessUnit - -
PROCESS_ASSIGN_MENU_ACCEPT.TargetZone - -
PROCESS_ASSIGN_MENU_ACCEPT.Task - -
PROCESS_ASSIGN_MENU_ACCEPT.TaskBriefing - -
- -

Global(s)

-
-
- - #PROCESS_ASSIGN_ACCEPT - -PROCESS_ASSIGN_ACCEPT - -
-
- - - -
-
-
-
- - #PROCESS_ASSIGN_MENU_ACCEPT - -PROCESS_ASSIGN_MENU_ACCEPT - -
-
- - - -
-
-

Type Task_Assign

- -

Type PROCESS_ASSIGN_ACCEPT

- -

PROCESSASSIGNACCEPT class

- -

Field(s)

-
-
- - #string - -PROCESS_ASSIGN_ACCEPT.ClassName - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_ACCEPT.Fsm - -
-
- - - -
-
-
-
- - -PROCESS_ASSIGN_ACCEPT:New(Task, Unit, ProcessUnit, TaskBriefing) - -
-
- -

Creates a new task assignment state machine.

- - -

The process will accept the task by default, no player intervention accepted.

- -

Parameters

-
    -
  • - -

    Task#TASK Task :

    - -
    • -
  • - -

    Unit#UNIT Unit :

    - -
    • -
  • - -

    ProcessUnit :

    - -
    • -
  • - -

    TaskBriefing :

    - -
    • -
-

Return value

- -

#PROCESSASSIGNACCEPT: -self

- -
-
-
-
- - -PROCESS_ASSIGN_ACCEPT:OnAssigned(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - Unit#UNIT - -PROCESS_ASSIGN_ACCEPT.ProcessUnit - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -PROCESS_ASSIGN_ACCEPT.TargetZone - -
-
- - - -
-
-
-
- - Task#TASK_BASE - -PROCESS_ASSIGN_ACCEPT.Task - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_ACCEPT.TaskBriefing - -
-
- - - -
-
- -

Type PROCESS_ASSIGN_MENU_ACCEPT

- -

PROCESSASSIGNMENU_ACCEPT class

- -

Field(s)

-
-
- - #string - -PROCESS_ASSIGN_MENU_ACCEPT.ClassName - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_MENU_ACCEPT.Fsm - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_MENU_ACCEPT.Menu - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_MENU_ACCEPT.MenuAcceptTask - -
-
- - - -
-
-
-
- - -PROCESS_ASSIGN_MENU_ACCEPT:MenuAssign() - -
-
- -

Menu function.

- -
-
-
-
- - -PROCESS_ASSIGN_MENU_ACCEPT:MenuReject() - -
-
- -

Menu function.

- -
-
-
-
- - - -PROCESS_ASSIGN_MENU_ACCEPT.MenuRejectTask - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_MENU_ACCEPT.MenuText - -
-
- - - -
-
-
-
- - -PROCESS_ASSIGN_MENU_ACCEPT:New(Task, Unit, ProcessUnit, TaskBriefing) - -
-
- -

Creates a new task assignment state machine.

- - -

The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.

- -

Parameters

-
    -
  • - -

    Task#TASK Task :

    - -
    • -
  • - -

    Unit#UNIT Unit :

    - -
    • -
  • - -

    ProcessUnit :

    - -
    • -
  • - -

    TaskBriefing :

    - -
    • -
-

Return value

- -

#PROCESSASSIGNMENU_ACCEPT: -self

- -
-
-
-
- - -PROCESS_ASSIGN_MENU_ACCEPT:OnAssign(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - -PROCESS_ASSIGN_MENU_ACCEPT:OnReject(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - -PROCESS_ASSIGN_MENU_ACCEPT:OnStart(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - Unit#UNIT - -PROCESS_ASSIGN_MENU_ACCEPT.ProcessUnit - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -PROCESS_ASSIGN_MENU_ACCEPT.TargetZone - -
-
- - - -
-
-
-
- - Task#TASK_BASE - -PROCESS_ASSIGN_MENU_ACCEPT.Task - -
-
- - - -
-
-
-
- - - -PROCESS_ASSIGN_MENU_ACCEPT.TaskBriefing - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/Task_Client_Menu.html b/Moose Training/Documentation/Task_Client_Menu.html deleted file mode 100644 index 5fd5fc3d4..000000000 --- a/Moose Training/Documentation/Task_Client_Menu.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Task_Client_Menu

- - - -

Global(s)

- - - - - -
TASK2_MENU_CLIENT - -
-

Type TASK2_MENU_CLIENT

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TASK2_MENU_CLIENT.ClassName - -
TASK2_MENU_CLIENT.Fsm - -
TASK2_MENU_CLIENT.Menu - -
TASK2_MENU_CLIENT:MenuAssign() -

Menu function.

-
TASK2_MENU_CLIENT.MenuTask - -
TASK2_MENU_CLIENT.MenuText - -
TASK2_MENU_CLIENT:New(Mission, TaskUnit, MenuText) -

Creates a new MENU handling machine.

-
TASK2_MENU_CLIENT:OnAssign(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
TASK2_MENU_CLIENT:OnMenu(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
TASK2_MENU_CLIENT.TargetSet - -
TASK2_MENU_CLIENT.TaskUnit - -
- -

Global(s)

-
-
- - #TASK2_MENU_CLIENT - -TASK2_MENU_CLIENT - -
-
- - - -
-
-

Type Task_Client_Menu

- -

Type TASK2_MENU_CLIENT

- -

TASK2MENUCLIENT class

- -

Field(s)

-
-
- - #string - -TASK2_MENU_CLIENT.ClassName - -
-
- - - -
-
-
-
- - - -TASK2_MENU_CLIENT.Fsm - -
-
- - - -
-
-
-
- - - -TASK2_MENU_CLIENT.Menu - -
-
- - - -
-
-
-
- - -TASK2_MENU_CLIENT:MenuAssign() - -
-
- -

Menu function.

- -
-
-
-
- - Core.Menu#MENU_CLIENT_COMMAND - -TASK2_MENU_CLIENT.MenuTask - -
-
- - - -
-
-
-
- - - -TASK2_MENU_CLIENT.MenuText - -
-
- - - -
-
-
-
- - -TASK2_MENU_CLIENT:New(Mission, TaskUnit, MenuText) - -
-
- -

Creates a new MENU handling machine.

- -

Parameters

- -

Return value

- -

#TASK2MENUCLIENT: -self

- -
-
-
-
- - -TASK2_MENU_CLIENT:OnAssign(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

-
    -
  • - -

    Core.Fsm#FSM_TASK Fsm :

    - -
    • -
  • - -

    #string Event :

    - -
    • -
  • - -

    #string From :

    - -
    • -
  • - -

    #string To :

    - -
    • -
-
-
-
-
- - -TASK2_MENU_CLIENT:OnMenu(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

-
    -
  • - -

    Core.Fsm#FSM_TASK Fsm :

    - -
    • -
  • - -

    #string Event :

    - -
    • -
  • - -

    #string From :

    - -
    • -
  • - -

    #string To :

    - -
    • -
-
-
-
-
- - Core.Set#SET_UNIT - -TASK2_MENU_CLIENT.TargetSet - -
-
- - - -
-
-
-
- - Wrapper.Unit#UNIT - -TASK2_MENU_CLIENT.TaskUnit - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/Task_Route.html b/Moose Training/Documentation/Task_Route.html deleted file mode 100644 index 9b4d7f746..000000000 --- a/Moose Training/Documentation/Task_Route.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module Task_Route

- - - -

Global(s)

- - - - - -
PROCESS_ROUTE - -
-

Type PROCESS_ROUTE

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PROCESS_ROUTE.ClassName - -
PROCESS_ROUTE.DisplayCategory - -
PROCESS_ROUTE.DisplayCount - -
PROCESS_ROUTE.DisplayInterval - -
PROCESS_ROUTE.DisplayMessage - -
PROCESS_ROUTE.DisplayTime - -
PROCESS_ROUTE.Fsm - -
PROCESS_ROUTE:New(Task, Unit, ProcessUnit, TargetZone) -

Creates a new routing state machine.

-
PROCESS_ROUTE:OnLeaveUnArrived(Fsm, Event, From, To) -

StateMachine callback function for a TASK2

-
PROCESS_ROUTE.ProcessUnit - -
PROCESS_ROUTE.TASK - -
PROCESS_ROUTE.TargetZone - -
- -

Global(s)

-
-
- - #PROCESS_ROUTE - -PROCESS_ROUTE - -
-
- - - -
-
-

Type Task_Route

- -

Type PROCESS_ROUTE

- -

PROCESS_ROUTE class

- -

Field(s)

-
-
- - #string - -PROCESS_ROUTE.ClassName - -
-
- - - -
-
-
-
- - #string - -PROCESS_ROUTE.DisplayCategory - -
-
- - - - -

Route is the default display category

- -
-
-
-
- - #number - -PROCESS_ROUTE.DisplayCount - -
-
- - - -
-
-
-
- - #number - -PROCESS_ROUTE.DisplayInterval - -
-
- - - -
-
-
-
- - #boolean - -PROCESS_ROUTE.DisplayMessage - -
-
- - - -
-
-
-
- - #number - -PROCESS_ROUTE.DisplayTime - -
-
- - - - -

10 seconds is the default

- -
-
-
-
- - - -PROCESS_ROUTE.Fsm - -
-
- - - -
-
-
-
- - -PROCESS_ROUTE:New(Task, Unit, ProcessUnit, TargetZone) - -
-
- -

Creates a new routing state machine.

- - -

The task will route a CLIENT to a ZONE until the CLIENT is within that ZONE.

- -

Parameters

-
    -
  • - -

    Task#TASK Task :

    - -
    • -
  • - -

    Unit#UNIT Unit :

    - -
    • -
  • - -

    ProcessUnit :

    - -
    • -
  • - -

    TargetZone :

    - -
    • -
-

Return value

- -

#PROCESS_ROUTE: -self

- -
-
-
-
- - -PROCESS_ROUTE:OnLeaveUnArrived(Fsm, Event, From, To) - -
-
- -

StateMachine callback function for a TASK2

- -

Parameters

- -
-
-
-
- - Unit#UNIT - -PROCESS_ROUTE.ProcessUnit - -
-
- - - -
-
-
-
- - Task#TASK - -PROCESS_ROUTE.TASK - -
-
- - - -
-
-
-
- - Zone#ZONE_BASE - -PROCESS_ROUTE.TargetZone - -
-
- - - -
-
- -
- -
- - diff --git a/Moose Training/Documentation/TrackHits.html b/Moose Training/Documentation/TrackHits.html deleted file mode 100644 index 806370aa5..000000000 --- a/Moose Training/Documentation/TrackHits.html +++ /dev/null @@ -1,776 +0,0 @@ - - - - - - -
-
- -
-
-
-
- -
-

Module TrackHits

- -

(SP) (MP) (FSM) Detect, count and report successful hits to DCS objects.

- - - -
- -

#ACCOUNT FSM class, extends Process#PROCESS

-

The #ACCOUNT_DEADS class detects, counts and reports successful hits to DCS objects. -The process is given a Set of units that will be tracked upon successful destruction. -The process will end after each target has been successfully destroyed. -Each successful destruction will trigger a status change.

- -

1.1) ACCOUNT_DEADS constructor:

- - - -

1.2) ACCOUNT state machine:

-

The ACCOUNT is a state machine: it manages the different events and states of the Controllable it is controlling.

- -

1.2.1) ACCOUNT Events:

- -

Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions to occur in the process. -There are two types of event methods:

- -
    -
  • Immediate: The event method has exactly the name of the event.
    • -
  • Delayed: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed.
    • -
- -

These are the events defined in this class:

- -
    -
  • Start: The process is started. The process will go into the Waiting state.
    • -
  • Event: A relevant event has occured that needs to be accounted for. The process will go into the Account state.
    • -
  • More: There are more DCS events that need to be accounted for. The process will go back into the Waiting state.
    • -
  • NoMore: There are no more DCS events that need to be accounted for. The process will go into the Success state.
    • -
- -

1.2.2) ACCOUNT States:

- -
    -
  • Assigned: The player is assigned to the task. This is the initialization state for the process.
    • -
  • Waiting: The process is awaiting an DCS event to occur within the simulator. This event is called automatically every 1 second.
    • -
  • Account: The relevant DCS event has occurred, and is accounted for.
    • -
  • Success (*): All DCS events were accounted for.
    • -
  • Failed (*): The process has failed.
    • -
- -

(*) End states of the process.

- -

1.2.3) ACCOUNT_DEADS state transition functions:

- -

State transition functions can be set by the mission designer customizing or improving the behaviour of the state. -There are 2 moments when state transition functions will be called by the state machine:

- -
    -

  • Before the state transition. - The state transition function needs to start with the name OnBefore + the name of the state. - If the state transition function returns false, then the processing of the state transition will not be done! - If you want to change the behaviour of the AIControllable at this event, return false, - but then you'll need to specify your own logic using the AIControllable!

    • -

  • After the state transition. - The state transition function needs to start with the name OnAfter + the name of the state. - These state transition functions need to provide a return value, which is specified at the function description.

    • -
- -

1.3) Manage the ACCOUNT_DEADS parameters:

-

The following methods are available to modify the parameters of a ACCOUNT_DEADS object:

- - - - -

Global(s)

- - - - - -
ACCOUNT_DEADS - -
-

Type ACCOUNT_DEADS

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ACCOUNT_DEADS.ClassName - -
ACCOUNT_DEADS.DisplayCategory - -
ACCOUNT_DEADS.DisplayCount - -
ACCOUNT_DEADS.DisplayInterval - -
ACCOUNT_DEADS.DisplayMessage - -
ACCOUNT_DEADS.DisplayTime - -
ACCOUNT_DEADS:EventDead(Event) - -
ACCOUNT_DEADS.Fsm - -
ACCOUNT_DEADS:New(ProcessUnit, TargetSetUnit, TaskName) -

Creates a new DESTROY process.

-
ACCOUNT_DEADS:OnDestroyed(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS:OnHitTarget(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS:OnKilled(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS:OnMoreTargets(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS:OnRestart(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS:OnStart(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS:OnWaiting(ProcessUnit, Event, From, To) -

StateMachine callback function

-
ACCOUNT_DEADS.TargetSetUnit - -
ACCOUNT_DEADS.TaskName - -
- -

Type ASSIGN_MENU_ACCEPT

- - - - - -
ASSIGN_MENU_ACCEPT.DisplayCount - -
- -

Global(s)

-
-
- - #ACCOUNT_DEADS - -ACCOUNT_DEADS - -
-
- - - -
-
-

Type TrackHits

- -

Type ACCOUNT_DEADS

- -

ACCOUNT_DEADS class

- -

Field(s)

-
-
- - #string - -ACCOUNT_DEADS.ClassName - -
-
- - - -
-
-
-
- - #string - -ACCOUNT_DEADS.DisplayCategory - -
-
- - - - -

Targets is the default display category

- -
-
-
-
- - #number - -ACCOUNT_DEADS.DisplayCount - -
-
- - - -
-
-
-
- - #number - -ACCOUNT_DEADS.DisplayInterval - -
-
- - - -
-
-
-
- - #boolean - -ACCOUNT_DEADS.DisplayMessage - -
-
- - - -
-
-
-
- - #number - -ACCOUNT_DEADS.DisplayTime - -
-
- - - - -

10 seconds is the default

- -
-
-
-
- - -ACCOUNT_DEADS:EventDead(Event) - -
-
- - - -

Parameter

- -
-
-
-
- - - -ACCOUNT_DEADS.Fsm - -
-
- - - -
-
-
-
- - -ACCOUNT_DEADS:New(ProcessUnit, TargetSetUnit, TaskName) - -
-
- -

Creates a new DESTROY process.

- -

Parameters

- -

Return value

- -

#ACCOUNT_DEADS: -self

- -
-
-
-
- - -ACCOUNT_DEADS:OnDestroyed(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - -ACCOUNT_DEADS:OnHitTarget(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - -ACCOUNT_DEADS:OnKilled(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - -ACCOUNT_DEADS:OnMoreTargets(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - -ACCOUNT_DEADS:OnRestart(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - -ACCOUNT_DEADS:OnStart(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - -ACCOUNT_DEADS:OnWaiting(ProcessUnit, Event, From, To) - -
-
- -

StateMachine callback function

- -

Parameters

- -
-
-
-
- - Set#SET_UNIT - -ACCOUNT_DEADS.TargetSetUnit - -
-
- - - -
-
-
-
- - - -ACCOUNT_DEADS.TaskName - -
-
- - - -
-
- -

Type ASSIGN_MENU_ACCEPT

-

Field(s)

-
-
- - #number - -ASSIGN_MENU_ACCEPT.DisplayCount - -
-
- - - -
-
- -
- -
- - diff --git a/README.md b/README.md new file mode 100644 index 000000000..199db6fef --- /dev/null +++ b/README.md @@ -0,0 +1,168 @@ +# Context + +MOOSE is a **M**ission **O**bject **O**riented **S**cripting **E**nvironment, and is meant for mission designers and mission hosters. +It allows to quickly setup complex missions using pre-scripted scenarios using the available classes within the MOOSE Framework. +MOOSE is currently still in alpha version, but will evolve over time. Right now, it has been updated to work with DCS world 1.5. and 2.0. + +You can find the source of MOOSE here on GITHUB. It is free for download: +https://github.com/FlightControl-Master/MOOSE/ + +Note: MOOSE is complementary to [MIST](https://github.com/mrSkortch/MissionScriptingTools/releases), so if you use MIST in parallel with MOOSE objects, this should work. + +# Goals + +The goal of MOOSE is to allow mission designers to enhance their scripting with mission orchestration objects, which can be instantiated from defined classes within the framework. This will allow to write mission scripts with minimal code embedded. Of course, the richness of the framework will determine the richness of the misson scenarios. We can expect that MOOSE will evolve over time, as more missions will be designed within the framework. + +# MOOSE Directory Structure + +* Moose Development: Contains the collection of lua files that define the MOOSE classes. You can use this directory to build the dynamic luadoc documentation intellisense in your eclipse development environment. +* Moose Mission Setup: Contains the Moose.lua file to be included in your scripts when using MOOSE classes (see below the point Mission Design with Moose). +* Moose Test Missions: Contains a directory structure with Moose Test Missions and examples. In each directory, you will find a miz file and a lua file containing the main mission script. +* Moose Training: Contains the documentation of Moose generated with luadoc from the Moose source code. The presentations used during the videos in my [youtube channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg), are also to be found here. + +# Mission Design with Moose + +In order to create a mission using MOOSE, you'll have to include a file named **Moose.lua**: + +1. Create a new mission in the DCS World Mission Editor. +2. In the mission editor, create a new trigger. +3. Name the trigger Moose Load and let it execute only at MISSION START. +4. Add an action DO SCRIPT FILE (without a condition, so the middle column must be empty). +5. In the action, browse to the **[Moose.lua](https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Mission%20Setup)** file in the **Moose Mission Setup** directory, and include this file within your mission. +6. Make sure that the "Moose Load" trigger is completely at the top of your mission. + +Voila, MOOSE is now included in your mission. During the execution of this mission, all MOOSE classes will be loaded, and all MOOSE initializations will be exectuted before any other mission action is executed. + +IMPORTANT NOTE: When a new version of MOOSE is released, you'll have to UPDATE the Moose.lua file in EACH OF YOUR MISSION. +This can be a tedious task, and for this purpose, a tool has been developed that will update the Moose.lua files automatically within your missions. +Refer to the tool at [Moose Mission Setup\Moose Mission Update](https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Mission%20Setup/Moose%20Mission%20Update) directory for further information included in the [READ.ME]() file. + + +# MOOSE Classes + +The following classes are currently embedded within MOOSE and can be included within your mission scripts: + +## MOOSE Core Classes + +These classes define the base building blocks of the MOOSE framework. These classes are heavily used within the MOOSE framework. + +* [BASE](Documentation/Base.html): The main class from which all MOOSE classes are derived from. The BASE class contains essential functions to support inheritance and MOOSE object execution tracing (logging within the DCS.log file in the saved games folder of the user). + +* [DATABASE](Documentation/Database.html): Creates a collection of GROUPS[], UNITS[], CLIENTS[] and managed these sets automatically. Provides an API set to retrieve a GROUP, UNIT or CLIENT instance from the _DATABASE object using defined APIs. The collections are maintained dynamically during the execution of the mission, so when players join, leave, when units are created or destroyed, the collections are dynamically updated. + +* [EVENT](Documentation/Event.html): Provides the Event Dispatcher base class to handle DCS Events, being fired upon registered events within the DCS simulator. Note that EVENT is used by BASE, exposing OnEvent() methods to catch these DCS events. + +* [FSM](Documentation/Fsm.html): The main FSM class can be used to build a Finite State Machine. The derived FSM_ classes provide Finite State Machine building capability for CONTROLLABLEs, ACT_ (Task Actions) classes, TASKs and SETs. + +* [MENU](Documentation/Menu.html): Set Menu options (F10) for All Players, Coalitions, Groups, Clients. MENU also manages the recursive removal of menus, which is a big asset! + +* [SETS](Documentation/Set.html): Create SETs of MOOSE objects. SETs can be created for GROUPs, UNITs, AIRBASEs, ... +The SET can be filtered with defined filter criteria. +Iterators are available that iterate through the GROUPSET, calling a function for each object within the SET. + +* [MESSAGE](Documentation/Message.html): A message publishing system, displaying messages to Clients, Coalitions or All players. + +* [POINTS](Documentation/Point.html): A set of point classes to manage the 2D or 3D simulation space, through an extensive method library. +The POINT_VEC3 class manages the 3D simulation space, while the POINT_VEC2 class manages the 2D simulation space. + +* [ZONES](Documentation/Zone.html): A set of zone classes that provide the functionality to validate the presence of GROUPS, UNITS, CLIENTS, STATICS within a certain ZONE. The zones can take various forms and can be movable. + +* [SCHEDULER](Documentation/Scheduler.html): This class implements a timer scheduler that will call at optional specified intervals repeatedly or just one time a scheduled function. + + +## MOOSE Wrapper Classes + +MOOSE Wrapper Classes provide an object oriented hierarchical mechanism to manage the DCS objects within the simulator. +Wrapper classes provide another easier mechanism to control Groups, Units, Statics, Airbases and other objects. + +* **[OBJECT](Documentation/Object.html)**: This class provides the base for MOOSE objects. + +* **[IDENTIFIABLE](Documentation/Identifiable.html)**: This class provides the base for MOOSE identifiable objects, which is every object within the simulator :-). + +* **[POSITIONABLE](Documentation/Positionable.html)**: This class provides the base for MOOSE positionable objects. These are AIRBASEs, STATICs, GROUPs, UNITs ... + +* **[CONTROLLABLE](Documentation/Controllable.html)**: This class provides the base for MOOSE controllable objects. These are GROUPs, UNITs, CLIENTs. + +* **[AIRBASE](Documentation/Airbase.html)**: This class wraps a DCS Airbase object within the simulator. + +* **[GROUP](Documentation/Group.html)**: This class wraps a DCS Group objects within the simulator, which are currently alive. +It provides a more extensive API set. +It takes an abstraction of the complexity to give tasks, commands and set various options to DCS Groups. +Additionally, the GROUP class provides a much richer API to identify various properties of the DCS Group. +For each DCS Group created object within a running mission, a GROUP object will be created automatically, beging managed within the DATABASE. + +* **[UNIT](Documentation/Unit.html)**: This class wraps a DCS Unit object within the simulator, which are currently alive. It provides a more extensive API set, as well takes an abstraction of the complexity to give commands and set various options to DCS Units. Additionally, the UNIT class provides a much richer API to identify various properties of the DCS Unit. For each DCS Unit object created within a running mission, a UNIT object will be created automatically, that is stored within the DATABASE, under the _DATABASE object. +the UNIT class provides a more extensive API set, taking an abstraction of the complexity to give tasks, commands and set various options to DCS Units. +For each DCS Unit created object within a running mission, a UNIT object will be created automatically, beging managed within the DATABASE. + +* **[CLIENT](Documentation/Client.html)**: This class wraps a DCS Unit object within the simulator, which has a skill Client or Player. +The CLIENT class derives from the UNIT class, thus contains the complete UNIT API set, and additionally, the CLIENT class provides an API set to manage players joining or leaving clients, sending messages to players, and manage the state of units joined by players. For each DCS Unit object created within a running mission that can be joined by a player, a CLIENT object will be created automatically, that is stored within the DATABASE, under the _DATABASE object. + +* **[STATIC](Documentation/Static.html)**: This class wraps a DCS StaticObject object within the simulator. +The STATIC class derives from the POSITIONABLE class, thus contains also the position API set. + + +## MOOSE Functional Classes + +* [SPAWN](Documentation/Spawn.html): Spawn new groups (and units) during mission execution. + +* [ESCORT](Moose Training/Documentation/Escort.html): Makes groups consisting of helicopters, airplanes, ground troops or ships within a mission joining your flight. You can control these groups through the ratio menu during your flight. Available commands are around: Navigation, Position Hold, Reporting (Target Detection), Attacking, Assisted Attacks, ROE, Evasion, Mission Execution and more ... + +* [MISSILETRAINER](Moose Training/Documentation/MissileTrainer.html): Missile trainer, it destroys missiles when they are within a certain range of player airplanes, displays tracking and alert messages of missile launches; approach; destruction, and configure with radio menu commands. Various APIs available to configure the trainer. + +* [DETECTION](Moose Training/Documentation/Detection.html): Detect other units using the available sensors of the detection unit. The DETECTION_BASE derived classes will provide different methods how the sets of detected objects are built. + +## MOOSE AI Controlling Classes + +* [AI_BALANCER](Documentation/AI_Balancer.html): Compensate in a multi player mission the abscence of players with dynamically spawned AI air units. When players join CLIENTS, the AI will either be destroyed, or will fly back to the home or nearest friendly airbase. + +* [AI_PATROLZONE](Documentation/AI_PatrolZone.html): Make an alive AI Group patrol a zone derived from the ZONE_BASE class. Manage out-of-fuel events and set altitude and speed ranges for the patrol. + +* [FAC](Moose Training/Documentation/Fac.html): Using the DETECTION_BASE derived classes, detected objects can be reported in different ways to a set of clients (SET_CLIENT). FAC_BASE derived classes will provide target detection reporting and control using the radio menu. + +* [FOLLOW](Moose Training/Documentation/Follow.html): Build large air formations using the FOLLOW class. + +# MOOSE Tutorials and Examples + +You can download [test missions](https://github.com/FlightControl-Master/MOOSE/tree/master/Test%20Missions) to have examples and learn the syntax and usage of the MOOSE classes. + +There are [Video Tutorials](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg) on my YOUTUBE channel on which you can learn some coding aspects with mission execution demos, as well as some of the tooling and internal mechanisms within MOOSE. + + +In the triggers section, there is a flag (9999) that will decide how MOOSE will be loaded. When flag 9999 is set, MOOSE will be dynamically loaded. When flag 9999 is off, MOOSE will be loaded embedded. Note that when loaded embedded, **your mission must include the last Moose_Embedded.lua file**. So, ensure that the last file is included in the DO SCRIPT section when MOOSE got an update! + +# Credits + +Note that the framework is based on code i've written myself, but some of it is also based on code that i've seen as great scripting code and ideas, and which i've revised. I see this framework evolving towards a broader public, and the ownership may dissapear (or parts of it). Consider this code public domain. Therefore a list of credits to all who have or are contributing (this list will increase over time): Grimes, Prof_Hilactic, xcom, the 476 virtual squadron team, ... + +You'll notice that within this framework, there are functions used from mist. I've taken the liberty to copy those atomic mist functions that are very nice and useful, and used those. + +**Grimes** +Without the effort of Grimes with MIST and his continuous documentation, the development of MOOSE would not have been possible. MOOSE is not replacing MIST, but is compensating it. + +**Prof_hilactic** +SEAD Defenses. I've taken the script, and reworded it to fit within MOOSE. The script within MOOSE is hardly recognizable anymore from the original. Find here the posts: http://forums.eagle.ru/showpost.php?...59&postcount=1 + +**xcom** +His contribution is related to the Event logging system. I've analyzed and studied his scripts, and reworked it a bit to use it also within the framework (I've also tweaked it a bit). Find his post here: http://forums.eagle.ru/showpost.php?...73&postcount=1 + +**Dutch_Baron (James)** +Working together with James has resulted in the creation of the AIBALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) + +**Stuka (Danny)** +Working together with Danny has resulted in the MISSILETRAINER class. Stuka has shared his ideas and together we made a design. Together with the 476 virtual team, we tested this CLASS, and got much positive feedback! + +**Mechanic (G�bor)** +Worked together with G�bor to create the concept of the DETECTION and FAC classes. Mechanic shared his ideas and concepts to group detected targets into sets within detection zones... Will continue to work with G�bor to workout the DETECTION and FAC classes. + +**Shadoh** +Interacted on the eagle dynamics forum to build the FOLLOW class to build large WWII airplane formations. + +For the rest I also would like to thank the numerous feedback and help and assistance of the moose community at SLACK.COM. +Note that there is a vast amount of other scripts out there. +I may contact you personally to ask for your contribution / permission if i can use your idea or script to tweak it to the framework. +Parts of these scripts will have to be redesigned to fit it into an OO framework. + +The rest of the framework functions and class definitions were my own developments, especially the core of MOOSE. +Trust I've spent hours and hours investigating, trying and writing and documenting code building this framework. +Hope you think the idea is great and useful. diff --git a/Moose Training/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html similarity index 99% rename from Moose Training/Documentation/AI_Balancer.html rename to docs/Documentation/AI_Balancer.html index 95bdbfe1c..100b89b58 100644 --- a/Moose Training/Documentation/AI_Balancer.html +++ b/docs/Documentation/AI_Balancer.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Account.html b/docs/Documentation/Account.html similarity index 99% rename from Moose Training/Documentation/Account.html rename to docs/Documentation/Account.html index c7fd789ae..d4f25f391 100644 --- a/Moose Training/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Airbase.html b/docs/Documentation/Airbase.html similarity index 99% rename from Moose Training/Documentation/Airbase.html rename to docs/Documentation/Airbase.html index 466ac9524..67972f788 100644 --- a/Moose Training/Documentation/Airbase.html +++ b/docs/Documentation/Airbase.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html similarity index 99% rename from Moose Training/Documentation/AirbasePolice.html rename to docs/Documentation/AirbasePolice.html index 5a8018037..3ba45883b 100644 --- a/Moose Training/Documentation/AirbasePolice.html +++ b/docs/Documentation/AirbasePolice.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Assign.html b/docs/Documentation/Assign.html similarity index 99% rename from Moose Training/Documentation/Assign.html rename to docs/Documentation/Assign.html index 44c1d0ace..d8fe72d3e 100644 --- a/Moose Training/Documentation/Assign.html +++ b/docs/Documentation/Assign.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Base.html b/docs/Documentation/Base.html similarity index 99% rename from Moose Training/Documentation/Base.html rename to docs/Documentation/Base.html index f195dd998..762c164fd 100644 --- a/Moose Training/Documentation/Base.html +++ b/docs/Documentation/Base.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/CARGO.html b/docs/Documentation/Cargo.html similarity index 99% rename from Moose Training/Documentation/CARGO.html rename to docs/Documentation/Cargo.html index 7aa7c873b..90fca6bc1 100644 --- a/Moose Training/Documentation/CARGO.html +++ b/docs/Documentation/Cargo.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -2428,7 +2427,6 @@ The UNIT carrying the package.

    - AI_CARGO_UNIT.CargoCarrier diff --git a/Moose Training/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html similarity index 99% rename from Moose Training/Documentation/CleanUp.html rename to docs/Documentation/CleanUp.html index ae98a5943..321d53fb1 100644 --- a/Moose Training/Documentation/CleanUp.html +++ b/docs/Documentation/CleanUp.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Client.html b/docs/Documentation/Client.html similarity index 99% rename from Moose Training/Documentation/Client.html rename to docs/Documentation/Client.html index 3723140d2..76b67e040 100644 --- a/Moose Training/Documentation/Client.html +++ b/docs/Documentation/Client.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html similarity index 96% rename from Moose Training/Documentation/CommandCenter.html rename to docs/Documentation/CommandCenter.html index 90d69a35b..6557fc9bd 100644 --- a/Moose Training/Documentation/CommandCenter.html +++ b/docs/Documentation/CommandCenter.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -180,7 +179,7 @@ - COMMANDCENTER:MessageToGroup(Message, TaskGroup) + COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name)

    Send a CC message to a GROUP.

    @@ -506,7 +505,7 @@ Group#GROUP

    -COMMANDCENTER:MessageToGroup(Message, TaskGroup) +COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name)
    @@ -517,12 +516,18 @@ Group#GROUP

    • -

      Message :

      +

      #string Message :

    • -

      TaskGroup :

      +

      Wrapper.Group#GROUP TaskGroup :

      + +
      • +
    • + +

      #sring Name : +(optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.

    @@ -758,6 +763,8 @@ Group#GROUP

    Type list

    +

    Type sring

    +
    diff --git a/Moose Training/Documentation/Controllable.html b/docs/Documentation/Controllable.html similarity index 99% rename from Moose Training/Documentation/Controllable.html rename to docs/Documentation/Controllable.html index 3d98f7051..2b73fa9da 100644 --- a/Moose Training/Documentation/Controllable.html +++ b/docs/Documentation/Controllable.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html similarity index 99% rename from Moose Training/Documentation/DCSAirbase.html rename to docs/Documentation/DCSAirbase.html index 64f947428..d47a0d2d4 100644 --- a/Moose Training/Documentation/DCSAirbase.html +++ b/docs/Documentation/DCSAirbase.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html similarity index 99% rename from Moose Training/Documentation/DCSCoalitionObject.html rename to docs/Documentation/DCSCoalitionObject.html index 1b5de15ff..b1b40e8b0 100644 --- a/Moose Training/Documentation/DCSCoalitionObject.html +++ b/docs/Documentation/DCSCoalitionObject.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html similarity index 98% rename from Moose Training/Documentation/DCSCommand.html rename to docs/Documentation/DCSCommand.html index 4cbd74065..50c815ce8 100644 --- a/Moose Training/Documentation/DCSCommand.html +++ b/docs/Documentation/DCSCommand.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSController.html b/docs/Documentation/DCSController.html similarity index 99% rename from Moose Training/Documentation/DCSController.html rename to docs/Documentation/DCSController.html index a5eeb2d71..3b87c815f 100644 --- a/Moose Training/Documentation/DCSController.html +++ b/docs/Documentation/DCSController.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html similarity index 99% rename from Moose Training/Documentation/DCSGroup.html rename to docs/Documentation/DCSGroup.html index 67e0d6d8d..f5a439f32 100644 --- a/Moose Training/Documentation/DCSGroup.html +++ b/docs/Documentation/DCSGroup.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html similarity index 99% rename from Moose Training/Documentation/DCSObject.html rename to docs/Documentation/DCSObject.html index 72238f7e0..dc35705a3 100644 --- a/Moose Training/Documentation/DCSObject.html +++ b/docs/Documentation/DCSObject.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html similarity index 98% rename from Moose Training/Documentation/DCSTask.html rename to docs/Documentation/DCSTask.html index 6180e672b..bd8d1c071 100644 --- a/Moose Training/Documentation/DCSTask.html +++ b/docs/Documentation/DCSTask.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html similarity index 99% rename from Moose Training/Documentation/DCSTypes.html rename to docs/Documentation/DCSTypes.html index 99b096eb3..eac8cf3fe 100644 --- a/Moose Training/Documentation/DCSTypes.html +++ b/docs/Documentation/DCSTypes.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html similarity index 99% rename from Moose Training/Documentation/DCSUnit.html rename to docs/Documentation/DCSUnit.html index f6fb63392..d5f785b48 100644 --- a/Moose Training/Documentation/DCSUnit.html +++ b/docs/Documentation/DCSUnit.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html similarity index 99% rename from Moose Training/Documentation/DCSWorld.html rename to docs/Documentation/DCSWorld.html index b5410c686..204ed66c2 100644 --- a/Moose Training/Documentation/DCSWorld.html +++ b/docs/Documentation/DCSWorld.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html similarity index 99% rename from Moose Training/Documentation/DCScountry.html rename to docs/Documentation/DCScountry.html index 030327afe..671fb9887 100644 --- a/Moose Training/Documentation/DCScountry.html +++ b/docs/Documentation/DCScountry.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html similarity index 99% rename from Moose Training/Documentation/DCStimer.html rename to docs/Documentation/DCStimer.html index 2a22ff28a..2c30988a4 100644 --- a/Moose Training/Documentation/DCStimer.html +++ b/docs/Documentation/DCStimer.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html similarity index 98% rename from Moose Training/Documentation/DCStrigger.html rename to docs/Documentation/DCStrigger.html index 9ffca8c0d..a6617cd23 100644 --- a/Moose Training/Documentation/DCStrigger.html +++ b/docs/Documentation/DCStrigger.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Database.html b/docs/Documentation/Database.html similarity index 99% rename from Moose Training/Documentation/Database.html rename to docs/Documentation/Database.html index 68a700372..79b6817d5 100644 --- a/Moose Training/Documentation/Database.html +++ b/docs/Documentation/Database.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Detection.html b/docs/Documentation/Detection.html similarity index 99% rename from Moose Training/Documentation/Detection.html rename to docs/Documentation/Detection.html index 43c5617c1..e3bdab022 100644 --- a/Moose Training/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Escort.html b/docs/Documentation/Escort.html similarity index 99% rename from Moose Training/Documentation/Escort.html rename to docs/Documentation/Escort.html index e1bb39110..5741ba4bd 100644 --- a/Moose Training/Documentation/Escort.html +++ b/docs/Documentation/Escort.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Event.html b/docs/Documentation/Event.html similarity index 99% rename from Moose Training/Documentation/Event.html rename to docs/Documentation/Event.html index 9ef6db666..534b6412e 100644 --- a/Moose Training/Documentation/Event.html +++ b/docs/Documentation/Event.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Fsm.html b/docs/Documentation/Fsm.html similarity index 99% rename from Moose Training/Documentation/Fsm.html rename to docs/Documentation/Fsm.html index 42fe68623..0b08c42d6 100644 --- a/Moose Training/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Group.html b/docs/Documentation/Group.html similarity index 99% rename from Moose Training/Documentation/Group.html rename to docs/Documentation/Group.html index 88be1ab7b..f258edf15 100644 --- a/Moose Training/Documentation/Group.html +++ b/docs/Documentation/Group.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -273,6 +272,12 @@ Use the following Zone validation methods on the group:

    GROUP:AllOnGround()

    Returns if all units of the group are on the ground or landed.

    + + + + GROUP:CalculateThreatLevelA2G() + +

    Calculate the maxium A2G threat level of the Group.

    @@ -579,6 +584,19 @@ Use the following Zone validation methods on the group:

    #boolean: All units on the ground result.

    + + +
    +
    + + +GROUP:CalculateThreatLevelA2G() + +
    +
    + +

    Calculate the maxium A2G threat level of the Group.

    +
    diff --git a/Moose Training/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html similarity index 95% rename from Moose Training/Documentation/Identifiable.html rename to docs/Documentation/Identifiable.html index 9ae5d9b8c..95e500f12 100644 --- a/Moose Training/Documentation/Identifiable.html +++ b/docs/Documentation/Identifiable.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -136,6 +135,12 @@ IDENTIFIABLE.ClassName + + + + IDENTIFIABLE:GetCallsign() + +

    Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

    @@ -234,6 +239,24 @@ + +
    +
    +
    + + +IDENTIFIABLE:GetCallsign() + +
    +
    + +

    Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

    + +

    Return value

    + +

    #string: +The CallSign of the IDENTIFIABLE.

    +
    diff --git a/Moose Training/Documentation/MOVEMENT.html b/docs/Documentation/MOVEMENT.html similarity index 99% rename from Moose Training/Documentation/MOVEMENT.html rename to docs/Documentation/MOVEMENT.html index 13e5d0dfb..4b01f546a 100644 --- a/Moose Training/Documentation/MOVEMENT.html +++ b/docs/Documentation/MOVEMENT.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Menu.html b/docs/Documentation/Menu.html similarity index 99% rename from Moose Training/Documentation/Menu.html rename to docs/Documentation/Menu.html index 8c0552dd9..fc4b11dcc 100644 --- a/Moose Training/Documentation/Menu.html +++ b/docs/Documentation/Menu.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Message.html b/docs/Documentation/Message.html similarity index 99% rename from Moose Training/Documentation/Message.html rename to docs/Documentation/Message.html index 9a3b3c646..67087258c 100644 --- a/Moose Training/Documentation/Message.html +++ b/docs/Documentation/Message.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html similarity index 99% rename from Moose Training/Documentation/MissileTrainer.html rename to docs/Documentation/MissileTrainer.html index 586e70888..1e5374aae 100644 --- a/Moose Training/Documentation/MissileTrainer.html +++ b/docs/Documentation/MissileTrainer.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/MISSION.html b/docs/Documentation/Mission.html similarity index 99% rename from Moose Training/Documentation/MISSION.html rename to docs/Documentation/Mission.html index 5ed4fbcb6..04f83b0c9 100644 --- a/Moose Training/Documentation/MISSION.html +++ b/docs/Documentation/Mission.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -358,6 +357,12 @@ A CLIENT needs to be registered within the MISSION.REPEAT + + + + MISSION:RemoveMenu() + +

    Removes the Planned Task menu.

    @@ -415,7 +420,7 @@ A CLIENT needs to be registered within the MISSION:SetMenu(CommandCenterMenu) + MISSION:SetMenu()

    Sets the Planned Task menu.

    @@ -1562,6 +1567,19 @@ self

    + +
    +
    +
    + + +MISSION:RemoveMenu() + +
    +
    + +

    Removes the Planned Task menu.

    +
    @@ -1752,21 +1770,13 @@ self

    -MISSION:SetMenu(CommandCenterMenu) +MISSION:SetMenu()

    Sets the Planned Task menu.

    -

    Parameter

    -
    diff --git a/Moose Training/Documentation/Object.html b/docs/Documentation/Object.html similarity index 99% rename from Moose Training/Documentation/Object.html rename to docs/Documentation/Object.html index 00eff6a9b..f9ad6aa8a 100644 --- a/Moose Training/Documentation/Object.html +++ b/docs/Documentation/Object.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Patrol.html b/docs/Documentation/Patrol.html similarity index 99% rename from Moose Training/Documentation/Patrol.html rename to docs/Documentation/Patrol.html index 7743ee2b3..70b53baab 100644 --- a/Moose Training/Documentation/Patrol.html +++ b/docs/Documentation/Patrol.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Point.html b/docs/Documentation/Point.html similarity index 99% rename from Moose Training/Documentation/Point.html rename to docs/Documentation/Point.html index 589adc82b..ad3129506 100644 --- a/Moose Training/Documentation/Point.html +++ b/docs/Documentation/Point.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Positionable.html b/docs/Documentation/Positionable.html similarity index 90% rename from Moose Training/Documentation/Positionable.html rename to docs/Documentation/Positionable.html index efda60337..6612d7f12 100644 --- a/Moose Training/Documentation/Positionable.html +++ b/docs/Documentation/Positionable.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -156,7 +155,7 @@ - POSITIONABLE:GetMessage(Message, Duration) + POSITIONABLE:GetMessage(Message, Duration, Name)

    Returns a message with the callsign embedded (if there is one).

    @@ -216,43 +215,43 @@ - POSITIONABLE:Message(Message, Duration) + POSITIONABLE:Message(Message, Duration, Name)

    Send a message to the players in the Group.

    - POSITIONABLE:MessageToAll(Message, Duration) + POSITIONABLE:MessageToAll(Message, Duration, Name)

    Send a message to all coalitions.

    - POSITIONABLE:MessageToBlue(Message, Duration) + POSITIONABLE:MessageToBlue(Message, Duration, Name)

    Send a message to the blue coalition.

    - POSITIONABLE:MessageToClient(Message, Duration, Client) + POSITIONABLE:MessageToClient(Message, Duration, Client, Name)

    Send a message to a client.

    - POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition) + POSITIONABLE:MessageToCoalition(Message, Duration, Name, MessageCoalition)

    Send a message to a coalition.

    - POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup) + POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup, Name)

    Send a message to a Group.

    - POSITIONABLE:MessageToRed(Message, Duration) + POSITIONABLE:MessageToRed(Message, Duration, Name)

    Send a message to the red coalition.

    @@ -376,7 +375,7 @@ The POSTIONABLE heading

    -POSITIONABLE:GetMessage(Message, Duration) +POSITIONABLE:GetMessage(Message, Duration, Name)
    @@ -396,6 +395,12 @@ The message text

    Dcs.DCSTypes#Duration Duration : The duration of the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +

    • Return value

    @@ -669,7 +674,7 @@ The POSITIONABLE is not existing or alive.

    -POSITIONABLE:Message(Message, Duration) +POSITIONABLE:Message(Message, Duration, Name)
    @@ -692,6 +697,12 @@ The message text

    Dcs.DCSTypes#Duration Duration : The duration of the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +
    • @@ -700,7 +711,7 @@ The duration of the message.

    -POSITIONABLE:MessageToAll(Message, Duration) +POSITIONABLE:MessageToAll(Message, Duration, Name)
    @@ -723,6 +734,12 @@ The message text

    Dcs.DCSTypes#Duration Duration : The duration of the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +
    • @@ -731,7 +748,7 @@ The duration of the message.

    -POSITIONABLE:MessageToBlue(Message, Duration) +POSITIONABLE:MessageToBlue(Message, Duration, Name)
    @@ -754,6 +771,12 @@ The message text

    Dcs.DCSTypes#Duration Duration : The duration of the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +
    • @@ -762,7 +785,7 @@ The duration of the message.

    -POSITIONABLE:MessageToClient(Message, Duration, Client) +POSITIONABLE:MessageToClient(Message, Duration, Client, Name)
    @@ -791,6 +814,12 @@ The duration of the message.

    Wrapper.Client#CLIENT Client : The client object receiving the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +
    • @@ -799,7 +828,7 @@ The client object receiving the message.

    -POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition) +POSITIONABLE:MessageToCoalition(Message, Duration, Name, MessageCoalition)
    @@ -825,6 +854,12 @@ The duration of the message.

  • +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    + +
    • +
  • +

    MessageCoalition :

    • @@ -835,7 +870,7 @@ The duration of the message.

    -POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup) +POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup, Name)
    @@ -864,6 +899,12 @@ The duration of the message.

    Wrapper.Group#GROUP MessageGroup : The GROUP object receiving the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +
    • @@ -872,7 +913,7 @@ The GROUP object receiving the message.

    -POSITIONABLE:MessageToRed(Message, Duration) +POSITIONABLE:MessageToRed(Message, Duration, Name)
    @@ -895,6 +936,12 @@ The message text

    Dcs.DCSTYpes#Duration Duration : The duration of the message.

    + +
  • + +

    #string Name : +(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

    +
    • diff --git a/Moose Training/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html similarity index 99% rename from Moose Training/Documentation/Process_JTAC.html rename to docs/Documentation/Process_JTAC.html index c88e839d7..b17350670 100644 --- a/Moose Training/Documentation/Process_JTAC.html +++ b/docs/Documentation/Process_JTAC.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html similarity index 99% rename from Moose Training/Documentation/Process_Pickup.html rename to docs/Documentation/Process_Pickup.html index d6aa0dccd..818454873 100644 --- a/Moose Training/Documentation/Process_Pickup.html +++ b/docs/Documentation/Process_Pickup.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Route.html b/docs/Documentation/Route.html similarity index 99% rename from Moose Training/Documentation/Route.html rename to docs/Documentation/Route.html index 31e30ad81..14e228e65 100644 --- a/Moose Training/Documentation/Route.html +++ b/docs/Documentation/Route.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html similarity index 99% rename from Moose Training/Documentation/ScheduleDispatcher.html rename to docs/Documentation/ScheduleDispatcher.html index 4bf4c0e56..d731daee7 100644 --- a/Moose Training/Documentation/ScheduleDispatcher.html +++ b/docs/Documentation/ScheduleDispatcher.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html similarity index 99% rename from Moose Training/Documentation/Scheduler.html rename to docs/Documentation/Scheduler.html index 79b753d32..507f577b5 100644 --- a/Moose Training/Documentation/Scheduler.html +++ b/docs/Documentation/Scheduler.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Scoring.html b/docs/Documentation/Scoring.html similarity index 99% rename from Moose Training/Documentation/Scoring.html rename to docs/Documentation/Scoring.html index 5cdd4d7a0..9b00982ed 100644 --- a/Moose Training/Documentation/Scoring.html +++ b/docs/Documentation/Scoring.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Sead.html b/docs/Documentation/Sead.html similarity index 99% rename from Moose Training/Documentation/Sead.html rename to docs/Documentation/Sead.html index 663297118..7a23c59fb 100644 --- a/Moose Training/Documentation/Sead.html +++ b/docs/Documentation/Sead.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Set.html b/docs/Documentation/Set.html similarity index 99% rename from Moose Training/Documentation/Set.html rename to docs/Documentation/Set.html index 770681900..648edd701 100644 --- a/Moose Training/Documentation/Set.html +++ b/docs/Documentation/Set.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -907,6 +906,12 @@ The following iterator methods are currently available within the SETAIRBAS SET_UNIT:AddUnitsByName(AddUnitNames)

    Add UNIT(s) to SET_UNIT.

    + + + + SET_UNIT:CalculateThreatLevelA2G() + +

    Calculate the maxium A2G threat level of the SET_UNIT.

    @@ -3350,6 +3355,19 @@ A single name or an array of UNIT names.

    #SET_UNIT: self

    + +
    +
    +
    + + +SET_UNIT:CalculateThreatLevelA2G() + +
    +
    + +

    Calculate the maxium A2G threat level of the SET_UNIT.

    +
    diff --git a/Moose Training/Documentation/Smoke.html b/docs/Documentation/Smoke.html similarity index 99% rename from Moose Training/Documentation/Smoke.html rename to docs/Documentation/Smoke.html index dc6289bbb..ed6cf2736 100644 --- a/Moose Training/Documentation/Smoke.html +++ b/docs/Documentation/Smoke.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Spawn.html b/docs/Documentation/Spawn.html similarity index 99% rename from Moose Training/Documentation/Spawn.html rename to docs/Documentation/Spawn.html index fd1011baf..f2c75b964 100644 --- a/Moose Training/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -1703,6 +1702,9 @@ The group that was spawned. You can use this group for further actions.

    + +

    Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

    +
    @@ -2497,7 +2499,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

    Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

    +

    When the first Spawn executes, all the Groups need to be made visible before start.

    diff --git a/Moose Training/Documentation/Static.html b/docs/Documentation/Static.html similarity index 99% rename from Moose Training/Documentation/Static.html rename to docs/Documentation/Static.html index 548946939..2ee619d85 100644 --- a/Moose Training/Documentation/Static.html +++ b/docs/Documentation/Static.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html similarity index 99% rename from Moose Training/Documentation/StaticObject.html rename to docs/Documentation/StaticObject.html index 6c4667c2e..dcecd0cf0 100644 --- a/Moose Training/Documentation/StaticObject.html +++ b/docs/Documentation/StaticObject.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/TASK.html b/docs/Documentation/Task.html similarity index 99% rename from Moose Training/Documentation/TASK.html rename to docs/Documentation/Task.html index 0aba94927..030b965eb 100644 --- a/Moose Training/Documentation/TASK.html +++ b/docs/Documentation/Task.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -140,12 +139,6 @@ Use the method TASK.AddScore() to add scores whe

    Global(s)

    - - - - - - - - diff --git a/Moose Training/Documentation/land.html b/docs/Documentation/land.html similarity index 99% rename from Moose Training/Documentation/land.html rename to docs/Documentation/land.html index 951505f35..4861ee69b 100644 --- a/Moose Training/Documentation/land.html +++ b/docs/Documentation/land.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/routines.html b/docs/Documentation/routines.html similarity index 99% rename from Moose Training/Documentation/routines.html rename to docs/Documentation/routines.html index 11e68a822..34c841e1e 100644 --- a/Moose Training/Documentation/routines.html +++ b/docs/Documentation/routines.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/stylesheet.css b/docs/Documentation/stylesheet.css similarity index 100% rename from Moose Training/Documentation/stylesheet.css rename to docs/Documentation/stylesheet.css diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..d712ebb5c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,202 @@ +# Context + +MOOSE is a **M**ission **O**bject **O**riented **S**cripting **E**nvironment, and is meant for mission designers and mission hosters. +It allows to quickly setup complex missions using pre-scripted scenarios using the available classes within the MOOSE Framework. +MOOSE is currently still in alpha version, but will evolve over time. Right now, it has been updated to work with DCS world 1.5. and 2.0. + +You can find the source of MOOSE here on GITHUB. It is free for download: +https://github.com/FlightControl-Master/MOOSE/ + +Note: MOOSE is complementary to [MIST](https://github.com/mrSkortch/MissionScriptingTools/releases), so if you use MIST in parallel with MOOSE objects, this should work. + +# Goals + +The goal of MOOSE is to allow mission designers to enhance their scripting with mission orchestration objects, which can be instantiated from defined classes within the framework. This will allow to write mission scripts with minimal code embedded. Of course, the richness of the framework will determine the richness of the misson scenarios. We can expect that MOOSE will evolve over time, as more missions will be designed within the framework. + +# MOOSE Directory Structure + +* Moose Development: Contains the collection of lua files that define the MOOSE classes. You can use this directory to build the dynamic luadoc documentation intellisense in your eclipse development environment. +* Moose Mission Setup: Contains the Moose.lua file to be included in your scripts when using MOOSE classes (see below the point Mission Design with Moose). +* Moose Test Missions: Contains a directory structure with Moose Test Missions and examples. In each directory, you will find a miz file and a lua file containing the main mission script. +* Moose Training: Contains the documentation of Moose generated with luadoc from the Moose source code. The presentations used during the videos in my [youtube channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg), are also to be found here. + +# Mission Design with Moose + +In order to create a mission using MOOSE, you'll have to include a file named **Moose.lua**: + +1. Create a new mission in the DCS World Mission Editor. +2. In the mission editor, create a new trigger. +3. Name the trigger Moose Load and let it execute only at MISSION START. +4. Add an action DO SCRIPT FILE (without a condition, so the middle column must be empty). +5. In the action, browse to the **[Moose.lua](https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Mission%20Setup)** file in the **Moose Mission Setup** directory, and include this file within your mission. +6. Make sure that the "Moose Load" trigger is completely at the top of your mission. + +Voila, MOOSE is now included in your mission. During the execution of this mission, all MOOSE classes will be loaded, and all MOOSE initializations will be exectuted before any other mission action is executed. + +IMPORTANT NOTE: When a new version of MOOSE is released, you'll have to UPDATE the Moose.lua file in EACH OF YOUR MISSION. +This can be a tedious task, and for this purpose, a tool has been developed that will update the Moose.lua files automatically within your missions. +Refer to the tool at [Moose Mission Setup\Moose Mission Update](https://github.com/FlightControl-Master/MOOSE/tree/master/Moose%20Mission%20Setup/Moose%20Mission%20Update) directory for further information included in the [READ.ME]() file. + + +# MOOSE Classes + +The following classes are currently embedded within MOOSE and can be included within your mission scripts: + +## MOOSE Core Classes + +These classes define the base building blocks of the MOOSE framework. These classes are heavily used within the MOOSE framework. + +* [BASE](Documentation/Base.html): The main class from which all MOOSE classes are derived from. The BASE class contains essential functions to support inheritance and MOOSE object execution tracing (logging within the DCS.log file in the saved games folder of the user). + +* [DATABASE](Documentation/Database.html): Creates a collection of GROUPS[], UNITS[], CLIENTS[] and managed these sets automatically. Provides an API set to retrieve a GROUP, UNIT or CLIENT instance from the _DATABASE object using defined APIs. The collections are maintained dynamically during the execution of the mission, so when players join, leave, when units are created or destroyed, the collections are dynamically updated. + +* [EVENT](Documentation/Event.html): Provides the Event Dispatcher base class to handle DCS Events, being fired upon registered events within the DCS simulator. Note that EVENT is used by BASE, exposing OnEvent() methods to catch these DCS events. + +* [FSM](Documentation/Fsm.html): The main FSM class can be used to build a Finite State Machine. The derived FSM_ classes provide Finite State Machine building capability for CONTROLLABLEs, ACT_ (Task Actions) classes, TASKs and SETs. + +* [MENU](Documentation/Menu.html): Set Menu options (F10) for All Players, Coalitions, Groups, Clients. MENU also manages the recursive removal of menus, which is a big asset! + +* [SETS](Documentation/Set.html): Create SETs of MOOSE objects. SETs can be created for GROUPs, UNITs, AIRBASEs, ... +The SET can be filtered with defined filter criteria. +Iterators are available that iterate through the GROUPSET, calling a function for each object within the SET. + +* [MESSAGE](Documentation/Message.html): A message publishing system, displaying messages to Clients, Coalitions or All players. + +* [POINTS](Documentation/Point.html): A set of point classes to manage the 2D or 3D simulation space, through an extensive method library. +The POINT_VEC3 class manages the 3D simulation space, while the POINT_VEC2 class manages the 2D simulation space. + +* [ZONES](Documentation/Zone.html): A set of zone classes that provide the functionality to validate the presence of GROUPS, UNITS, CLIENTS, STATICS within a certain ZONE. The zones can take various forms and can be movable. + +* [SCHEDULER](Documentation/Scheduler.html): This class implements a timer scheduler that will call at optional specified intervals repeatedly or just one time a scheduled function. + + +## MOOSE Wrapper Classes + +MOOSE Wrapper Classes provide an object oriented hierarchical mechanism to manage the DCS objects within the simulator. +Wrapper classes provide another easier mechanism to control Groups, Units, Statics, Airbases and other objects. + +* **[OBJECT](Documentation/Object.html)**: This class provides the base for MOOSE objects. + +* **[IDENTIFIABLE](Documentation/Identifiable.html)**: This class provides the base for MOOSE identifiable objects, which is every object within the simulator :-). + +* **[POSITIONABLE](Documentation/Positionable.html)**: This class provides the base for MOOSE positionable objects. These are AIRBASEs, STATICs, GROUPs, UNITs ... + +* **[CONTROLLABLE](Documentation/Controllable.html)**: This class provides the base for MOOSE controllable objects. These are GROUPs, UNITs, CLIENTs. + +* **[AIRBASE](Documentation/Airbase.html)**: This class wraps a DCS Airbase object within the simulator. + +* **[GROUP](Documentation/Group.html)**: This class wraps a DCS Group objects within the simulator, which are currently alive. +It provides a more extensive API set. +It takes an abstraction of the complexity to give tasks, commands and set various options to DCS Groups. +Additionally, the GROUP class provides a much richer API to identify various properties of the DCS Group. +For each DCS Group created object within a running mission, a GROUP object will be created automatically, beging managed within the DATABASE. + +* **[UNIT](Documentation/Unit.html)**: This class wraps a DCS Unit object within the simulator, which are currently alive. It provides a more extensive API set, as well takes an abstraction of the complexity to give commands and set various options to DCS Units. Additionally, the UNIT class provides a much richer API to identify various properties of the DCS Unit. For each DCS Unit object created within a running mission, a UNIT object will be created automatically, that is stored within the DATABASE, under the _DATABASE object. +the UNIT class provides a more extensive API set, taking an abstraction of the complexity to give tasks, commands and set various options to DCS Units. +For each DCS Unit created object within a running mission, a UNIT object will be created automatically, beging managed within the DATABASE. + +* **[CLIENT](Documentation/Client.html)**: This class wraps a DCS Unit object within the simulator, which has a skill Client or Player. +The CLIENT class derives from the UNIT class, thus contains the complete UNIT API set, and additionally, the CLIENT class provides an API set to manage players joining or leaving clients, sending messages to players, and manage the state of units joined by players. For each DCS Unit object created within a running mission that can be joined by a player, a CLIENT object will be created automatically, that is stored within the DATABASE, under the _DATABASE object. + +* **[STATIC](Documentation/Static.html)**: This class wraps a DCS StaticObject object within the simulator. +The STATIC class derives from the POSITIONABLE class, thus contains also the position API set. + + +## MOOSE Functional Classes + +MOOSE Functional Classes provide various functions that are useful in mission design. + +* [SPAWN](Documentation/Spawn.html): Spawn new groups (and units) during mission execution. + +* [ESCORT](Moose Training/Documentation/Escort.html): Makes groups consisting of helicopters, airplanes, ground troops or ships within a mission joining your flight. You can control these groups through the ratio menu during your flight. Available commands are around: Navigation, Position Hold, Reporting (Target Detection), Attacking, Assisted Attacks, ROE, Evasion, Mission Execution and more ... + +* [MISSILETRAINER](Moose Training/Documentation/MissileTrainer.html): Missile trainer, it destroys missiles when they are within a certain range of player airplanes, displays tracking and alert messages of missile launches; approach; destruction, and configure with radio menu commands. Various APIs available to configure the trainer. + +* [DETECTION](Moose Training/Documentation/Detection.html): Detect other units using the available sensors of the detection unit. The DETECTION_BASE derived classes will provide different methods how the sets of detected objects are built. + +## MOOSE AI Controlling Classes + +MOOSE AI Controlling Classes provide mechanisms to control AI over long lasting processes. +These AI Controlling Classes are based on FSM (Finite State Machine) Classes, and provided an encapsulated way to make AI behave or execute an activity. + +* [AI_BALANCER](Documentation/AI_Balancer.html): Compensate in a multi player mission the abscence of players with dynamically spawned AI air units. When players join CLIENTS, the AI will either be destroyed, or will fly back to the home or nearest friendly airbase. + +* [AI_PATROLZONE](Documentation/AI_PatrolZone.html): Make an alive AI Group patrol a zone derived from the ZONE_BASE class. Manage out-of-fuel events and set altitude and speed ranges for the patrol. + +* [AI_CARGO](Documentation/AI_Cargo.html): Make AI behave as cargo. Various CARGO types exist. + +## MOOSE Tasking Classes + +MOOSE Tasking Classes provide a comprehensive Mission Orchestration System. +Through COMMANDCENTERs, multiple logical MISSIONs can be orchestrated for coalitions. +Within each MISSION, various TASKs can be defined. +Each TASK has a TASK ACTION flow, which is the flow that a player (hosted by a UNIT) within the simulator needs to follow and accomplish. + +* [COMMANDCENTER](Documentation/CommandCenter.html): Orchestrates various logical MISSIONs for a coalition. + +* [MISSION](Documentation/Mission.html): Each MISSION has various TASKs to be executed and accomplished by players. + +* [TASK](Documentation/Task.html): Each TASK has a status, and has a TASK ACTION flow for each Player acting and executing the TASK. + +* [TASK_SEAD](Documentation/Task_SEAD.html): Models a SEAD Task, where a Player is routed towards an attack zone, and various SEADing targets need to be eliminated. + +* [TASK_A2G](Documentation/Task_A2G.html): Models a A2G Task, where a Player is routed towards an attack zone, and various A2G targets need to be eliminated. + +## MOOSE Action Classes + +MOOSE Action Classes are task action sub-flows, that can be used and combined, to quickly define a comprehensive end-to-end task action flow. +For example, for the SEAD Task, the task action flow combines the actions ASSIGN, ROUTE, ACCOUNT and ASSIST task action sub-flows. + +* [ACT_ASSIGN](Documentation/Assign.html): Mechanism to accept a TASK by a player. For example, assign the task only after the player accepts the task using the menu. + +* [ACT_ROUTE](Documentation/Route.html): Mechanisms to route players to zones or any other positionable coordinate. For example, route a player towards a zone. + +* [ACT_ACCOUNT](Documentation/Account.html): Mechanisms to account various events within the simulator. For example, account the dead events, accounting dead units within a Target SET within a ZONE. + +* [ACT_ASSIST](Documentation/Assist.html): Mechanisms to assist players executing a task. For example, acquire targets through smoking them. + + +# MOOSE Tutorials and Examples + +You can download [test missions](https://github.com/FlightControl-Master/MOOSE/tree/master/Test%20Missions) to have examples and learn the syntax and usage of the MOOSE classes. + +There are [Video Tutorials](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg) on my YOUTUBE channel on which you can learn some coding aspects with mission execution demos, as well as some of the tooling and internal mechanisms within MOOSE. + + +In the triggers section, there is a flag (9999) that will decide how MOOSE will be loaded. When flag 9999 is set, MOOSE will be dynamically loaded. When flag 9999 is off, MOOSE will be loaded embedded. Note that when loaded embedded, **your mission must include the last Moose_Embedded.lua file**. So, ensure that the last file is included in the DO SCRIPT section when MOOSE got an update! + +# Credits + +Note that the framework is based on code i've written myself, but some of it is also based on code that i've seen as great scripting code and ideas, and which i've revised. I see this framework evolving towards a broader public, and the ownership may dissapear (or parts of it). Consider this code public domain. Therefore a list of credits to all who have or are contributing (this list will increase over time): Grimes, Prof_Hilactic, xcom, the 476 virtual squadron team, ... + +You'll notice that within this framework, there are functions used from mist. I've taken the liberty to copy those atomic mist functions that are very nice and useful, and used those. + +**Grimes** +Without the effort of Grimes with MIST and his continuous documentation, the development of MOOSE would not have been possible. MOOSE is not replacing MIST, but is compensating it. + +**Prof_hilactic** +SEAD Defenses. I've taken the script, and reworded it to fit within MOOSE. The script within MOOSE is hardly recognizable anymore from the original. Find here the posts: http://forums.eagle.ru/showpost.php?...59&postcount=1 + +**xcom** +His contribution is related to the Event logging system. I've analyzed and studied his scripts, and reworked it a bit to use it also within the framework (I've also tweaked it a bit). Find his post here: http://forums.eagle.ru/showpost.php?...73&postcount=1 + +**Dutch_Baron (James)** +Working together with James has resulted in the creation of the AIBALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-) + +**Stuka (Danny)** +Working together with Danny has resulted in the MISSILETRAINER class. Stuka has shared his ideas and together we made a design. Together with the 476 virtual team, we tested this CLASS, and got much positive feedback! + +**Mechanic (G�bor)** +Worked together with G�bor to create the concept of the DETECTION and FAC classes. Mechanic shared his ideas and concepts to group detected targets into sets within detection zones... Will continue to work with G�bor to workout the DETECTION and FAC classes. + +**Shadoh** +Interacted on the eagle dynamics forum to build the FOLLOW class to build large WWII airplane formations. + +For the rest I also would like to thank the numerous feedback and help and assistance of the moose community at SLACK.COM. +Note that there is a vast amount of other scripts out there. +I may contact you personally to ask for your contribution / permission if i can use your idea or script to tweak it to the framework. +Parts of these scripts will have to be redesigned to fit it into an OO framework. + +The rest of the framework functions and class definitions were my own developments, especially the core of MOOSE. +Trust I've spent hours and hours investigating, trying and writing and documenting code building this framework. +Hope you think the idea is great and useful. \ No newline at end of file diff --git a/Moose Training/Stylesheet/stylesheet.css b/docs/Stylesheet/stylesheet.css similarity index 100% rename from Moose Training/Stylesheet/stylesheet.css rename to docs/Stylesheet/stylesheet.css diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..3397c9a49 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-architect \ No newline at end of file
    PlayerNameText - -
    TASK @@ -695,20 +688,6 @@ Use the method TASK.AddScore() to add scores whe
    - - -PlayerNameText - -
    -
    - - - -
    -
    -
    -
    - #TASK TASK diff --git a/Moose Training/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html similarity index 99% rename from Moose Training/Documentation/Task_A2G.html rename to docs/Documentation/Task_A2G.html index 9737bad70..307c0556c 100644 --- a/Moose Training/Documentation/Task_A2G.html +++ b/docs/Documentation/Task_A2G.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html similarity index 99% rename from Moose Training/Documentation/Task_PICKUP.html rename to docs/Documentation/Task_PICKUP.html index db5837309..2aa2277c8 100644 --- a/Moose Training/Documentation/Task_PICKUP.html +++ b/docs/Documentation/Task_PICKUP.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Task_SEAD.html b/docs/Documentation/Task_SEAD.html similarity index 99% rename from Moose Training/Documentation/Task_SEAD.html rename to docs/Documentation/Task_SEAD.html index a645f9be7..df536f1da 100644 --- a/Moose Training/Documentation/Task_SEAD.html +++ b/docs/Documentation/Task_SEAD.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Unit.html b/docs/Documentation/Unit.html similarity index 99% rename from Moose Training/Documentation/Unit.html rename to docs/Documentation/Unit.html index 4f609ac2b..792f9b166 100644 --- a/Moose Training/Documentation/Unit.html +++ b/docs/Documentation/Unit.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Utils.html b/docs/Documentation/Utils.html similarity index 99% rename from Moose Training/Documentation/Utils.html rename to docs/Documentation/Utils.html index e521a979b..260e3c08b 100644 --- a/Moose Training/Documentation/Utils.html +++ b/docs/Documentation/Utils.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/Zone.html b/docs/Documentation/Zone.html similarity index 99% rename from Moose Training/Documentation/Zone.html rename to docs/Documentation/Zone.html index 71d7c5c6c..25bf67e39 100644 --- a/Moose Training/Documentation/Zone.html +++ b/docs/Documentation/Zone.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/env.html b/docs/Documentation/env.html similarity index 98% rename from Moose Training/Documentation/env.html rename to docs/Documentation/env.html index 726cf3543..985b449dc 100644 --- a/Moose Training/Documentation/env.html +++ b/docs/Documentation/env.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • diff --git a/Moose Training/Documentation/index.html b/docs/Documentation/index.html similarity index 98% rename from Moose Training/Documentation/index.html rename to docs/Documentation/index.html index 045f3eaf2..27ad96c3c 100644 --- a/Moose Training/Documentation/index.html +++ b/docs/Documentation/index.html @@ -71,7 +71,6 @@
  • StaticObject
  • Task
  • Task_A2G
    • -
  • Task_Client_Menu
  • Task_PICKUP
  • Task_SEAD
  • Unit
    • @@ -407,12 +406,6 @@
    		Task_A2G

    (AI) (SP) (MP) Tasking for Air to Ground Processes.

    -
    Task_Client_Menu -