Merge pull request #576 from FlightControl-Master/562-AI-A2A-Dispatcher

562 ai a2a dispatcher

Utils/Slate Documentation Generator/bin/TreeHierarchy.csv

@@ -39,5 +39,5 @@
 @K=function, @M=Designate, @N=OnAfterStatus, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=15822,
 @K=function, @M=Designate, @N=Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16043,
 @K=function, @M=Designate, @N=__Status, @P=DESIGNATE , @F=../../../MOOSE/Moose Development/Moose\Functional\Designate.lua, @C=16166,
-@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=65243,
-@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=69452,
+@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=65259,
+@K=function, @M=AI_A2A_Dispatcher, @N=onafterHome, @P=Fsm, @F=../../../MOOSE/Moose Development/Moose\AI\AI_A2A_Dispatcher.lua, @C=69468,

docs/Documentation/AI_A2A_Dispatcher.html

@@ -126,9 +126,9 @@
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="#AI_A2A_DISPATCHER">AI_A2A_DISPATCHER</a></td>
 		<td class="summary">
-<h1>AI<em>A2A</em>DISPATCHER class, extends <a href="Tasking.html##(DETECTION_MANAGER)">Tasking#DETECTION_MANAGER</a></h1>
+<h1>AI_A2A_DISPATCHER class, extends <a href="Tasking.html##(DETECTION_MANAGER)">Tasking#DETECTION_MANAGER</a></h1>
 
-<p>The <a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a> class is designed to create an automatic air defence system for a coalition.</p>
+<p>The <a href="##(AI)">#AI</a> class is designed to create an automatic air defence system for a coalition.</p>
 </td>
 		</tr>
 	</table>
@@ -597,9 +597,9 @@
 </dt>
 <dd>
 	
-<h1>AI<em>A2A</em>DISPATCHER class, extends <a href="Tasking.html##(DETECTION_MANAGER)">Tasking#DETECTION_MANAGER</a></h1>
+<h1>AI_A2A_DISPATCHER class, extends <a href="Tasking.html##(DETECTION_MANAGER)">Tasking#DETECTION_MANAGER</a></h1>
 
-<p>The <a href="##(AI_A2A_DISPATCHER)">#AI<em>A2A</em>DISPATCHER</a> class is designed to create an automatic air defence system for a coalition.</p>
+<p>The <a href="##(AI)">#AI</a> class is designed to create an automatic air defence system for a coalition.</p>
 
 	
 <p>It includes automatic spawning of Combat Air Patrol aircraft (CAP) and Ground Controlled Intercept aircraft (GCI) in response to enemy air movements that are detected by a ground based radar network. 
@@ -608,12 +608,12 @@ If all CAP flights are engaged or RTB then additional GCI interceptors will scra
 With a little time and with a little work it provides the mission designer with a convincing and completely automatic air defence system. 
 In short it is a plug in very flexible and configurable air defence module for DCS World.</p>
 
-<p>Note that in order to create a two way A2A defense system, two AI<em>A2A</em>DISPATCHER defense system may need to be created, for each coalition one.
+<p>Note that in order to create a two way A2A defense system, two AI_A2A_DISPATCHER defense system may need to be created, for each coalition one.
 This is a good implementation, because maybe in the future, more coalitions may become available in DCS world.</p>
 
-<h2>1. AI<em>A2A</em>DISPATCHER constructor:</h2>
+<h2>1. AI_A2A_DISPATCHER constructor:</h2>
 
-<p>The <a href="##(AI_A2A_DISPATCHER).New">AI<em>A2A</em>DISPATCHER.New</a>() method creates a new AI<em>A2A</em>DISPATCHER instance.
+<p>The <a href="##(AI_A2A_DISPATCHER).New">AI<em>A2A</em>DISPATCHER.New</a>() method creates a new AI_A2A_DISPATCHER instance.
 There are two parameters required, a <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a> that defines the Groups of the EWR network, and a radius in meters, that will be used to group the detected targets.</p>
 
 <p>The <a href="##(AI_A2A_DISPATCHER).New">AI<em>A2A</em>DISPATCHER.New</a>() method is used to setup the EWR network and to define the grouping.</p>
