diff --git a/Moose Development/Moose/Functional/ATC_Ground.lua b/Moose Development/Moose/Functional/ATC_Ground.lua index 5709e7686..707a8ff24 100644 --- a/Moose Development/Moose/Functional/ATC_Ground.lua +++ b/Moose Development/Moose/Functional/ATC_Ground.lua @@ -11,7 +11,7 @@ -- -- === -- --- @module ATC_Ground +-- @module Functional.ATC_Ground --- @type ATC_GROUND diff --git a/Moose Development/Moose/Functional/Artillery.lua b/Moose Development/Moose/Functional/Artillery.lua index c38ee1fad..59806a42c 100644 --- a/Moose Development/Moose/Functional/Artillery.lua +++ b/Moose Development/Moose/Functional/Artillery.lua @@ -38,7 +38,7 @@ -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536) -- -- ==== --- @module Arty +-- @module Functional.Arty ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --- ARTY class diff --git a/Moose Development/Moose/Functional/CleanUp.lua b/Moose Development/Moose/Functional/CleanUp.lua index 84ea9c413..f7414e190 100644 --- a/Moose Development/Moose/Functional/CleanUp.lua +++ b/Moose Development/Moose/Functional/CleanUp.lua @@ -7,7 +7,7 @@ -- -- === -- --- @module CleanUp +-- @module Functional.CleanUp --- @type CLEANUP_AIRBASE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-) -- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases. diff --git a/Moose Development/Moose/Functional/Designate.lua b/Moose Development/Moose/Functional/Designate.lua index a633a8801..dce33f924 100644 --- a/Moose Development/Moose/Functional/Designate.lua +++ b/Moose Development/Moose/Functional/Designate.lua @@ -28,7 +28,7 @@ -- -- * **FlightControl**: Design & Programming -- --- @module Designate +-- @module Functional.Designate do -- DESIGNATE diff --git a/Moose Development/Moose/Functional/Detection.lua b/Moose Development/Moose/Functional/Detection.lua index 2c5d61a8a..93755e614 100644 --- a/Moose Development/Moose/Functional/Detection.lua +++ b/Moose Development/Moose/Functional/Detection.lua @@ -29,7 +29,7 @@ -- -- * FlightControl : Analysis, Design, Programming, Testing -- --- @module Detection +-- @module Functional.Detection ----BASE:TraceClass("DETECTION_BASE") ----BASE:TraceClass("DETECTION_AREAS") diff --git a/Moose Development/Moose/Functional/Escort.lua b/Moose Development/Moose/Functional/Escort.lua index 25ecced57..755770c84 100644 --- a/Moose Development/Moose/Functional/Escort.lua +++ b/Moose Development/Moose/Functional/Escort.lua @@ -114,8 +114,7 @@ -- -- -- --- @module Escort --- @author FlightControl +-- @module Functional.Escort --- ESCORT class -- @type ESCORT diff --git a/Moose Development/Moose/Functional/MissileTrainer.lua b/Moose Development/Moose/Functional/MissileTrainer.lua index abaa15d09..151964515 100644 --- a/Moose Development/Moose/Functional/MissileTrainer.lua +++ b/Moose Development/Moose/Functional/MissileTrainer.lua @@ -77,8 +77,7 @@ -- Danny has shared his ideas and together we made a design. -- Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback! -- --- @module MissileTrainer --- @author FlightControl +-- @module Functional.MissileTrainer --- The MISSILETRAINER class diff --git a/Moose Development/Moose/Functional/Movement.lua b/Moose Development/Moose/Functional/Movement.lua index a5d4d7058..8aabf0130 100644 --- a/Moose Development/Moose/Functional/Movement.lua +++ b/Moose Development/Moose/Functional/Movement.lua @@ -7,7 +7,7 @@ -- Performance: If in a DCSRTE there are a lot of moving GROUND units, then in a multi player mission, this WILL create lag if -- the main DCS execution core of your CPU is fully utilized. So, this class will limit the amount of simultaneous moving GROUND units -- on defined intervals (currently every minute). --- @module Movement +-- @module Functional.Movement --- the MOVEMENT class -- @type MOVEMENT diff --git a/Moose Development/Moose/Functional/Protect.lua b/Moose Development/Moose/Functional/Protect.lua index 91c6009f3..00645edbe 100644 --- a/Moose Development/Moose/Functional/Protect.lua +++ b/Moose Development/Moose/Functional/Protect.lua @@ -7,7 +7,7 @@ -- -- === -- --- @module Protect +-- @module Functional.Protect --- @type PROTECT.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-) -- @extends Core.Fsm#FSM diff --git a/Moose Development/Moose/Functional/PseudoATC.lua b/Moose Development/Moose/Functional/PseudoATC.lua index 78ed78f09..c1a639029 100644 --- a/Moose Development/Moose/Functional/PseudoATC.lua +++ b/Moose Development/Moose/Functional/PseudoATC.lua @@ -38,7 +38,7 @@ -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536) -- -- ==== --- @module PseudoATC +-- @module Functional.PseudoATC ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --- PSEUDOATC class diff --git a/Moose Development/Moose/Functional/RAT.lua b/Moose Development/Moose/Functional/RAT.lua index 644dbdac0..31b3fc369 100644 --- a/Moose Development/Moose/Functional/RAT.lua +++ b/Moose Development/Moose/Functional/RAT.lua @@ -59,7 +59,7 @@ -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536) -- -- === --- @module Rat +-- @module Functional.Rat ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --- RAT class diff --git a/Moose Development/Moose/Functional/Range.lua b/Moose Development/Moose/Functional/Range.lua index 706fe8665..175574bcf 100644 --- a/Moose Development/Moose/Functional/Range.lua +++ b/Moose Development/Moose/Functional/Range.lua @@ -48,7 +48,7 @@ -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536), [Ciribob](https://forums.eagle.ru/member.php?u=112175) -- -- === --- @module Range +-- @module Functional.Range ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- --- RANGE class diff --git a/Moose Development/Moose/Functional/Scoring.lua b/Moose Development/Moose/Functional/Scoring.lua index 092d7998f..c6468a1e5 100644 --- a/Moose Development/Moose/Functional/Scoring.lua +++ b/Moose Development/Moose/Functional/Scoring.lua @@ -206,7 +206,7 @@ -- -- * **FlightControl**: Concept, Design & Programming. -- --- @module Scoring +-- @module Functional.Scoring --- The Scoring class diff --git a/Moose Development/Moose/Functional/Sead.lua b/Moose Development/Moose/Functional/Sead.lua index f1a18b8df..d9d9bfffb 100644 --- a/Moose Development/Moose/Functional/Sead.lua +++ b/Moose Development/Moose/Functional/Sead.lua @@ -2,7 +2,7 @@ -- -- === -- --- @module Sead +-- @module Functional.Sead --- The SEAD class -- @type SEAD diff --git a/Moose Development/Moose/Functional/Suppression.lua b/Moose Development/Moose/Functional/Suppression.lua index 41fb3dc09..929e8b718 100644 --- a/Moose Development/Moose/Functional/Suppression.lua +++ b/Moose Development/Moose/Functional/Suppression.lua @@ -31,7 +31,7 @@ -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536) -- -- ==== --- @module Suppression +-- @module Functional.Suppression ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- diff --git a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua index e093eb3ef..7c1610687 100644 --- a/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneCaptureCoalition.lua @@ -21,7 +21,7 @@ -- -- === -- --- @module ZoneCaptureCoalition +-- @module Functional.ZoneCaptureCoalition do -- ZONE_CAPTURE_COALITION diff --git a/Moose Development/Moose/Functional/ZoneGoal.lua b/Moose Development/Moose/Functional/ZoneGoal.lua index 9c3d22c36..60c2f6d25 100644 --- a/Moose Development/Moose/Functional/ZoneGoal.lua +++ b/Moose Development/Moose/Functional/ZoneGoal.lua @@ -11,7 +11,7 @@ -- -- === -- --- @module ZoneGoal +-- @module Functional.ZoneGoal do -- Zone diff --git a/Moose Development/Moose/Functional/ZoneGoalCargo.lua b/Moose Development/Moose/Functional/ZoneGoalCargo.lua index e5ea44310..5fc27acc6 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCargo.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCargo.lua @@ -11,7 +11,7 @@ -- -- === -- --- @module ZoneGoalCargo +-- @module Functional.ZoneGoalCargo do -- ZoneGoal diff --git a/Moose Development/Moose/Functional/ZoneGoalCoalition.lua b/Moose Development/Moose/Functional/ZoneGoalCoalition.lua index 91c7df0dc..b0b737518 100644 --- a/Moose Development/Moose/Functional/ZoneGoalCoalition.lua +++ b/Moose Development/Moose/Functional/ZoneGoalCoalition.lua @@ -11,7 +11,7 @@ -- -- === -- --- @module ZoneGoalCoalition +-- @module Functional.ZoneGoalCoalition do -- ZoneGoal diff --git a/Moose Development/Moose/Tasking/CommandCenter.lua b/Moose Development/Moose/Tasking/CommandCenter.lua index 4090980c6..725a634b3 100644 --- a/Moose Development/Moose/Tasking/CommandCenter.lua +++ b/Moose Development/Moose/Tasking/CommandCenter.lua @@ -9,7 +9,7 @@ -- -- === -- --- @module CommandCenter +-- @module Tasking.CommandCenter diff --git a/Moose Development/Moose/Tasking/DetectionManager.lua b/Moose Development/Moose/Tasking/DetectionManager.lua index 1c4f5492f..e6a6aaf19 100644 --- a/Moose Development/Moose/Tasking/DetectionManager.lua +++ b/Moose Development/Moose/Tasking/DetectionManager.lua @@ -40,7 +40,7 @@ -- ### Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing -- ### Author: FlightControl - Framework Design & Programming -- --- @module DetectionManager +-- @module Tasking.DetectionManager do -- DETECTION MANAGER diff --git a/Moose Development/Moose/Tasking/Mission.lua b/Moose Development/Moose/Tasking/Mission.lua index 1ac4383f8..e541b7bbb 100644 --- a/Moose Development/Moose/Tasking/Mission.lua +++ b/Moose Development/Moose/Tasking/Mission.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module Mission +-- @module Tasking.Mission --- The MISSION class -- @type MISSION diff --git a/Moose Development/Moose/Tasking/Task.lua b/Moose Development/Moose/Tasking/Task.lua index e68de90d3..9dd3da5bb 100644 --- a/Moose Development/Moose/Tasking/Task.lua +++ b/Moose Development/Moose/Tasking/Task.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module Task +-- @module Tasking.Task --- @type TASK -- @field Core.Scheduler#SCHEDULER TaskScheduler diff --git a/Moose Development/Moose/Tasking/TaskInfo.lua b/Moose Development/Moose/Tasking/TaskInfo.lua index 723975838..349d090c1 100644 --- a/Moose Development/Moose/Tasking/TaskInfo.lua +++ b/Moose Development/Moose/Tasking/TaskInfo.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module TaskInfo +-- @module Tasking.TaskInfo --- @type TASKINFO -- @extends Core.Base#BASE diff --git a/Moose Development/Moose/Tasking/TaskZoneCapture.lua b/Moose Development/Moose/Tasking/TaskZoneCapture.lua index 7de3f3e04..ad563c1d5 100644 --- a/Moose Development/Moose/Tasking/TaskZoneCapture.lua +++ b/Moose Development/Moose/Tasking/TaskZoneCapture.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module TaskZoneCapture +-- @module Tasking.TaskZoneCapture do -- TASK_ZONE_GOAL diff --git a/Moose Development/Moose/Tasking/Task_A2A.lua b/Moose Development/Moose/Tasking/Task_A2A.lua index fff13b776..b3c268100 100644 --- a/Moose Development/Moose/Tasking/Task_A2A.lua +++ b/Moose Development/Moose/Tasking/Task_A2A.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module Task_A2A +-- @module Tasking.Tasking.Task_A2A do -- TASK_A2A diff --git a/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua index d3d0c8c39..3ca89bf8e 100644 --- a/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua @@ -10,7 +10,7 @@ -- -- === -- --- @module Task_A2A_Dispatcher +-- @module Tasking.Task_A2A_Dispatcher do -- TASK_A2A_DISPATCHER diff --git a/Moose Development/Moose/Tasking/Task_A2G.lua b/Moose Development/Moose/Tasking/Task_A2G.lua index 15c33a5f8..59cef82ea 100644 --- a/Moose Development/Moose/Tasking/Task_A2G.lua +++ b/Moose Development/Moose/Tasking/Task_A2G.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module Task_A2G +-- @module Tasking.Task_A2G do -- TASK_A2G diff --git a/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua index a79825a6b..65d1796b7 100644 --- a/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module Task_A2G_Dispatcher +-- @module Tasking.Task_A2G_Dispatcher do -- TASK_A2G_DISPATCHER diff --git a/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua b/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua index b033ee17c..1326cec30 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua @@ -3,6 +3,8 @@ -- ![Banner Image](..\Presentations\TASK_CARGO\Dia1.JPG) -- -- === +-- +-- @module Tasking.Task_Cargo_CSAR do -- TASK_CARGO_CSAR diff --git a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua index 9671798d6..9603f5f4f 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua @@ -8,7 +8,7 @@ -- -- === -- --- @module Task_Cargo_Dispatcher +-- @module Tasking.Task_Cargo_Dispatcher do -- TASK_CARGO_DISPATCHER diff --git a/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua b/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua index 9dac77e5d..f906b87f8 100644 --- a/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua +++ b/Moose Development/Moose/Tasking/Task_Cargo_Transport.lua @@ -3,7 +3,7 @@ -- ![Banner Image](..\Presentations\TASK_CARGO\Dia1.JPG) -- -- === --- @module +-- @module Tasking.Task_Cargo_Transport do -- TASK_CARGO_TRANSPORT diff --git a/Moose Development/Moose/Tasking/Task_Manager.lua b/Moose Development/Moose/Tasking/Task_Manager.lua index 7788fb9d1..c82fa505e 100644 --- a/Moose Development/Moose/Tasking/Task_Manager.lua +++ b/Moose Development/Moose/Tasking/Task_Manager.lua @@ -29,7 +29,7 @@ -- ### Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing -- ### Author: FlightControl - Framework Design & Programming -- --- @module Task_Manager +-- @module Tasking.Task_Manager do -- TASK_MANAGER diff --git a/Moose Development/Moose/Tasking/Task_Pickup.lua b/Moose Development/Moose/Tasking/Task_Pickup.lua deleted file mode 100644 index b33acedac..000000000 --- a/Moose Development/Moose/Tasking/Task_Pickup.lua +++ /dev/null @@ -1,132 +0,0 @@ ---- This module contains the TASK_PICKUP classes. --- --- 1) @{#TASK_PICKUP} class, extends @{Task#TASK} --- === --- The @{#TASK_PICKUP} class defines a pickup task of a @{Set} of @{CARGO} objects defined within the mission. --- based on the tasking capabilities defined in @{Task#TASK}. --- The TASK_PICKUP is implemented using a @{Statemachine#FSM_TASK}, and has the following statuses: --- --- * **None**: Start of the process --- * **Planned**: The SEAD task is planned. Upon Planned, the sub-process @{Process_Fsm.Assign#ACT_ASSIGN_ACCEPT} is started to accept the task. --- * **Assigned**: The SEAD task is assigned to a @{Wrapper.Group#GROUP}. Upon Assigned, the sub-process @{Process_Fsm.Route#ACT_ROUTE} is started to route the active Units in the Group to the attack zone. --- * **Success**: The SEAD task is successfully completed. Upon Success, the sub-process @{Process_SEAD#PROCESS_SEAD} is started to follow-up successful SEADing of the targets assigned in the task. --- * **Failed**: The SEAD task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ. --- --- === --- --- ### Authors: FlightControl - Design and Programming --- --- @module Task_PICKUP - - -do -- TASK_PICKUP - - --- The TASK_PICKUP class - -- @type TASK_PICKUP - -- @extends Tasking.Task#TASK - TASK_PICKUP = { - ClassName = "TASK_PICKUP", - } - - --- Instantiates a new TASK_PICKUP. - -- @param #TASK_PICKUP self - -- @param Tasking.Mission#MISSION Mission - -- @param Core.Set#SET_GROUP AssignedSetGroup The set of groups for which the Task can be assigned. - -- @param #string TaskName The name of the Task. - -- @param #string TaskType BAI or CAS - -- @param Core.Set#SET_UNIT UnitSetTargets - -- @param Core.Zone#ZONE_BASE TargetZone - -- @return #TASK_PICKUP self - function TASK_PICKUP:New( Mission, AssignedSetGroup, TaskName, TaskType ) - local self = BASE:Inherit( self, TASK:New( Mission, AssignedSetGroup, TaskName, TaskType, "PICKUP" ) ) - self:F() - - return self - end - - --- Removes a TASK_PICKUP. - -- @param #TASK_PICKUP self - -- @return #nil - function TASK_PICKUP:CleanUp() - - self:GetParent( self ):CleanUp() - - return nil - end - - - --- Assign the @{Task} to a @{Wrapper.Unit}. - -- @param #TASK_PICKUP self - -- @param Wrapper.Unit#UNIT TaskUnit - -- @return #TASK_PICKUP self - function TASK_PICKUP:AssignToUnit( TaskUnit ) - self:F( TaskUnit:GetName() ) - - local ProcessAssign = self:AddProcess( TaskUnit, ACT_ASSIGN_ACCEPT:New( self, TaskUnit, self.TaskBriefing ) ) - local ProcessPickup = self:AddProcess( TaskUnit, PROCESS_PICKUP:New( self, self.TaskType, TaskUnit ) ) - - local Process = self:AddStateMachine( TaskUnit, FSM_TASK:New( self, TaskUnit, { - initial = 'None', - events = { - { name = 'Next', from = 'None', to = 'Planned' }, - { name = 'Next', from = 'Planned', to = 'Assigned' }, - { name = 'Next', from = 'Assigned', to = 'Success' }, - { name = 'Fail', from = 'Assigned', to = 'Failed' }, - }, - callbacks = { - onNext = self.OnNext, - }, - subs = { - Assign = { onstateparent = 'Planned', oneventparent = 'Next', fsm = ProcessAssign.Fsm, event = 'Start', returnevents = { 'Next', 'Reject' } }, - Pickup = { onstateparent = 'Assigned', oneventparent = 'Next', fsm = ProcessDestroy.Fsm, event = 'Start', returnevents = { 'Next' } }, - } - } ) ) - - ProcessRoute:AddScore( "Failed", "failed to destroy a ground unit", -100 ) - ProcessDestroy:AddScore( "Pickup", "Picked-Up a Cargo", 25 ) - ProcessDestroy:AddScore( "Failed", "failed to destroy a ground unit", -100 ) - - Process:Next() - - return self - end - - --- StateMachine callback function for a TASK - -- @param #TASK_PICKUP self - -- @param Core.Fsm#FSM_TASK Fsm - -- @param #string Event - -- @param #string From - -- @param #string To - -- @param Core.Event#EVENTDATA Event - function TASK_PICKUP:OnNext( Fsm, From, Event, To, Event ) - - self:SetState( self, "State", To ) - - end - - --- @param #TASK_PICKUP self - function TASK_PICKUP:GetPlannedMenuText() - return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )" - end - - - --- @param #TASK_PICKUP self - function TASK_PICKUP:_Schedule() - self:F2() - - self.TaskScheduler = SCHEDULER:New( self, _Scheduler, {}, 15, 15 ) - return self - end - - - --- @param #TASK_PICKUP self - function TASK_PICKUP._Scheduler() - self:F2() - - return true - end - -end - - -