MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-02-17 17:04:49 +00:00
parent 920ba8942f
commit 84852a22fe
26 changed files with 432 additions and 557 deletions

View File

@@ -1638,6 +1638,7 @@ Create a late-activated single infantry unit as template in the mission editor a
self.SRSModulation = radio.modulation.AM -- modulation
--
self.csarUsePara = false -- If set to true, will use the LandingAfterEjection Event instead of Ejection --shagrat
self.wetfeettemplate = "man in floating thingy" -- if you use a mod to have a pilot in a rescue float, put the template name in here for wet feet spawns
</code></pre>
<h2>3. Results</h2>
@@ -1907,7 +1908,7 @@ Create a late-activated single infantry unit as template in the mission editor a
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._CreateDownedPilotTrack">CSAR:_CreateDownedPilotTrack(Group, Groupname, Side, OriginalUnit, Description, Typename, Frequency, Playername)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._CreateDownedPilotTrack">CSAR:_CreateDownedPilotTrack(Group, Groupname, Side, OriginalUnit, Description, Typename, Frequency, Playername, Wetfeet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to insert downed pilot tracker object.</p>
</td>
@@ -2081,7 +2082,7 @@ Create a late-activated single infantry unit as template in the mission editor a
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._SpawnPilotInField">CSAR:_SpawnPilotInField(country, point, frequency)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._SpawnPilotInField">CSAR:_SpawnPilotInField(country, point, frequency, wetfeet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Spawn a downed pilot</p>
</td>
@@ -2486,6 +2487,12 @@ Create a late-activated single infantry unit as template in the mission editor a
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).useprefix">CSAR.useprefix</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="##(CSAR).usewetfeet">CSAR.usewetfeet</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2498,6 +2505,12 @@ Create a late-activated single infantry unit as template in the mission editor a
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).version">CSAR.version</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>CSAR class version.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).wetfeettemplate">CSAR.wetfeettemplate</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -3413,7 +3426,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR.DownedPilot).alive">CSAR.DownedPilot.alive</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Group is alive or dead/rescued</p>
<p>Group is alive or dead/rescued.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3467,13 +3480,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR.DownedPilot).timestamp">CSAR.DownedPilot.timestamp</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Timestamp for approach process</p>
<p>Timestamp for approach process.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR.DownedPilot).typename">CSAR.DownedPilot.typename</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Typename of Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR.DownedPilot).wetfeet">CSAR.DownedPilot.wetfeet</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Group is spawned over (deep) water.</p>
</td>
</tr>
</table>
@@ -3546,7 +3565,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).FreeVHFFrequencies" ><strong>CSAR.FreeVHFFrequencies</strong></a>
@@ -3848,14 +3867,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).csarUnits" ><strong>CSAR.csarUnits</strong></a>
<p> table of CSAR unit names</p>
</div>
</div>
@@ -3876,14 +3892,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).downedPilots" ><strong>CSAR.downedPilots</strong></a>
<p> Replacement woundedGroups</p>
</div>
</div>
@@ -4291,6 +4304,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR).usewetfeet" ><strong>CSAR.usewetfeet</strong></a>
</div>
</div>
@@ -5779,7 +5803,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CSAR)._CreateDownedPilotTrack" ><strong>CSAR:_CreateDownedPilotTrack(Group, Groupname, Side, OriginalUnit, Description, Typename, Frequency, Playername)</strong></a></h2>
<h2><a id="#(CSAR)._CreateDownedPilotTrack" ><strong>CSAR:_CreateDownedPilotTrack(Group, Groupname, Side, OriginalUnit, Description, Typename, Frequency, Playername, Wetfeet)</strong></a></h2>
</div>
<p>(Internal) Function to insert downed pilot tracker object.</p>
@@ -5893,6 +5917,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of Player (if applicable)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Wetfeet</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Ejected over water</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
@@ -7354,7 +7391,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CSAR)._SpawnPilotInField" ><strong>CSAR:_SpawnPilotInField(country, point, frequency)</strong></a></h2>
<h2><a id="#(CSAR)._SpawnPilotInField" ><strong>CSAR:_SpawnPilotInField(country, point, frequency, wetfeet)</strong></a></h2>
</div>
<p>(Internal) Spawn a downed pilot</p>
@@ -7403,6 +7440,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Frequency of the pilot's beacon</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>wetfeet</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Spawn is over water</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
@@ -8310,7 +8360,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).FreeVHFFrequencies" ><strong>CSAR.FreeVHFFrequencies</strong></a>
@@ -8612,14 +8662,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).csarUnits" ><strong>CSAR.csarUnits</strong></a>
<p> table of CSAR unit names</p>
</div>
</div>
@@ -8640,14 +8687,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).downedPilots" ><strong>CSAR.downedPilots</strong></a>
<p> Replacement woundedGroups</p>
</div>
</div>
@@ -9055,6 +9099,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR).usewetfeet" ><strong>CSAR.usewetfeet</strong></a>
</div>
</div>
@@ -10593,7 +10648,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).FreeVHFFrequencies" ><strong>CSAR.FreeVHFFrequencies</strong></a>
@@ -10895,14 +10950,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).csarUnits" ><strong>CSAR.csarUnits</strong></a>
<p> table of CSAR unit names</p>
</div>
</div>
@@ -10923,14 +10975,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CSAR).downedPilots" ><strong>CSAR.downedPilots</strong></a>
<p> Replacement woundedGroups</p>
</div>
</div>
@@ -11338,6 +11387,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Use the Prefixed defined below, Requires Unit have the Prefix defined below </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR).usewetfeet" ><strong>CSAR.usewetfeet</strong></a>
</div>
</div>
@@ -14776,7 +14836,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
#boolean
<a id="#(CSAR.DownedPilot).alive" ><strong>CSAR.DownedPilot.alive</strong></a>
<p>Group is alive or dead/rescued</p>
<p>Group is alive or dead/rescued.</p>
</div>
@@ -14875,7 +14935,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
#number
<a id="#(CSAR.DownedPilot).timestamp" ><strong>CSAR.DownedPilot.timestamp</strong></a>
<p>Timestamp for approach process</p>
<p>Timestamp for approach process.</p>
</div>
@@ -14890,6 +14950,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR.DownedPilot).wetfeet" ><strong>CSAR.DownedPilot.wetfeet</strong></a>
<p>Group is spawned over (deep) water.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>