mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -2048,7 +2048,7 @@
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).BasicSerialize">UTILS.BasicSerialize(s)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Basic serialize (porting in Slmod's "safestring" basic serialize).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2102,7 +2102,7 @@
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).DoString">UTILS.DoString(s)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Porting in Slmod's dostring - execute a string as LUA code with error handling.</p>
|
||||
<p>Executes the given string.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2127,6 +2127,12 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GMTToLocalTimeDifference">UTILS.GMTToLocalTimeDifference()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get the time difference between GMT and local time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).Gdump">UTILS.Gdump(fname)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Dumps the global table _G.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2473,7 +2479,7 @@
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).OneLineSerialize">UTILS.OneLineSerialize(tbl)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Porting in Slmod's serialize_slmod2.</p>
|
||||
<p>Serialize a given table.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2589,6 +2595,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).TACANToFrequency">UTILS.TACANToFrequency(TACANChannel, TACANMode)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Converts a TACAN Channel/Mode couple into a frequency in Hz.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).TableShow">UTILS.TableShow(tbl, loc, indent, tableshow_tbls)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns table in a easy readable string representation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2721,6 +2733,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS)._MarkID">UTILS._MarkID</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Marker index counter. Running number when marker is added.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS)._OneLineSerialize">UTILS._OneLineSerialize(tbl)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Serialize a table to a single line string.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3201,10 +3219,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<h2><a id="#(UTILS).BasicSerialize" ><strong>UTILS.BasicSerialize(s)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>porting in Slmod's "safestring" basic serialize</p>
|
||||
<p>Basic serialize (porting in Slmod's "safestring" basic serialize).</p>
|
||||
|
||||
<div id= "#Functions##BasicSerialize" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -3216,11 +3231,14 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>s</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Table to serialize.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -3602,7 +3620,10 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<h2><a id="#(UTILS).DoString" ><strong>UTILS.DoString(s)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Porting in Slmod's dostring - execute a string as LUA code with error handling.</p>
|
||||
<p>Executes the given string.</p>
|
||||
|
||||
|
||||
<p>borrowed from Slmod</p>
|
||||
|
||||
<div id= "#Functions##DoString" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -3620,28 +3641,20 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The code as string to be executed</p>
|
||||
<p>string containing LUA code.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>success If true, code was successfully executed, else false</p>
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p><code>true</code> if successfully executed, <code>false</code> otherwise.</p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#string:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Outcome Code outcome if successful or error string if not successful</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -3809,6 +3822,43 @@ 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).Gdump" ><strong>UTILS.Gdump(fname)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Dumps the global table _G.</p>
|
||||
|
||||
|
||||
<p>This dumps the global table <em>G to a file in the DCS\Logs directory.
|
||||
This function requires you to disable script sanitization in $DCS</em>ROOT\Scripts\MissionScripting.lua to access lfs and io libraries.</p>
|
||||
|
||||
<div id= "#Functions##Gdump" 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>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>fname</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>File name.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -6669,7 +6719,7 @@ Returns nil when file cannot be read.</p>
|
||||
<h2><a id="#(UTILS).OneLineSerialize" ><strong>UTILS.OneLineSerialize(tbl)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Porting in Slmod's serialize_slmod2.</p>
|
||||
<p>Serialize a given table.</p>
|
||||
|
||||
<div id= "#Functions##OneLineSerialize" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -6691,6 +6741,17 @@ Returns nil when file cannot be read.</p>
|
||||
|
||||
</div>
|
||||
</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>Table as a string.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -7948,6 +8009,78 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).TableShow" ><strong>UTILS.TableShow(tbl, loc, indent, tableshow_tbls)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns table in a easy readable string representation.</p>
|
||||
|
||||
<div id= "#Functions##TableShow" 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>
|
||||
<strong><strong>tbl</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>table to show</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<strong><strong>loc</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>
|
||||
<strong><strong>indent</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>
|
||||
<strong><strong>tableshow_tbls</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Human readable string representation of given table.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -9093,6 +9226,50 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS)._OneLineSerialize" ><strong>UTILS._OneLineSerialize(tbl)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Serialize a table to a single line string.</p>
|
||||
|
||||
<div id= "#Functions##_OneLineSerialize" 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>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>tbl</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>table to serialize.</p>
|
||||
|
||||
</div>
|
||||
</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>string containing serialized table.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user