MOOSE generated documentation [skip ci]

Documentation/AI.AI_Cargo_Helicopter.html

@@ -1462,7 +1462,7 @@ Ensure that the landing zone is horizontally flat, and that trees cannot be foun
 
 <h2>Infantry health.</h2>
 
-<p>When infantry is unboarded from the APCs, the infantry is actually respawned into the battlefield. 
+<p>When infantry is unboarded from the helicopters, the infantry is actually respawned into the battlefield. 
 As a result, the unboarding infantry is very <em>healthy</em> every time it unboards.
 This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter.
 However, infantry that was destroyed when unboarded, won't be respawned again. Destroyed is destroyed.
@@ -1534,6 +1534,12 @@ time is not so much of an issue ... </p>
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).Helicopter">AI_CARGO_HELICOPTER.Helicopter</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_HELICOPTER).Home">AI_CARGO_HELICOPTER:Home(Coordinate, Speed, Height)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>Home Trigger for AI_CARGO_HELICOPTER</p>
 </td>
           </tr>
           <tr class="w3-border">
@@ -1546,12 +1552,30 @@ time is not so much of an issue ... </p>
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).OnAfterDeploy">AI_CARGO_HELICOPTER:OnAfterDeploy(From, Event, To, Coordinate, Speed)</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
 <p>Deploy Handler OnAfter for AI_CARGO_HELICOPTER</p>
+</td>
+          </tr>
+          <tr class="w3-border">
+            <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).OnAfterDeployed">AI_CARGO_HELICOPTER:OnAfterDeployed(From, Event, To)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>Deployed Handler OnAfter for AI_CARGO_HELICOPTER</p>
+</td>
+          </tr>
+          <tr class="w3-border">
+            <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).OnAfterPickedUp">AI_CARGO_HELICOPTER:OnAfterPickedUp(Helicopter, From, Event, To, Unit)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>PickedUp Handler OnAfter for AI_CARGO_HELICOPTER - Cargo set has been picked up, ready to deploy</p>
 </td>
           </tr>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).OnAfterPickup">AI_CARGO_HELICOPTER:OnAfterPickup(From, Event, To, Coordinate, Speed)</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
 <p>Pickup Handler OnAfter for AI_CARGO_HELICOPTER</p>
+</td>
+          </tr>
+          <tr class="w3-border">
+            <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).OnAfterUnloaded">AI_CARGO_HELICOPTER:OnAfterUnloaded(From, Event, To, Cargo, Unit)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>Unloaded Handler OnAfter for AI_CARGO_HELICOPTER - Cargo unloaded, carrier is empty</p>
 </td>
           </tr>
           <tr class="w3-border">
@@ -1618,6 +1642,12 @@ time is not so much of an issue ... </p>
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).__Deploy">AI_CARGO_HELICOPTER.__Deploy(Delay, self, Coordinate, Speed)</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
 <p>Deploy Asynchronous Trigger for AI_CARGO_HELICOPTER</p>
+</td>
+          </tr>
+          <tr class="w3-border">
+            <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_CARGO_HELICOPTER).__Home">AI_CARGO_HELICOPTER.__Home(Delay, self, Coordinate, Speed, Height)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>Home Asynchronous Trigger for AI_CARGO_HELICOPTER</p>
 </td>
           </tr>
           <tr class="w3-border">
@@ -2671,6 +2701,65 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
         </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_HELICOPTER).Home" ><strong>AI_CARGO_HELICOPTER:Home(Coordinate, Speed, Height)</strong></a></h2>
+</div>
+    
+<p>Home Trigger for AI_CARGO_HELICOPTER</p>
+
+<div id= "#Functions##Home" 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_HELICOPTER</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>
+                <a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
+            <strong><strong>Coordinate</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>Place to which the helicopter will go.</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                #number
+            <strong><strong>Speed</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>(optional) Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                #number
+            <strong><strong>Height</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>(optional) Height the Helicopter should by flying at.</p>
+
+          </div>
+        </div>
+</div>
+
 </div>
 </div>
 
@@ -2801,6 +2890,138 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
         </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_HELICOPTER).OnAfterDeployed" ><strong>AI_CARGO_HELICOPTER:OnAfterDeployed(From, Event, To)</strong></a></h2>
+</div>
+    
+<p>Deployed Handler OnAfter for AI_CARGO_HELICOPTER</p>
+
+<div id= "#Functions##OnAfterDeployed" 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_HELICOPTER</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>
+                #string
+            <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>
+                #string
+            <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>
+                #string
+            <strong><strong>To</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              <p></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_HELICOPTER).OnAfterPickedUp" ><strong>AI_CARGO_HELICOPTER:OnAfterPickedUp(Helicopter, From, Event, To, Unit)</strong></a></h2>
+</div>
+    
+<p>PickedUp Handler OnAfter for AI_CARGO_HELICOPTER - Cargo set has been picked up, ready to deploy</p>
+
+<div id= "#Functions##OnAfterPickedUp" 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_HELICOPTER</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>
+                <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
+            <strong><strong>Helicopter</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>The helicopter #GROUP object</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                #string
+            <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>
+                #string
+            <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>
+                #string
+            <strong><strong>To</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>
+                <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
+            <strong><strong>Unit</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>The helicopter #UNIT object</p>
+
+          </div>
+        </div>
+</div>
+
 </div>
 </div>
 
@@ -2878,6 +3099,85 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
         </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_HELICOPTER).OnAfterUnloaded" ><strong>AI_CARGO_HELICOPTER:OnAfterUnloaded(From, Event, To, Cargo, Unit)</strong></a></h2>
+</div>
+    
+<p>Unloaded Handler OnAfter for AI_CARGO_HELICOPTER - Cargo unloaded, carrier is empty</p>
+
+<div id= "#Functions##OnAfterUnloaded" 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_HELICOPTER</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>
+                #string
+            <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>
+                #string
+            <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>
+                #string
+            <strong><strong>To</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>
+                #string
+            <strong><strong>Cargo</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>CargoGroup#CARGO_GROUP Cargo The #CARGO_GROUP object.</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
+            <strong><strong>Unit</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>The helicopter #UNIT object</p>
+
+          </div>
+        </div>
+</div>
+
 </div>
 </div>
 
@@ -3253,6 +3553,89 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
         </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_HELICOPTER).__Home" ><strong>AI_CARGO_HELICOPTER.__Home(Delay, self, Coordinate, Speed, Height)</strong></a></h2>
+</div>
+    
+<p>Home Asynchronous Trigger for AI_CARGO_HELICOPTER</p>
+
+<div id= "#Functions##__Home" 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_HELICOPTER</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>
+                #number
+            <strong><strong>Delay</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>Delay in seconds.</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                <a href="##(AI_CARGO_HELICOPTER)">#AI_CARGO_HELICOPTER</a>
+            <strong><strong>self</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>
+                <a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
+            <strong><strong>Coordinate</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>Place to which the helicopter will go.</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                #number
+            <strong><strong>Speed</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>(optional) Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.</p>
+
+          </div>
+        </div>
+        <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
+          <div class="w3-half">
+            <p>
+                #number
+            <strong><strong>Height</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>(optional) Height the Helicopter should by flying at. </p>
+
+          </div>
+        </div>
+</div>
+
 </div>
 </div>