MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2018-11-06 19:20:44 +00:00
parent 9dba09b54f
commit 4bd6b83337
18 changed files with 631 additions and 512 deletions
+314 -10
View File
@@ -2351,6 +2351,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).CountDefendersToBeEngaged">AI_A2A_DISPATCHER:CountDefendersToBeEngaged(AttackerDetection, DefenderCount)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).DefenderCAPIndex">AI_A2A_DISPATCHER.DefenderCAPIndex</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2519,6 +2525,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).GetSquadronTakeoff">AI_A2A_DISPATCHER:GetSquadronTakeoff(SquadronName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the method at which new flights will spawn and take-off as part of the defense system.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).IsSquadronVisible">AI_A2A_DISPATCHER:IsSquadronVisible(SquadronName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the Squadron is visible before startup of the dispatcher.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2597,6 +2609,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).OnEventLand">AI_A2A_DISPATCHER:OnEventLand(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).ParkDefender">AI_A2A_DISPATCHER:ParkDefender(DefenderSquadron)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2609,6 +2627,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).RemoveDefenderFromSquadron">AI_A2A_DISPATCHER:RemoveDefenderFromSquadron(Squadron, Defender)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).ResourceActivate">AI_A2A_DISPATCHER:ResourceActivate(DefenderSquadron, DefendersNeeded)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2762,7 +2786,7 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).SetSquadron">AI_A2A_DISPATCHER:SetSquadron(SquadronName, AirbaseName, TemplatePrefixes, Resources)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).SetSquadron">AI_A2A_DISPATCHER:SetSquadron(SquadronName, AirbaseName, TemplatePrefixes, ResourceCount)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This is the main method to define Squadrons programmatically.</p>
</td>
@@ -2867,6 +2891,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).SetSquadronTanker">AI_A2A_DISPATCHER:SetSquadronTanker(SquadronName, TankerName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the squadron tanker where defenders will Refuel in the air.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).SetSquadronVisible">AI_A2A_DISPATCHER:SetSquadronVisible(SquadronName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the Squadron visible before startup of the dispatcher.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2927,6 +2957,12 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).onafterGCI">AI_A2A_DISPATCHER:onafterGCI(From, Event, To, AttackerDetection, DefendersMissing, DefenderFriendlies)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_DISPATCHER).onafterStart">AI_A2A_DISPATCHER:onafterStart(From, Event, To)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -3795,13 +3831,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_GCICAP).New">AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, Resources)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_GCICAP).New">AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, ResourceCount)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>AI_A2A_GCICAP constructor.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_GCICAP).NewWithBorder">AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, Resources)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_A2A_GCICAP).NewWithBorder">AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, ResourceCount)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>AI_A2A_GCICAP constructor with border.</p>
</td>
@@ -3830,6 +3866,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A_DISPATCHER).DefenderCAPIndex" ><strong>AI_A2A_DISPATCHER.DefenderCAPIndex</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -5013,6 +5060,56 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_DISPATCHER).IsSquadronVisible" ><strong>AI_A2A_DISPATCHER:IsSquadronVisible(SquadronName)</strong></a></h2>
</div>
<p>Check if the Squadron is visible before startup of the dispatcher.</p>
<div id= "#Functions##IsSquadronVisible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>AI_A2A_DISPATCHER</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>SquadronName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The squadron name.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(bool)">#bool</a>:</p>
</div>
<div class="w3-half">
<p>true if visible.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Set the Squadron visible before startup of dispatcher.
local IsVisible = A2ADispatcher:IsSquadronVisible( "Mineralnye" )
</code></pre>
</div>
</div>
</div>
@@ -5645,6 +5742,36 @@ The Detection object is polymorphic, depending on the type of detection object c
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_DISPATCHER).ParkDefender" ><strong>AI_A2A_DISPATCHER:ParkDefender(DefenderSquadron)</strong></a></h2>
</div>
<div id= "#Functions##ParkDefender" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>AI_A2A_DISPATCHER</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>DefenderSquadron</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
@@ -5729,6 +5856,46 @@ The Detection object is polymorphic, depending on the type of detection object c
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_DISPATCHER).ResourceActivate" ><strong>AI_A2A_DISPATCHER:ResourceActivate(DefenderSquadron, DefendersNeeded)</strong></a></h2>
</div>
<div id= "#Functions##ResourceActivate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>AI_A2A_DISPATCHER</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>DefenderSquadron</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>DefendersNeeded</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
@@ -7053,7 +7220,7 @@ when you don't want to let the AI_A2A_DISPATCHER react immediately when a certai
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_DISPATCHER).SetSquadron" ><strong>AI_A2A_DISPATCHER:SetSquadron(SquadronName, AirbaseName, TemplatePrefixes, Resources)</strong></a></h2>
<h2><a id="#(AI_A2A_DISPATCHER).SetSquadron" ><strong>AI_A2A_DISPATCHER:SetSquadron(SquadronName, AirbaseName, TemplatePrefixes, ResourceCount)</strong></a></h2>
</div>
<p>This is the main method to define Squadrons programmatically.</p>
@@ -7151,7 +7318,7 @@ If you have only one prefix name for a squadron, you don't need to use the <code
<div class="w3-half">
<p>
#number
<strong><strong>Resources</strong></strong>
<strong><strong>ResourceCount</strong></strong>
</p>
</div>
<div class="w3-half">
@@ -7190,7 +7357,7 @@ If you have only one prefix name for a squadron, you don't need to use the <code
A2ADispatcher:SetSquadron( "23th", "Batumi", "Su-27", 10 )
</code></pre></li>
<li><pre class="example"><code> -- This is an example like the previous, but now with infinite resources.
-- The Resources parameter is not given in the SetSquadron method.
-- The ResourceCount parameter is not given in the SetSquadron method.
A2ADispatcher:SetSquadron( "104th", "Batumi", "Mig-29" )
A2ADispatcher:SetSquadron( "23th", "Batumi", "Su-27" )
@@ -8449,6 +8616,60 @@ multiplied by the Overhead and rounded up to the smallest integer. </p>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_DISPATCHER).SetSquadronVisible" ><strong>AI_A2A_DISPATCHER:SetSquadronVisible(SquadronName)</strong></a></h2>
</div>
<p>Set the Squadron visible before startup of the dispatcher.</p>
<p>All planes will be spawned as uncontrolled on the parking spot.
They will lock the parking spot.</p>
<div id= "#Functions##SetSquadronVisible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>AI_A2A_DISPATCHER</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>SquadronName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The squadron name.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(AI_A2A_DISPATCHER)">#AI_A2A_DISPATCHER</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Set the Squadron visible before startup of dispatcher.
A2ADispatcher:SetSquadronVisible( "Mineralnye" )
</code></pre>
</div>
</div>
</div>
@@ -8811,12 +9032,73 @@ multiplied by the Overhead and rounded up to the smallest integer. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_DISPATCHER).onafterStart" ><strong>AI_A2A_DISPATCHER:onafterStart(From, Event, To)</strong></a></h2>
</div>
<div id= "#Functions##onafterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>AI_A2A_DISPATCHER</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>To</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A_DISPATCHER).DefenderCAPIndex" ><strong>AI_A2A_DISPATCHER.DefenderCAPIndex</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -9823,6 +10105,17 @@ multiplied by the Overhead and rounded up to the smallest integer. </p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A_DISPATCHER).DefenderCAPIndex" ><strong>AI_A2A_DISPATCHER.DefenderCAPIndex</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -11115,6 +11408,17 @@ multiplied by the Overhead and rounded up to the smallest integer. </p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A_DISPATCHER).DefenderCAPIndex" ><strong>AI_A2A_DISPATCHER.DefenderCAPIndex</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -13879,7 +14183,7 @@ BASE:TraceOnOff( false )</code></pre>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_GCICAP).New" ><strong>AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, Resources)</strong></a></h2>
<h2><a id="#(AI_A2A_GCICAP).New" ><strong>AI_A2A_GCICAP:New(EWRPrefixes, TemplatePrefixes, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, ResourceCount)</strong></a></h2>
</div>
<p>AI_A2A_GCICAP constructor.</p>
@@ -13987,7 +14291,7 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
<div class="w3-half">
<p>
#number
<strong><strong>Resources</strong></strong>
<strong><strong>ResourceCount</strong></strong>
</p>
</div>
<div class="w3-half">
@@ -14086,7 +14390,7 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_A2A_GCICAP).NewWithBorder" ><strong>AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, Resources)</strong></a></h2>
<h2><a id="#(AI_A2A_GCICAP).NewWithBorder" ><strong>AI_A2A_GCICAP:NewWithBorder(EWRPrefixes, TemplatePrefixes, BorderPrefix, CapPrefixes, CapLimit, GroupingRadius, EngageRadius, GciRadius, ResourceCount)</strong></a></h2>
</div>
<p>AI_A2A_GCICAP constructor with border.</p>
@@ -14207,7 +14511,7 @@ For airplanes, 6000 (6km) is recommended, and is also the default value of this
<div class="w3-half">
<p>
#number
<strong><strong>Resources</strong></strong>
<strong><strong>ResourceCount</strong></strong>
</p>
</div>
<div class="w3-half">