MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-01-03 09:27:39 +00:00
parent bdaa4f1ba7
commit 8a201a505b
31 changed files with 9721 additions and 1196 deletions

View File

@@ -2145,6 +2145,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GetCharacters">UTILS.GetCharacters(str)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get a table of all characters in a string.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GetCoalitionEnemy">UTILS.GetCoalitionEnemy(Coalition, Neutral)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the enemy coalition for a given coalition.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2247,6 +2253,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).HdgDiff">UTILS.HdgDiff(h1, h2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the difference between two "heading", i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).IsAnyInTable">UTILS.IsAnyInTable(Table, Objects, Key)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if any object of multiple given objects is contained in a table.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2259,6 +2271,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).IsInSphere">UTILS.IsInSphere(InVec3, Vec3, Radius)</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="##(UTILS).IsInTable">UTILS.IsInTable(Table, Object, Key)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if an object is contained in a table.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3921,6 +3939,63 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).GetCoalitionEnemy" ><strong>UTILS.GetCoalitionEnemy(Coalition, Neutral)</strong></a></h2>
</div>
<p>Get the enemy coalition for a given coalition.</p>
<div id= "#Functions##GetCoalitionEnemy" 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>UTILS</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>Coalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The coalition ID.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Neutral</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Include neutral as enemy.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>Enemy coalition table.</p>
</div>
</div>
</div>
</div>
</div>
@@ -4918,6 +4993,76 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).IsAnyInTable" ><strong>UTILS.IsAnyInTable(Table, Objects, Key)</strong></a></h2>
</div>
<p>Check if any object of multiple given objects is contained in a table.</p>
<div id= "#Functions##IsAnyInTable" 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>UTILS</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>
#table
<strong><strong>Table</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The table.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Objects</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The objects to check.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Key</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Key to check.</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="##(booolen)">#booolen</a>:</p>
</div>
<div class="w3-half">
<p>Returns <code>true</code> if object is in table.</p>
</div>
</div>
</div>
</div>
</div>
@@ -5024,6 +5169,76 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).IsInTable" ><strong>UTILS.IsInTable(Table, Object, Key)</strong></a></h2>
</div>
<p>Check if an object is contained in a table.</p>
<div id= "#Functions##IsInTable" 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>UTILS</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>
#table
<strong><strong>Table</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The table.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The object to check.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Key</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Key to check. By default, the object itself is checked.</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="##(booolen)">#booolen</a>:</p>
</div>
<div class="w3-half">
<p>Returns <code>true</code> if object is in table.</p>
</div>
</div>
</div>
</div>
</div>
@@ -8045,7 +8260,7 @@ The data will be a simple comma separated list of name and state etc, with one h
</div>
<div class="w3-half">
<p>Vector in 3D with x, y components.</p>
<p>Vector in 2D with x, y components.</p>
</div>
</div>
@@ -8058,7 +8273,7 @@ The data will be a simple comma separated list of name and state etc, with one h
</div>
<div class="w3-half">
<p>Vector in 3D with x, y components.</p>
<p>Vector in 2D with x, y components.</p>
</div>
</div>