Auto commit by GitHub Actions Workflow

This commit is contained in:
MooseBotter
2024-02-27 17:16:33 +00:00
parent 440726d2e4
commit 51b97b9339
34 changed files with 1139 additions and 906 deletions

View File

@@ -2462,6 +2462,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).LoadSetOfGroups">UTILS.LoadSetOfGroups(Path, Filename, Spawn, Structured, Cinematic, Effect, Density)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Load back a SET of groups from file.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).LoadSetOfOpsGroups">UTILS.LoadSetOfOpsGroups(Path, Filename)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Load back a #OPSGROUP (ARMYGROUP) data from file for use with <a href="Ops.Brigade.html##(BRIGADE).LoadBackAssetInPosition">Ops.Brigade#BRIGADE.LoadBackAssetInPosition</a>()</p>
</td>
</tr>
<tr class="w3-border">
@@ -2631,6 +2637,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).SaveSetOfGroups">UTILS.SaveSetOfGroups(Set, Path, Filename, Structured)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to save the state of a set of Wrapper.Group#GROUP objects.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).SaveSetOfOpsGroups">UTILS.SaveSetOfOpsGroups(Set, Path, Filename, Structured)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to save the position of a set of #OPSGROUP (ARMYGROUP) objects.</p>
</td>
</tr>
<tr class="w3-border">
@@ -6626,6 +6638,64 @@ Returns nil when file cannot be read. Returns a table of data entries if Spawn i
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).LoadSetOfOpsGroups" ><strong>UTILS.LoadSetOfOpsGroups(Path, Filename)</strong></a></h2>
</div>
<p>Load back a #OPSGROUP (ARMYGROUP) data from file for use with <a href="Ops.Brigade.html##(BRIGADE).LoadBackAssetInPosition">Ops.Brigade#BRIGADE.LoadBackAssetInPosition</a>()</p>
<div id= "#Functions##LoadSetOfOpsGroups" 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>
#string
<strong><strong>Path</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The path to use. Use double backslashes \\ on Windows filesystems.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Filename</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the file.</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>Returns a table of data entries: <code>{ groupname=groupname, size=size, coordinate=coordinate, template=template, structure=structure, legion=legion, alttemplate=alttemplate }</code>
Returns nil when the file cannot be read. </p>
</div>
</div>
</div>
</div>
</div>
@@ -8370,6 +8440,89 @@ The current task/waypoint/etc cannot be restored. </code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).SaveSetOfOpsGroups" ><strong>UTILS.SaveSetOfOpsGroups(Set, Path, Filename, Structured)</strong></a></h2>
</div>
<p>Function to save the position of a set of #OPSGROUP (ARMYGROUP) objects.</p>
<div id= "#Functions##SaveSetOfOpsGroups" 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>
<a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>
<strong><strong>Set</strong></strong>
</p>
</div>
<div class="w3-half">
<p>of ops objects to save</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Path</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The path to use. Use double backslashes \\ on Windows filesystems.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Filename</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the file.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Structured</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Append the data with a list of typenames in the group plus their count.</p>
</div>
</div>
<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>outcome True if saving is successful, else false.</p>
</div>
</div>
</div>
</div>
</div>