weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2023-03-05 10:23:56 +00:00
parent 6b01bc2c94
commit 0798b676ab
21 changed files with 619 additions and 966 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
Documentation/Wrapper.Group.html
View File

@@ -1960,7 +1960,7 @@ Use the following Zone validation methods on the group:</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetCustomCallSign">GROUP:GetCustomCallSign(ShortCallsign, Keepnumber, CallsignTranslations)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get TTS friendly, optionally customized callsign mainly for <strong>player groups</strong>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5933,11 +5933,7 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction.
<h2><a id="#(GROUP).GetCustomCallSign" ><strong>GROUP:GetCustomCallSign(ShortCallsign, Keepnumber, CallsignTranslations)</strong></a></h2>
</div>
<p>Get TTS friendly, optionally customized callsign mainly for <strong>player groups</strong>.</p>
<p>A customized callsign is taken from the #GROUP name, after an optional '#' sign, e.g. "Aerial 1-1#Ghostrider" resulting in "Ghostrider 9", or,
if that isn't available, from the playername, as set in the mission editor main screen under Logbook, after an optional '|' sign (actually, more of a personal call sign), e.g. "Apple|Moose" results in "Moose 9 1". Options see below.</p>
<div id= "#Functions##GetCustomCallSign" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5949,70 +5945,33 @@ if that isn't available, from the playername, as set in the mission editor main
<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>Return a shortened customized callsign, i.e. "Ghostrider 9" and not "Ghostrider 9 1"</p>
<p></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>(Player only) Return customized callsign, incl optional numbers at the end, e.g. "Aerial 1-1#Ghostrider 109" results in "Ghostrider 109", if you want to e.g. use historical US Navy Callsigns</p>
<p></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>Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized
callsigns from playername or group name.</p>
<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>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code> -- Set Custom CAP Flight Callsigns for use with TTS
mygroup:GetCustomCallSign(true,false,{
Devil = 'Bengal',
Snake = 'Winder',
Colt = 'Camelot',
Enfield = 'Victory',
Uzi = 'Evil Eye'
})
results in this outcome if the group has Callsign "Enfield 9 1" on the 1st #UNIT of the group:
'Victory 9'
</code></pre>
</div>
</div>