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
@@ -1677,11 +1677,32 @@ To send messages, you need to use the To functions.</p>
|
||||
<hr/>
|
||||
|
||||
<h3>Author: <strong>FlightControl</strong></h3>
|
||||
<h3>Contributions:</h3>
|
||||
<h3>Contributions: <strong>Applevangelist</strong></h3>
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="w3-theme-d2 w3-margin-top ">
|
||||
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##_MESSAGESRS')">
|
||||
<tr>
|
||||
<td class="style="width:40%;"><p><h2>Global <strong>_MESSAGESRS</strong></h2></p></td>
|
||||
<td class="style="width:60%;">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div id= "#Globals##_MESSAGESRS" class="w3-container w3-white w3-padding-small">
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#table
|
||||
<a id="_MESSAGESRS" ><strong>_MESSAGESRS</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -1707,6 +1728,12 @@ To send messages, you need to use the To functions.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ClearScreen">MESSAGE.ClearScreen</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="##(MESSAGE).CoalitionSide">MESSAGE.CoalitionSide</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1731,6 +1758,12 @@ To send messages, you need to use the To functions.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).NewType">MESSAGE:NewType(MessageText, MessageType, ClearScreen)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creates a new MESSAGE object of a certain type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).SetMSRS">MESSAGE.SetMSRS(PathToSRS, Port, PathToCredentials, Frequency, Modulation, Gender, Culture, Voice, Coalition, Volume, Label, Coordinate)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Set up MESSAGE generally to allow Text-To-Speech via SRS and TTS functions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1803,6 +1836,30 @@ To send messages, you need to use the To functions.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToRed">MESSAGE:ToRed()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a MESSAGE to the Red Coalition.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToSRS">MESSAGE:ToSRS(frequency, modulation, gender, culture, voice, coalition, volume, coordinate)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a message via SRS.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToSRSAll">MESSAGE:ToSRSAll(frequency, modulation, gender, culture, voice, volume, coordinate)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a message via SRS to all - via the neutral coalition side.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToSRSBlue">MESSAGE:ToSRSBlue(frequency, modulation, gender, culture, voice, volume, coordinate)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a message via SRS on the blue coalition side.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToSRSRed">MESSAGE:ToSRSRed(frequency, modulation, gender, culture, voice, volume, coordinate)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a message via SRS on the red coalition side.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2422,6 +2479,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="#(MESSAGE).CoalitionSide" ><strong>MESSAGE.CoalitionSide</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -2676,6 +2744,190 @@ The message display times are automatically defined based on the timing settings
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MESSAGE).SetMSRS" ><strong>MESSAGE.SetMSRS(PathToSRS, Port, PathToCredentials, Frequency, Modulation, Gender, Culture, Voice, Coalition, Volume, Label, Coordinate)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Set up MESSAGE generally to allow Text-To-Speech via SRS and TTS functions.</p>
|
||||
|
||||
<div id= "#Functions##SetMSRS" 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>MESSAGE</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>PathToSRS</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Path to SRS Folder, defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone".</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Port</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Port number of SRS, defaults to 5002.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>PathToCredentials</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Path to credentials file for e.g. Google.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Frequency</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Frequency in MHz. Can also be given as a #table of frequencies.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Modulation</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Gender</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Gender, i.e. "male" or "female", defaults to "male".</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="##(strimg)">#strimg</a>
|
||||
<strong><strong>Culture</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Culture, e.g. "en-US", defaults to "en-GB"</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Voice</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Voice. Will override gender and culture settings, e.g. MSRS.Voices.Microsoft.Hazel or MSRS.Voices.Google.Standard.de_DE_Standard_D. Hint on Microsoft voices - working voices are limited to Hedda, Hazel, David, Zira and Hortense. <strong>Must</strong> be installed on your Desktop or Server!</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Coalition</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coalition, can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. Defaults to coalition.side.NEUTRAL.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Volume</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Volume, can be between 0.0 and 1.0 (loudest).</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Label</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Label, defaults to "MESSAGE" or the Message Category set.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>Coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coordinate this messages originates from.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code> -- Mind the dot here, not using the colon this time around!
|
||||
-- Needed once only
|
||||
MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
|
||||
-- later on in your code
|
||||
MESSAGE:New("Test message!",15,"SPAWN"):ToAll():ToSRS()
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -3312,6 +3564,507 @@ The message display times are automatically defined based on the timing settings
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MESSAGE).ToSRS" ><strong>MESSAGE:ToSRS(frequency, modulation, gender, culture, voice, coalition, volume, coordinate)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a message via SRS.</p>
|
||||
|
||||
<div id= "#Functions##ToSRS" 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>MESSAGE</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>
|
||||
#number
|
||||
<strong><strong>frequency</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>modulation</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>gender</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="##(strimg)">#strimg</a>
|
||||
<strong><strong>culture</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>voice</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>coalition</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coalition, can be coalition.side.RED, coalition.side.BLUE or coalition.side.NEUTRAL. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>volume</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</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="##(MESSAGE)">#MESSAGE</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MESSAGE).ToSRSAll" ><strong>MESSAGE:ToSRSAll(frequency, modulation, gender, culture, voice, volume, coordinate)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a message via SRS to all - via the neutral coalition side.</p>
|
||||
|
||||
<div id= "#Functions##ToSRSAll" 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>MESSAGE</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>
|
||||
#number
|
||||
<strong><strong>frequency</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>modulation</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>gender</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="##(strimg)">#strimg</a>
|
||||
<strong><strong>culture</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>voice</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>volume</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</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="##(MESSAGE)">#MESSAGE</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MESSAGE).ToSRSBlue" ><strong>MESSAGE:ToSRSBlue(frequency, modulation, gender, culture, voice, volume, coordinate)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a message via SRS on the blue coalition side.</p>
|
||||
|
||||
<div id= "#Functions##ToSRSBlue" 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>MESSAGE</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>
|
||||
#number
|
||||
<strong><strong>frequency</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>modulation</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>gender</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="##(strimg)">#strimg</a>
|
||||
<strong><strong>culture</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>voice</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>volume</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</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="##(MESSAGE)">#MESSAGE</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(MESSAGE).ToSRSRed" ><strong>MESSAGE:ToSRSRed(frequency, modulation, gender, culture, voice, volume, coordinate)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a message via SRS on the red coalition side.</p>
|
||||
|
||||
<div id= "#Functions##ToSRSRed" 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>MESSAGE</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>
|
||||
#number
|
||||
<strong><strong>frequency</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Frequency in MHz. Can also be given as a #table of frequencies. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>modulation</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Modulation, i.e. radio.modulation.AM or radio.modulation.FM. Can also be given as a #table of modulations. Only needed if you want to override defaults set with <code>MESSAGE.SetMSRS()</code> for this one setting.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>gender</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Gender, i.e. "male" or "female". Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="##(strimg)">#strimg</a>
|
||||
<strong><strong>culture</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Culture, e.g. "en-US. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>voice</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Voice. Will override gender and culture settings. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>volume</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Volume, can be between 0.0 and 1.0 (loudest). Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
||||
<strong><strong>coordinate</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>(optional) Coordinate this messages originates from. Only needed if you want to change defaults set with <code>MESSAGE.SetMSRS()</code>.</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="##(MESSAGE)">#MESSAGE</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -3383,6 +4136,17 @@ The message display times are automatically defined based on the timing settings
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(MESSAGE).CoalitionSide" ><strong>MESSAGE.CoalitionSide</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user