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
@@ -2151,6 +2151,12 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GetCoalitionName">UTILS.GetCoalitionName(Coalition)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get the coalition name from its numerical ID, e.g.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GetCountPerTypeName">UTILS.GetCountPerTypeName(Group)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Function to obtain a table of typenames from the group given with the number of units of the same type in the group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2339,7 +2345,7 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).LoadSetOfGroups">UTILS.LoadSetOfGroups(Path, Filename, Spawn)</a></p></td>
|
||||
<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>
|
||||
@@ -2351,13 +2357,13 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).LoadStationaryListOfGroups">UTILS.LoadStationaryListOfGroups(Path, Filename, Reduce)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).LoadStationaryListOfGroups">UTILS.LoadStationaryListOfGroups(Path, Filename, Reduce, Structured, Cinematic, Effect, Density)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Load back a stationary list 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).LoadStationaryListOfStatics">UTILS.LoadStationaryListOfStatics(Path, Filename, Reduce)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).LoadStationaryListOfStatics">UTILS.LoadStationaryListOfStatics(Path, Filename, Reduce, Dead, Cinematic, Effect, Density)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Load back a stationary list of statics from file.</p>
|
||||
</td>
|
||||
@@ -2460,7 +2466,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).SaveSetOfGroups">UTILS.SaveSetOfGroups(Set, Path, Filename)</a></p></td>
|
||||
<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>
|
||||
@@ -2472,7 +2478,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).SaveStationaryListOfGroups">UTILS.SaveStationaryListOfGroups(List, Path, Filename)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).SaveStationaryListOfGroups">UTILS.SaveStationaryListOfGroups(List, 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 list of groups found by name</p>
|
||||
</td>
|
||||
@@ -3962,6 +3968,50 @@ 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).GetCountPerTypeName" ><strong>UTILS.GetCountPerTypeName(Group)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function to obtain a table of typenames from the group given with the number of units of the same type in the group.</p>
|
||||
|
||||
<div id= "#Functions##GetCountPerTypeName" 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>
|
||||
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
||||
<strong><strong>Group</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The group to list</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>Table of typnames and typename counts, e.g. <code>{["KAMAZ Truck"]=3,["ATZ-5"]=1}</code></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -5445,7 +5495,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).LoadSetOfGroups" ><strong>UTILS.LoadSetOfGroups(Path, Filename, Spawn)</strong></a></h2>
|
||||
<h2><a id="#(UTILS).LoadSetOfGroups" ><strong>UTILS.LoadSetOfGroups(Path, Filename, Spawn, Structured, Cinematic, Effect, Density)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Load back a SET of groups from file.</p>
|
||||
@@ -5496,17 +5546,77 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<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>(Optional, needs Spawn=true)If true, and the data has been saved as structure before, remove the correct unit types as per the saved list.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>Cinematic</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional, needs Structured=true) If true, place a fire/smoke effect on the dead static position.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Effect</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional for Cinematic) What effect to use. Defaults to a random effect. Smoke presets are: 1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Density</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional for Cinematic) What smoke density to use, can be 0 to 1. Defaults to 0.5.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<div class="w3-half">
|
||||
<p><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Set of GROUP objects.
|
||||
Returns nil when file cannot be read. Returns a table of data entries if Spawn is false: <code>{ groupname=groupname, size=size, coordinate=coordinate, template=template }</code></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#table:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>When using Cinematic: table of names of smoke and fire objects, so they can be extinguished with <code>COORDINATE.StopBigSmokeAndFire( name )</code></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -5573,7 +5683,7 @@ Returns nil when file cannot be read. Returns a table of data entries if Spawn i
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).LoadStationaryListOfGroups" ><strong>UTILS.LoadStationaryListOfGroups(Path, Filename, Reduce)</strong></a></h2>
|
||||
<h2><a id="#(UTILS).LoadStationaryListOfGroups" ><strong>UTILS.LoadStationaryListOfGroups(Path, Filename, Reduce, Structured, Cinematic, Effect, Density)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Load back a stationary list of groups from file.</p>
|
||||
@@ -5624,16 +5734,76 @@ Returns nil when file cannot be read. Returns a table of data entries if Spawn i
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<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>(Optional, needs Reduce = true) If true, and the data has been saved as structure before, remove the correct unit types as per the saved list.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>Cinematic</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional, needs Structured = true) If true, place a fire/smoke effect on the dead static position.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Effect</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional for Cinematic) What effect to use. Defaults to a random effect. Smoke presets are: 1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Density</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional for Cinematic) What smoke density to use, can be 0 to 1. Defaults to 0.5.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#table:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<div class="w3-half">
|
||||
<p>#table:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Table of data objects (tables) containing groupname, coordinate and group object. Returns nil when file cannot be read.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#table:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>When using Cinematic: table of names of smoke and fire objects, so they can be extinguished with <code>COORDINATE.StopBigSmokeAndFire( name )</code></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -5643,7 +5813,7 @@ Returns nil when file cannot be read. Returns a table of data entries if Spawn i
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).LoadStationaryListOfStatics" ><strong>UTILS.LoadStationaryListOfStatics(Path, Filename, Reduce)</strong></a></h2>
|
||||
<h2><a id="#(UTILS).LoadStationaryListOfStatics" ><strong>UTILS.LoadStationaryListOfStatics(Path, Filename, Reduce, Dead, Cinematic, Effect, Density)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Load back a stationary list of statics from file.</p>
|
||||
@@ -5694,17 +5864,77 @@ Returns nil when file cannot be read. Returns a table of data entries if Spawn i
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>Dead</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional, needs Reduce = true) If Dead is true, re-spawn the dead object as dead and do not just delete it.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>Cinematic</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional, needs Dead = true) If true, place a fire/smoke effect on the dead static position.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Effect</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional for Cinematic) What effect to use. Defaults to a random effect. Smoke presets are: 1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Density</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(Optional for Cinematic) What smoke density to use, can be 0 to 1. Defaults to 0.5.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return values:</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>Table of data objects (tables) containing staticname, size (0=dead else 1), coordinate and the static object.
|
||||
<div class="w3-half">
|
||||
<p>#table:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Table of data objects (tables) containing staticname, size (0=dead else 1), coordinate and the static object. Dead objects will have coordinate points <code>{x=0,y=0,z=0}</code></p>
|
||||
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p>#table:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>When using Cinematic: table of names of smoke and fire objects, so they can be extinguished with <code>COORDINATE.StopBigSmokeAndFire( name )</code>
|
||||
Returns nil when file cannot be read.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -6434,7 +6664,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).SaveSetOfGroups" ><strong>UTILS.SaveSetOfGroups(Set, Path, Filename)</strong></a></h2>
|
||||
<h2><a id="#(UTILS).SaveSetOfGroups" ><strong>UTILS.SaveSetOfGroups(Set, Path, Filename, Structured)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function to save the state of a set of Wrapper.Group#GROUP objects.</p>
|
||||
@@ -6483,6 +6713,19 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
|
||||
<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>
|
||||
@@ -6587,7 +6830,7 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS).SaveStationaryListOfGroups" ><strong>UTILS.SaveStationaryListOfGroups(List, Path, Filename)</strong></a></h2>
|
||||
<h2><a id="#(UTILS).SaveStationaryListOfGroups" ><strong>UTILS.SaveStationaryListOfGroups(List, Path, Filename, Structured)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Function to save the state of a list of groups found by name</p>
|
||||
@@ -6636,6 +6879,19 @@ The data will be a simple comma separated list of name and state etc, with one h
|
||||
|
||||
<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>
|
||||
|
||||
Reference in New Issue
Block a user