MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-18 15:12:58 +00:00
parent b0fd30be8c
commit 7e75232e34
32 changed files with 1007 additions and 796 deletions

View File

@@ -1845,6 +1845,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).BeaconTimer">CSAR.BeaconTimer</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).CallsignTranslations">CSAR.CallsignTranslations</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1863,6 +1869,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).FreeVHFFrequencies">CSAR.FreeVHFFrequencies</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).Keepnumber">CSAR.Keepnumber</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1977,6 +1989,18 @@ 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).SRSport">CSAR.SRSport</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).SetCallSignOptions">CSAR:SetCallSignOptions(ShortCallsign, Keepnumber, CallsignTranslations)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[User] Set callsign options for TTS output.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR).ShortCallsign">CSAR.ShortCallsign</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2133,6 +2157,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)._GetClosestMASH">CSAR:_GetClosestMASH(_heli)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Determine distance to closest MASH.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._GetCustomCallSign">CSAR:_GetCustomCallSign(UnitName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Check if a name is in downed pilot table and remove it.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2247,6 +2277,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)._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>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CSAR)._UpdateUnitCargoMass">CSAR:_UpdateUnitCargoMass(_heliName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to calculate and set Unit internal cargo mass</p>
</td>
</tr>
<tr class="w3-border">
@@ -3751,6 +3787,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CSAR).CallsignTranslations" ><strong>CSAR.CallsignTranslations</strong></a>
</div>
</div>
@@ -3904,6 +3951,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> port</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR).ShortCallsign" ><strong>CSAR.ShortCallsign</strong></a>
</div>
</div>
@@ -5435,6 +5493,80 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CSAR).SetCallSignOptions" ><strong>CSAR:SetCallSignOptions(ShortCallsign, Keepnumber, CallsignTranslations)</strong></a></h2>
</div>
<p>[User] Set callsign options for TTS output.</p>
<p>See <a href="Wrapper.Group.html##(GROUP).GetCustomCallSign">Wrapper.Group#GROUP.GetCustomCallSign</a>() on how to set customized callsigns.</p>
<div id= "#Functions##SetCallSignOptions" 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>CSAR</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>
#boolean
<strong><strong>ShortCallsign</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, only call out the major flight number</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Keepnumber</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, keep the <strong>customized callsign</strong> in the #GROUP name for players as-is, no amendments or numbers.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>CallsignTranslations</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized
callsigns from playername or group name.</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="##(CSAR)">#CSAR</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -6849,6 +6981,48 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CSAR)._GetCustomCallSign" ><strong>CSAR:_GetCustomCallSign(UnitName)</strong></a></h2>
</div>
<p>(Internal) Check if a name is in downed pilot table and remove it.</p>
<div id= "#Functions##_GetCustomCallSign" 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>CSAR</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>UnitName</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">
<p>#string:</p>
</div>
<div class="w3-half">
<p>CallSign</p>
</div>
</div>
</div>
</div>
</div>
@@ -7933,6 +8107,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CSAR)._UpdateUnitCargoMass" ><strong>CSAR:_UpdateUnitCargoMass(_heliName)</strong></a></h2>
</div>
<p>(Internal) Function to calculate and set Unit internal cargo mass</p>
<div id= "#Functions##_UpdateUnitCargoMass" 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>CSAR</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>_heliName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Unit name</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="##(CSAR)">#CSAR</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -8882,6 +9100,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CSAR).CallsignTranslations" ><strong>CSAR.CallsignTranslations</strong></a>
</div>
</div>
@@ -9035,6 +9264,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> port</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR).ShortCallsign" ><strong>CSAR.ShortCallsign</strong></a>
</div>
</div>
@@ -11274,6 +11514,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CSAR).CallsignTranslations" ><strong>CSAR.CallsignTranslations</strong></a>
</div>
</div>
@@ -11427,6 +11678,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> port</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CSAR).ShortCallsign" ><strong>CSAR.ShortCallsign</strong></a>
</div>
</div>