FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes. (#1811)

Browse Source 
Update documentation text and links.
Fix spelling errors.
Other minor adjustments where appropriate, such as remove whitespaces and format code.
This commit is contained in:
TommyC81
2022-10-23 18:45:40 +04:00
committed by GitHub
parent 81818705df
commit 7455c63716
32 changed files with 197 additions and 198 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Moose Development/Moose/Tasking/DetectionManager.lua
View File

@@ -342,7 +342,7 @@ do -- DETECTION_REPORTING
return self
end
--- Creates a string of the detected items in a @{Detection}.
--- Creates a string of the detected items in a @{Functional.Detection} object.
-- @param #DETECTION_MANAGER self
-- @param Core.Set#SET_UNIT DetectedSet The detected Set created by the @{Functional.Detection#DETECTION_BASE} object.
-- @return #DETECTION_MANAGER self

24
Moose Development/Moose/Tasking/Mission.lua
View File

@@ -543,7 +543,7 @@ end
do -- Group Assignment
--- Returns if the @{Mission} is assigned to the Group.
--- Returns if the @{Tasking.Mission} is assigned to the Group.
-- @param #MISSION self
-- @param Wrapper.Group#GROUP MissionGroup
-- @return #boolean
@@ -561,7 +561,7 @@ do -- Group Assignment
end
--- Set @{Wrapper.Group} assigned to the @{Mission}.
--- Set @{Wrapper.Group} assigned to the @{Tasking.Mission}.
-- @param #MISSION self
-- @param Wrapper.Group#GROUP MissionGroup
-- @return #MISSION
@@ -576,7 +576,7 @@ do -- Group Assignment
return self
end
--- Clear the @{Wrapper.Group} assignment from the @{Mission}.
--- Clear the @{Wrapper.Group} assignment from the @{Tasking.Mission}.
-- @param #MISSION self
-- @param Wrapper.Group#GROUP MissionGroup
-- @return #MISSION
@@ -667,7 +667,7 @@ end
--- Get the TASK identified by the TaskNumber from the Mission. This function is useful in GoalFunctions.
-- @param #string TaskName The Name of the @{Task} within the @{Mission}.
-- @param #string TaskName The Name of the @{Task} within the @{Tasking.Mission}.
-- @return Tasking.Task#TASK The Task
-- @return #nil Returns nil if no task was found.
function MISSION:GetTask( TaskName )
@@ -677,7 +677,7 @@ function MISSION:GetTask( TaskName )
end
--- Return the next @{Task} ID to be completed within the @{Mission}.
--- Return the next @{Task} ID to be completed within the @{Tasking.Mission}.
-- @param #MISSION self
-- @param Tasking.Task#TASK Task is the @{Task} object.
-- @return Tasking.Task#TASK The task added.
@@ -689,7 +689,7 @@ function MISSION:GetNextTaskID( Task )
end
--- Register a @{Task} to be completed within the @{Mission}.
--- Register a @{Task} to be completed within the @{Tasking.Mission}.
-- Note that there can be multiple @{Task}s registered to be completed.
-- Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.
-- @param #MISSION self
@@ -708,7 +708,7 @@ function MISSION:AddTask( Task )
end
--- Removes a @{Task} to be completed within the @{Mission}.
--- Removes a @{Task} to be completed within the @{Tasking.Mission}.
-- Note that there can be multiple @{Task}s registered to be completed.
-- Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.
-- @param #MISSION self
@@ -733,35 +733,35 @@ function MISSION:RemoveTask( Task )
return nil
end
--- Is the @{Mission} **COMPLETED**.
--- Is the @{Tasking.Mission} **COMPLETED**.
-- @param #MISSION self
-- @return #boolean
function MISSION:IsCOMPLETED()
return self:Is( "COMPLETED" )
end
--- Is the @{Mission} **IDLE**.
--- Is the @{Tasking.Mission} **IDLE**.
-- @param #MISSION self
-- @return #boolean
function MISSION:IsIDLE()
return self:Is( "IDLE" )
end
--- Is the @{Mission} **ENGAGED**.
--- Is the @{Tasking.Mission} **ENGAGED**.
-- @param #MISSION self
-- @return #boolean
function MISSION:IsENGAGED()
return self:Is( "ENGAGED" )
end
--- Is the @{Mission} **FAILED**.
--- Is the @{Tasking.Mission} **FAILED**.
-- @param #MISSION self
-- @return #boolean
function MISSION:IsFAILED()
return self:Is( "FAILED" )
end
--- Is the @{Mission} **HOLD**.
--- Is the @{Tasking.Mission} **HOLD**.
-- @param #MISSION self
-- @return #boolean
function MISSION:IsHOLD()

2
Moose Development/Moose/Tasking/Task_A2A.lua
View File

@@ -18,7 +18,7 @@ do -- TASK_A2A
-- @field Core.Set#SET_UNIT TargetSetUnit
-- @extends Tasking.Task#TASK
--- Defines Air To Air tasks for a @{Set} of Target Units,
--- Defines Air To Air tasks for a @{Core.Set} of Target Units,
-- based on the tasking capabilities defined in @{Tasking.Task#TASK}.
-- The TASK_A2A is implemented using a @{Core.Fsm#FSM_TASK}, and has the following statuses:
--

2
Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua
View File

@@ -29,7 +29,7 @@ do -- TASK_A2A_DISPATCHER
-- @type TASK_A2A_DISPATCHER
-- @extends Tasking.DetectionManager#DETECTION_MANAGER
--- Orchestrates the dynamic dispatching of tasks upon groups of detected units determined a @{Set} of EWR installation groups.
--- Orchestrates the dynamic dispatching of tasks upon groups of detected units determined a @{Core.Set} of EWR installation groups.
--
-- ![Banner Image](..\Presentations\TASK_A2A_DISPATCHER\Dia3.JPG)
--

2
Moose Development/Moose/Tasking/Task_A2G.lua
View File

@@ -18,7 +18,7 @@ do -- TASK_A2G
-- @field Core.Set#SET_UNIT TargetSetUnit
-- @extends Tasking.Task#TASK
--- The TASK_A2G class defines Air To Ground tasks for a @{Set} of Target Units,
--- The TASK_A2G class defines Air To Ground tasks for a @{Core.Set} of Target Units,
-- based on the tasking capabilities defined in @{Tasking.Task#TASK}.
-- The TASK_A2G is implemented using a @{Core.Fsm#FSM_TASK}, and has the following statuses:
--

22
Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua
View File

@@ -32,17 +32,17 @@ do -- TASK_A2G_DISPATCHER
-- @field Tasking.Mission#MISSION Mission
-- @extends Tasking.DetectionManager#DETECTION_MANAGER
--- Orchestrates dynamic **A2G Task Dispatching** based on the detection results of a linked @{Detection} object.
--- Orchestrates dynamic **A2G Task Dispatching** based on the detection results of a linked @{Functional.Detection} object.
--
-- It uses the Tasking System within the MOOSE framework, which is a multi-player Tasking Orchestration system.
-- It provides a truly dynamic battle environment for pilots and ground commanders to engage upon,
-- in a true co-operation environment wherein **Multiple Teams** will collaborate in Missions to **achieve a common Mission Goal**.
--
-- The A2G dispatcher will dispatch the A2G Tasks to a defined @{Set} of @{Wrapper.Group}s that will be manned by **Players**.
-- We call this the **AttackSet** of the A2G dispatcher. So, the Players are seated in the @{Client}s of the @{Wrapper.Group} @{Set}.
-- The A2G dispatcher will dispatch the A2G Tasks to a defined @{Core.Set} of @{Wrapper.Group}s that will be manned by **Players**.
-- We call this the **AttackSet** of the A2G dispatcher. So, the Players are seated in the @{Client}s of the @{Wrapper.Group} @{Core.Set}.
--
-- Depending on the actions of the enemy, preventive tasks are dispatched to the players to orchestrate the engagement in a true co-operation.
-- The detection object will group the detected targets by its grouping method, and integrates a @{Set} of @{Wrapper.Group}s that are Recce vehicles or air units.
-- The detection object will group the detected targets by its grouping method, and integrates a @{Core.Set} of @{Wrapper.Group}s that are Recce vehicles or air units.
-- We call this the **RecceSet** of the A2G dispatcher.
--
-- Depending on the current detected tactical situation, different task types will be dispatched to the Players seated in the AttackSet..
@@ -108,7 +108,7 @@ do -- TASK_A2G_DISPATCHER
--
-- # 1. Player Experience
--
-- The A2G dispatcher is residing under a @{CommandCenter}, which is orchestrating a @{Mission}.
-- The A2G dispatcher is residing under a @{Tasking.CommandCenter}, which is orchestrating a @{Tasking.Mission}.
-- As a result, you'll find for DCS World missions that implement the A2G dispatcher a **Command Center Menu** and under this one or more **Mission Menus**.
--
-- For example, if there are 2 Command Centers (CC).
@@ -384,12 +384,12 @@ do -- TASK_A2G_DISPATCHER
--
-- To use the TASK\_A2G\_DISPATCHER class, you need:
--
-- - A @{CommandCenter} object. The master communication channel.
-- - A @{Mission} object. Each task belongs to a Mission.
-- - A @{Detection} object. There are several detection grouping methods to choose from.
-- - A @{Task_A2G_Dispatcher} object. The master A2G task dispatcher.
-- - A @{Set} of @{Wrapper.Group} objects that will detect the enemy, the RecceSet. This is attached to the @{Detection} object.
-- - A @{Set} ob @{Wrapper.Group} objects that will attack the enemy, the AttackSet. This is attached to the @{Task_A2G_Dispatcher} object.
-- - A @{Tasking.CommandCenter} object. The master communication channel.
-- - A @{Tasking.Mission} object. Each task belongs to a Mission.
-- - A @{Functional.Detection} object. There are several detection grouping methods to choose from.
-- - A @{Tasking.Task_A2G_Dispatcher} object. The master A2G task dispatcher.
-- - A @{Core.Set} of @{Wrapper.Group} objects that will detect the enemy, the RecceSet. This is attached to the @{Functional.Detection} object.
-- - A @{Core.Set} of @{Wrapper.Group} objects that will attack the enemy, the AttackSet. This is attached to the @{Tasking.Task_A2G_Dispatcher} object.
--
-- Below an example mission declaration that is defines a Task A2G Dispatcher object.
--