MOOSE generated documentation [skip ci]

Documentation/DCS.html

@@ -609,6 +609,17 @@
          </div>
          <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
 <p><strong>Core</strong> - Informs the players using messages during a simulation.</p>
+</p></div>
+       </div>         
+     </div>
+     <div class="w3-col s12 m6 l4">
+       <div class="w3-card-4 w3-white w3-margin-16">
+         <div class="w3-display-container w3-text-white w3-text-shadow">
+           <img src= "../Images/CORE_Pathline.png" alt="Image">
+           <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Pathline.html">Core.Pathline</a></strong></h2></div>
+         </div>
+         <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
+<p><strong>Core</strong> - Path from A to B.</p>
 </p></div>
        </div>         
      </div>
@@ -6649,13 +6660,19 @@ First value indicates if at least one of the unit's radar(s) is on.</p>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land).getHeight">land.getHeight(point)</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-<p>Returns altitude MSL of the point.</p>
+<p>Returns the distance from sea level (y-axis) of a given vec2 point.</p>
+</td>
+          </tr>
+          <tr class="w3-border">
+            <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land).getSurfaceHeightWithSeabed">land.getSurfaceHeightWithSeabed(point)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>Returns the surface height and depth of a point.</p>
 </td>
           </tr>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land).getSurfaceType">land.getSurfaceType(point)</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-<p>returns surface type at the given point.</p>
+<p>Returns surface type at the given point.</p>
 </td>
           </tr>
         </table>
@@ -6674,31 +6691,31 @@ First value indicates if at least one of the unit's radar(s) is on.</p>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land.SurfaceType).LAND">land.SurfaceType.LAND</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-
+<p>Land=1</p>
 </td>
           </tr>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land.SurfaceType).ROAD">land.SurfaceType.ROAD</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-
+<p>Road=4</p>
 </td>
           </tr>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land.SurfaceType).RUNWAY">land.SurfaceType.RUNWAY</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-
+<p>Runway=5</p>
 </td>
           </tr>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land.SurfaceType).SHALLOW_WATER">land.SurfaceType.SHALLOW_WATER</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-
+<p>Shallow water=2</p>
 </td>
           </tr>
           <tr class="w3-border">
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(land.SurfaceType).WATER">land.SurfaceType.WATER</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
-
+<p>Water=3</p>
 </td>
           </tr>
         </table>
@@ -13456,7 +13473,7 @@ If sensor type is not specified the function returns true if the unit has at lea
 <h2><a id="#(land).getHeight" ><strong>land.getHeight(point)</strong></a></h2>
 </div>
     
-<p>Returns altitude MSL of the point.</p>
+<p>Returns the distance from sea level (y-axis) of a given vec2 point.</p>
 
 <div id= "#Functions##getHeight" class="w3-show w3-white">
   <div class="w3-container w3-white" id="functiontype">
@@ -13474,23 +13491,80 @@ If sensor type is not specified the function returns true if the unit has at lea
           </div>
           <div class="w3-half">
               
-<p>point on the ground. </p>
+<p>Point on the ground. </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="##(Distance)">#Distance</a>:</p>
+        <p>#number:</p>
       </div>
       <div class="w3-half">
         
-
+<p>Height in meters.</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="#(land).getSurfaceHeightWithSeabed" ><strong>land.getSurfaceHeightWithSeabed(point)</strong></a></h2>
+</div>
+    
+<p>Returns the surface height and depth of a point.</p>
+
+    
+<p>Useful for checking if the path is deep enough to support a given ship. 
+Both values are positive. When checked over water at sea level the first value is always zero. 
+When checked over water at altitude, for example the reservoir of the Inguri Dam, the first value is the corresponding altitude the water level is at.</p>
+
+<div id= "#Functions##getSurfaceHeightWithSeabed" 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>land</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>
+                <a href="##(Vec2)">#Vec2</a>
+            <strong><strong>point</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>Position where to check.</p>
+
+          </div>
+        </div>
+    <h2><strong>Return values:</strong></h2>
+    <div class="w3-row w3-border-bottom w3-margin-left">
+        <div class="w3-half">
+          <p>#number:</p>
+        </div>
+        <div class="w3-half">
+          
+<p>Height in meters.</p>
+
+        </div>
+        <div class="w3-half">
+          <p>#number:</p>
+        </div>
+        <div class="w3-half">
+          
+<p>Depth in meters.</p>
+
+        </div>
+    </div>
+</div>
+
 </div>
 </div>
 
@@ -13500,7 +13574,7 @@ If sensor type is not specified the function returns true if the unit has at lea
 <h2><a id="#(land).getSurfaceType" ><strong>land.getSurfaceType(point)</strong></a></h2>
 </div>
     
-<p>returns surface type at the given point.</p>
+<p>Returns surface type at the given point.</p>
 
 <div id= "#Functions##getSurfaceType" class="w3-show w3-white">
   <div class="w3-container w3-white" id="functiontype">
@@ -13525,11 +13599,11 @@ If sensor type is not specified the function returns true if the unit has at lea
     <h2><strong>Return value:</strong></h2>
     <div class="w3-row w3-border-bottom w3-margin-left">
       <div class="w3-half">
-        <p><a href="##(land.SurfaceType)">#land.SurfaceType</a>:</p>
+        <p>#number:</p>
       </div>
       <div class="w3-half">
         
-
+<p>Enumerator value from <code>land.SurfaceType</code> (LAND=1, SHALLOW_WATER=2, WATER=3, ROAD=4, RUNWAY=5)</p>
 
       </div>
     </div>