@@ -632,7 +632,7 @@ Having the radars further back will mean a slower escalation because fewer targe
 therefore less CAP and GCI flights will spawn and this will tend to make just the border area active rather than a melee over the whole map. 
 It all depends on what the desired effect is. </p>
 
-<p>EWR networks are dynamically constructed, that is, they form part of the <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a> object that is given as the input parameter of the AI<em>A2A</em>DISPATCHER class.
+<p>EWR networks are dynamically constructed, that is, they form part of the <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a> object that is given as the input parameter of the AI_A2A_DISPATCHER class.
 By defining in a smart way the names or name prefixes of the groups of EWR capable units, these units will be automatically added or deleted from the EWR network, 
 increasing or decreasing the radar coverage of the Early Warning System.</p>
 
@@ -686,7 +686,7 @@ If a hot war is chosen then <strong>no borders</strong> actually need to be defi
 
 <h2>4. Squadrons:</h2>
 
-<p>The AI<em>A2A</em>DISPATCHER works with <strong>Squadrons</strong>, that need to be defined using the different methods available.</p>
+<p>The AI_A2A_DISPATCHER works with <strong>Squadrons</strong>, that need to be defined using the different methods available.</p>
 
 <p>Use the method <a href="##(AI_A2A_DISPATCHER).SetSquadron">AI<em>A2A</em>DISPATCHER.SetSquadron</a>() to <strong>setup a new squadron</strong> active at an airfield, 
 while defining which plane types are being used by the squadron and how many resources are available.</p>
@@ -700,7 +700,7 @@ while defining which plane types are being used by the squadron and how many res
     <li>Have a limited set of resources.</li>
 </ul>
 
-<p>The name of the squadron given acts as the <strong>squadron key</strong> in the AI<em>A2A</em>DISPATCHER:Squadron...() methods.</p>
+<p>The name of the squadron given acts as the <strong>squadron key</strong> in the AI_A2A_DISPATCHER:Squadron...() methods.</p>
 
 <p>Additionally, squadrons have specific configuration options to:</p>
 

docs/Documentation/Cargo.html

@@ -2934,6 +2934,7 @@ The range till cargo will board.</p>
 		<dl class="function">
 <dt>
 
+		<em></em>
 <a id="#(CARGO_UNIT).CargoCarrier" >
 <strong>CARGO_UNIT.CargoCarrier</strong>
 </a>
@@ -3059,6 +3060,7 @@ The range till cargo will board.</p>
 		<dl class="function">
 <dt>
 
+		<em>#number</em>
 <a id="#(CARGO_UNIT).RunCount" >
 <strong>CARGO_UNIT.RunCount</strong>
 </a>

docs/Documentation/Detection.html

@@ -2387,6 +2387,7 @@ The index of the DetectedItem.</p>
 		<dl class="function">
 <dt>
 
+		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectedItemCount" >
 <strong>DETECTION_BASE.DetectedItemCount</strong>
 </a>
@@ -2400,6 +2401,7 @@ The index of the DetectedItem.</p>
 		<dl class="function">
 <dt>
 
+		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectedItemMax" >
 <strong>DETECTION_BASE.DetectedItemMax</strong>
 </a>
@@ -2557,7 +2559,7 @@ The index of the DetectedItem.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectionInterval" >
 <strong>DETECTION_BASE.DetectionInterval</strong>
 </a>

docs/Documentation/Point.html

@@ -2799,7 +2799,6 @@ The y coordinate.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(POINT_VEC2).z" >
 <strong>POINT_VEC2.z</strong>
 </a>

docs/Documentation/Settings.html

@@ -1073,7 +1073,7 @@ true if metric.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#boolean</em>
 <a id="#(SETTINGS).Metric" >
 <strong>SETTINGS.Metric</strong>
 </a>

docs/Documentation/Spawn.html

@@ -2732,9 +2732,6 @@ when nothing was spawned.</p>
 	
 
 
-	
-<p> Overwrite unit names by default with group name.</p>
-
 </dd>
 </dl>
 		<dl class="function">
@@ -3153,7 +3150,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
 
 
 	
-<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
+<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
 
 </dd>
 </dl>

docs/Documentation/Task_Cargo.html

@@ -510,7 +510,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
 <a id="#(FSM_PROCESS).Cargo" >
 <strong>FSM_PROCESS.Cargo</strong>
 </a>