MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-01-11 23:46:37 +00:00
parent 68d07e0c6c
commit 368ac306b9
123 changed files with 2098 additions and 1813 deletions
+335 -17
View File
@@ -212,7 +212,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo.html">AI.AI_Cargo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.4) - Models the intelligent transportation of infantry and other cargo.</p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p>
</p></div>
</div>
</div>
@@ -223,7 +223,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_APC.html">AI.AI_Cargo_APC</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.4) - Models the intelligent transportation of infantry and other cargo.</p>
<p><strong>AI</strong> - Models the intelligent transportation of cargo using ground vehicles.</p>
</p></div>
</div>
</div>
@@ -234,7 +234,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Airplane.html">AI.AI_Cargo_Airplane</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.4) - Models the intelligent transportation of infantry (cargo).</p>
<p><strong>AI</strong> - Models the intelligent transportation of cargo using airplanes.</p>
</p></div>
</div>
</div>
@@ -245,7 +245,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher.html">AI.AI_Cargo_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.4) - Models the intelligent transportation of infantry and other cargo.</p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p>
</p></div>
</div>
</div>
@@ -256,7 +256,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_APC.html">AI.AI_Cargo_Dispatcher_APC</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.</p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using APCs.</p>
</p></div>
</div>
</div>
@@ -306,7 +306,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Helicopter.html">AI.AI_Cargo_Helicopter</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.4) - Models the intelligent transportation of infantry (cargo).</p>
<p><strong>AI</strong> - Models the intelligent transportation of cargo using helicopters.</p>
</p></div>
</div>
</div>
@@ -438,7 +438,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.Cargo.html">Cargo.Cargo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> -- Management of CARGO logistics, that can be transported from and to transportation carriers.</p>
<p><strong>Cargo</strong> - Management of CARGO logistics, that can be transported from and to transportation carriers.</p>
</p></div>
</div>
</div>
@@ -460,7 +460,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoGroup.html">Cargo.CargoGroup</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> -- Management of grouped cargo logistics, which are based on a <a href="Wrapper.Group.html">Wrapper.Group</a> object.</p>
<p><strong>Cargo</strong> - Management of grouped cargo logistics, which are based on a <a href="Wrapper.Group.html">Wrapper.Group</a> object.</p>
</p></div>
</div>
</div>
@@ -482,7 +482,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoUnit.html">Cargo.CargoUnit</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> -- Management of single cargo logistics, which are based on a <a href="Wrapper.Unit.html">Wrapper.Unit</a> object.</p>
<p><strong>Cargo</strong> - Management of single cargo logistics, which are based on a <a href="Wrapper.Unit.html">Wrapper.Unit</a> object.</p>
</p></div>
</div>
</div>
@@ -1395,7 +1395,7 @@ Controls a network of SAM sites.</p>
</div>
<div class="w3-container w3-white" id="module_description">
<p><strong>AI</strong> -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.</p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using APCs.</p>
@@ -1588,7 +1588,7 @@ Use <a href="##(AI_CARGO_DISPATCHER_APC).SetHomeZone">AI_CARGO_DISPATCHER_APC.Se
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_DISPATCHER_APC).AICargo">AI_CARGO_DISPATCHER_APC:AICargo(APC, CargoSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>AI cargo</p>
</td>
</tr>
<tr class="w3-border">
@@ -1607,6 +1607,48 @@ Use <a href="##(AI_CARGO_DISPATCHER_APC).SetHomeZone">AI_CARGO_DISPATCHER_APC.Se
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_DISPATCHER_APC).SetCombatRadius">AI_CARGO_DISPATCHER_APC:SetCombatRadius(CombatRadius)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_DISPATCHER_APC).SetDeployOffRoad">AI_CARGO_DISPATCHER_APC:SetDeployOffRoad(Offroad, Formation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set whether the carrier will <em>not</em> use roads to <em>deploy</em> the cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_DISPATCHER_APC).SetOffRoad">AI_CARGO_DISPATCHER_APC:SetOffRoad(Offroad, Formation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set whether the carrier will <em>not</em> use roads to <em>pickup</em> and <em>deploy</em> the cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_DISPATCHER_APC).SetPickupOffRoad">AI_CARGO_DISPATCHER_APC:SetPickupOffRoad(Offroad, Formation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set whether the carrier will <em>not</em> use roads to <em>pickup</em> the cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_DISPATCHER_APC).deployFormation">AI_CARGO_DISPATCHER_APC.deployFormation</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_CARGO_DISPATCHER_APC).deployOffroad">AI_CARGO_DISPATCHER_APC.deployOffroad</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_CARGO_DISPATCHER_APC).pickupFormation">AI_CARGO_DISPATCHER_APC.pickupFormation</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_CARGO_DISPATCHER_APC).pickupOffroad">AI_CARGO_DISPATCHER_APC.pickupOffroad</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -2709,6 +2751,28 @@ 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">
<a id="#(AI_CARGO_DISPATCHER_APC).deployOffroad" ><strong>AI_CARGO_DISPATCHER_APC.deployOffroad</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_CARGO_DISPATCHER_APC).pickupOffroad" ><strong>AI_CARGO_DISPATCHER_APC.pickupOffroad</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
@@ -2718,7 +2782,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(AI_CARGO_DISPATCHER_APC).AICargo" ><strong>AI_CARGO_DISPATCHER_APC:AICargo(APC, CargoSet)</strong></a></h2>
</div>
<p>AI cargo</p>
<div id= "#Functions##AICargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -2730,23 +2794,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>APC</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The APC carrier.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Set.html##(SET_CARGO)">Core.Set#SET_CARGO</a>
<strong><strong>CargoSet</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Cargo set.</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.AI_Cargo_APC.html##(AI_CARGO_DISPATCHER_APC)">AI.AI_Cargo_APC#AI_CARGO_DISPATCHER_APC</a>:</p>
</div>
<div class="w3-half">
<p>AI cargo APC object.</p>
</div>
</div>
</div>
</div>
@@ -2888,7 +2969,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-half">
<p>Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby.
When the combat radius is 0, no defense will happen of the carrier.
When the combat radius is 0 (default), no defense will happen of the carrier.
When the combat radius is not provided, no defense will happen!</p>
</div>
@@ -2907,19 +2988,212 @@ When the combat radius is not provided, no defense will happen!</p>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Disembark the infantry when the carrier is under attack.
AICargoDispatcher:SetCombatRadius( true )
AICargoDispatcher:SetCombatRadius( 500 )
-- Keep the cargo in the carrier when the carrier is under attack.
AICargoDispatcher:SetCombatRadius( false )</code></pre>
AICargoDispatcher:SetCombatRadius( 0 )</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_CARGO_DISPATCHER_APC).SetDeployOffRoad" ><strong>AI_CARGO_DISPATCHER_APC:SetDeployOffRoad(Offroad, Formation)</strong></a></h2>
</div>
<p>Set whether the carrier will <em>not</em> use roads to <em>deploy</em> the cargo.</p>
<div id= "#Functions##SetDeployOffRoad" 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_CARGO_DISPATCHER_APC</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>
#boolean
<strong><strong>Offroad</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, carrier will not use roads.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Offroad formation used. Default is <code>ENUMS.Formation.Vehicle.Offroad</code>.</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_CARGO_DISPATCHER_APC)">#AI_CARGO_DISPATCHER_APC</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_CARGO_DISPATCHER_APC).SetOffRoad" ><strong>AI_CARGO_DISPATCHER_APC:SetOffRoad(Offroad, Formation)</strong></a></h2>
</div>
<p>Set whether the carrier will <em>not</em> use roads to <em>pickup</em> and <em>deploy</em> the cargo.</p>
<div id= "#Functions##SetOffRoad" 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_CARGO_DISPATCHER_APC</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>
#boolean
<strong><strong>Offroad</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, carrier will not use roads.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Offroad formation used. Default is <code>ENUMS.Formation.Vehicle.Offroad</code>.</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_CARGO_DISPATCHER_APC)">#AI_CARGO_DISPATCHER_APC</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_CARGO_DISPATCHER_APC).SetPickupOffRoad" ><strong>AI_CARGO_DISPATCHER_APC:SetPickupOffRoad(Offroad, Formation)</strong></a></h2>
</div>
<p>Set whether the carrier will <em>not</em> use roads to <em>pickup</em> the cargo.</p>
<div id= "#Functions##SetPickupOffRoad" 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_CARGO_DISPATCHER_APC</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>
#boolean
<strong><strong>Offroad</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, carrier will not use roads.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Offroad formation used. Default is <code>ENUMS.Formation.Vehicle.Offroad</code>.</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_CARGO_DISPATCHER_APC)">#AI_CARGO_DISPATCHER_APC</a>:</p>
</div>
<div class="w3-half">
<p>self</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">
<a id="#(AI_CARGO_DISPATCHER_APC).deployOffroad" ><strong>AI_CARGO_DISPATCHER_APC.deployOffroad</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_CARGO_DISPATCHER_APC).pickupOffroad" ><strong>AI_CARGO_DISPATCHER_APC.pickupOffroad</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
@@ -5041,6 +5315,28 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
<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">
<a id="#(AI_CARGO_DISPATCHER_APC).deployOffroad" ><strong>AI_CARGO_DISPATCHER_APC.deployOffroad</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_CARGO_DISPATCHER_APC).pickupOffroad" ><strong>AI_CARGO_DISPATCHER_APC.pickupOffroad</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
@@ -6491,6 +6787,28 @@ AICargoDispatcherHelicopter:SetPickupSpeed( 200, 100 )
<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">
<a id="#(AI_CARGO_DISPATCHER_APC).deployOffroad" ><strong>AI_CARGO_DISPATCHER_APC.deployOffroad</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(AI_CARGO_DISPATCHER_APC).pickupOffroad" ><strong>AI_CARGO_DISPATCHER_APC.pickupOffroad</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>