MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-04-21 07:59:54 +00:00
parent 02cddf5ae3
commit 8879373892
25 changed files with 2100 additions and 420 deletions

View File

@@ -1541,6 +1541,27 @@ Controls a network of short range air/missile defense groups.</p>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##Spot')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>Spot</strong></h2></p></td>
<td class="style="width:60%;">
</td>
</tr>
</table>
</div>
<div id= "#Globals##Spot" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(Spot)">#Spot</a>
<a id="Spot" ><strong>Spot</strong></a>
</div>
</div>
@@ -3442,6 +3463,12 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Group).destroy">Group:destroy()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Destroys the group and all of its units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Group).enableEmission">Group:enableEmission(switch)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>GROUND - Switch on/off radar emissions</p>
</td>
</tr>
<tr class="w3-border">
@@ -3748,6 +3775,98 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Position3).z">Position3.z</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Orientation component of vector pointing North.</p>
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Spot)">Type <strong>Spot</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(Spot)">Spot</a></strong>
</div>
<div class="w3-card w3-margin">
<table class="w3-table w3-border-bottom w3-border-theme-l2">
<tr class="w3-theme-l1">
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from Spot</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).Category">Spot.Category</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>enum that stores spot categories. </p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).createInfraRed">Spot.createInfraRed(Source, LocalRef, Vec3)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates an infrared ray emanating from the given object to a point in 3d space.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).createLaser">Spot.createLaser(Source, LocalRef, Vec3, LaserCode)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a laser ray emanating from the given object to a point in 3d space.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).destroy">Spot:destroy()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Destroys the spot.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).getCategory">Spot:getCategory()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the category of the spot (laser or IR).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).getCode">Spot:getCode()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the number that is used to define the laser code for which laser designation can track.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).getPoint">Spot:getPoint()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).setCode">Spot:setCode(Code)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets the number that is used to define the laser code for which laser designation can track.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot).setPoint">Spot:setPoint(Vec3)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets the destination point from which the source of the spot is drawn toward.</p>
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Spot.Category)">Type <strong>Spot.Category</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(Spot.Category)">Spot.Category</a></strong>
</div>
<div class="w3-card w3-margin">
<table class="w3-table w3-border-bottom w3-border-theme-l2">
<tr class="w3-theme-l1">
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from Spot.Category</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Spot.Category).INFRA_RED">Spot.Category.INFRA_RED</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="##(Spot.Category).LASER">Spot.Category.LASER</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -3895,6 +4014,12 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Unit).SensorType">Unit.SensorType</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="##(Unit).enableEmission">Unit:enableEmission(switch)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>GROUND - Switch on/off radar emissions</p>
</td>
</tr>
<tr class="w3-border">
@@ -8116,6 +8241,37 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName]
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(Group).enableEmission" ><strong>Group:enableEmission(switch)</strong></a></h2>
</div>
<p>GROUND - Switch on/off radar emissions</p>
<div id= "#Functions##enableEmission" 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>Group</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>
#boolean
<strong><strong>switch</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
@@ -8981,6 +9137,404 @@ OptionValue = AI.Option.Air.val[optionName] or AI.Option.Ground.val[optionName]
<p>Orientation component of vector pointing North.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
</div>
</div>
<div onclick="myFunction('#Types##Spot')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Spot)">Type <strong>Spot</strong></a></h2></div>
<div id= "#Types##Spot" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p><a href="https://wiki.hoggitworld.com/view/DCS_Class_Spot">DCS Class Spot</a>
Represents a spot from laser or IR-pointer.</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">
<a href="##(Spot.Category)">#Spot.Category</a>
<a id="#(Spot).Category" ><strong>Spot.Category</strong></a>
<p>enum that stores spot categories. </p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(Spot).createInfraRed" ><strong>Spot.createInfraRed(Source, LocalRef, Vec3)</strong></a></h2>
</div>
<p>Creates an infrared ray emanating from the given object to a point in 3d space.</p>
<p>Can be seen with night vision goggles.</p>
<div id= "#Functions##createInfraRed" 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>Spot</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="DCS.html##(Object)">DCS#Object</a>
<strong><strong>Source</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Source position of the IR ray.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>LocalRef</strong></strong>
</p>
</div>
<div class="w3-half">
<p>An optional 3D offset for the source.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>Vec3</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Target coordinate where the ray is pointing at.</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="##(Spot)">#Spot</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(Spot).createLaser" ><strong>Spot.createLaser(Source, LocalRef, Vec3, LaserCode)</strong></a></h2>
</div>
<p>Creates a laser ray emanating from the given object to a point in 3d space.</p>
<div id= "#Functions##createLaser" 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>Spot</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="DCS.html##(Object)">DCS#Object</a>
<strong><strong>Source</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The source object of the laser.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>LocalRef</strong></strong>
</p>
</div>
<div class="w3-half">
<p>An optional 3D offset for the source.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>Vec3</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Target coordinate where the ray is pointing at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LaserCode</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Any 4 digit number between 1111 and 1788.</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="##(Spot)">#Spot</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(Spot).destroy" ><strong>Spot:destroy()</strong></a></h2>
</div>
<p>Destroys the spot.</p>
<div id= "#Functions##destroy" 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>Spot</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(Spot).getCategory" ><strong>Spot:getCategory()</strong></a></h2>
</div>
<p>Gets the category of the spot (laser or IR).</p>
<div id= "#Functions##getCategory" 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>Spot</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>Category.</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="#(Spot).getCode" ><strong>Spot:getCode()</strong></a></h2>
</div>
<p>Returns the number that is used to define the laser code for which laser designation can track.</p>
<div id= "#Functions##getCode" 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>Spot</p>
</div>
<h2><strong>Return value:</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>Code The laser code used.</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="#(Spot).getPoint" ><strong>Spot:getPoint()</strong></a></h2>
</div>
<p>Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space.</p>
<p>Coordinates are dependent on the position of the maps origin.</p>
<div id= "#Functions##getPoint" 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>Spot</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Point in 3D, where the beam is pointing at.</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="#(Spot).setCode" ><strong>Spot:setCode(Code)</strong></a></h2>
</div>
<p>Sets the number that is used to define the laser code for which laser designation can track.</p>
<div id= "#Functions##setCode" 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>Spot</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>
#number
<strong><strong>Code</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The laser code. Default value is 1688.</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="#(Spot).setPoint" ><strong>Spot:setPoint(Vec3)</strong></a></h2>
</div>
<p>Sets the destination point from which the source of the spot is drawn toward.</p>
<div id= "#Functions##setPoint" 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>Spot</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="DCS.html##(Vec3)">DCS#Vec3</a>
<strong><strong>Vec3</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Point in 3D, where the beam is pointing at.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div onclick="myFunction('#Types##Spot.Category')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Spot.Category)">Type <strong>Spot.Category</strong></a></h2></div>
<div id= "#Types##Spot.Category" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>Enum that stores spot categories. </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">
#string
<a id="#(Spot.Category).INFRA_RED" ><strong>Spot.Category.INFRA_RED</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(Spot.Category).LASER" ><strong>Spot.Category.LASER</strong></a>
</div>
</div>
@@ -9229,6 +9783,37 @@ In MOOSE, these tasks can be accessed via <a href="Wrapper.Controllable.html##(C
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(Unit).enableEmission" ><strong>Unit:enableEmission(switch)</strong></a></h2>
</div>
<p>GROUND - Switch on/off radar emissions</p>
<div id= "#Functions##enableEmission" 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>Unit</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>
#boolean
<strong><strong>switch</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="#(Unit).getAmmo" ><strong>Unit:getAmmo()</strong></a></h2>
</div>