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
@@ -1648,25 +1648,25 @@ To send messages, you need to use the To functions.</p>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToCoalition">MESSAGE:ToCoalition(CoalitionSide, Settings)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a MESSAGE to a Coalition. </p>
|
||||
<p>Sends a MESSAGE to a Coalition.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToCoalitionIf">MESSAGE:ToCoalitionIf(CoalitionSide, Condition)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a MESSAGE to a Coalition if the given Condition is true. </p>
|
||||
<p>Sends a MESSAGE to a Coalition if the given Condition is true.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MESSAGE).ToGroup">MESSAGE:ToGroup(Group, Settings)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sends a MESSAGE to a Group. </p>
|
||||
<p>Sends a MESSAGE to a Group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<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>
|
||||
<p>Sends a MESSAGE to the Red Coalition.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2323,7 +2323,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<p>Clears all previous messages from the screen before the new message is displayed.</p>
|
||||
|
||||
|
||||
<p>Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc. </p>
|
||||
<p>Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc.</p>
|
||||
|
||||
<div id= "#Functions##Clear" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2429,15 +2429,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Create a series of new Messages.
|
||||
-- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
|
||||
-- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
|
||||
-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
|
||||
-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
|
||||
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", 25, "End of Mission" )
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
|
||||
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", 25, "Score" )
|
||||
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")</code></pre>
|
||||
<pre class="example"><code>
|
||||
-- Create a series of new Messages.
|
||||
-- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
|
||||
-- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
|
||||
-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
|
||||
-- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
|
||||
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", 25, "End of Mission" )
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
|
||||
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", 25, "Score" )
|
||||
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2453,7 +2455,7 @@ MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25
|
||||
<p>Creates a new MESSAGE object of a certain type.</p>
|
||||
|
||||
|
||||
<p>Note that these MESSAGE objects are not yet displayed on the display panel.
|
||||
<p>Note that these MESSAGE objects are not yet displayed on the display panel.
|
||||
You must use the functions <a href="ToClient.html">ToClient</a> or <a href="ToCoalition.html">ToCoalition</a> or <a href="ToAll.html">ToAll</a> to send these Messages to the respective recipients.
|
||||
The message display times are automatically defined based on the timing settings in the <a href="Settings.html">Settings</a> menu.</p>
|
||||
|
||||
@@ -2515,10 +2517,12 @@ The message display times are automatically defined based on the timing settings
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code> MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
|
||||
<pre class="example"><code>
|
||||
MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
|
||||
MessageRED = MESSAGE:NewType( "To the RED Players: You receive a penalty because you've killed one of your own units", MESSAGE.Type.Information )
|
||||
MessageClient1 = MESSAGE:NewType( "Congratulations, you've just hit a target", MESSAGE.Type.Update )
|
||||
MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )</code></pre>
|
||||
MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2565,13 +2569,15 @@ The message display times are automatically defined based on the timing settings
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Send a message created to all players.
|
||||
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
|
||||
or
|
||||
MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
|
||||
or
|
||||
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
|
||||
MessageAll:ToAll()</code></pre>
|
||||
<pre class="example"><code>
|
||||
-- Send a message created to all players.
|
||||
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
|
||||
or
|
||||
MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
|
||||
or
|
||||
MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
|
||||
MessageAll:ToAll()
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2645,13 +2651,15 @@ MessageAll:ToAll()</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Send a message created with the @{New} method to the BLUE coalition.
|
||||
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
|
||||
or
|
||||
MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
|
||||
or
|
||||
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
|
||||
MessageBLUE:ToBlue()</code></pre>
|
||||
<pre class="example"><code>
|
||||
-- Send a message created with the @{New} method to the BLUE coalition.
|
||||
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
|
||||
or
|
||||
MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
|
||||
or
|
||||
MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
|
||||
MessageBLUE:ToBlue()
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2714,20 +2722,22 @@ MessageBLUE:ToBlue()</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Send the 2 messages created with the @{New} method to the Client Group.
|
||||
-- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
|
||||
ClientGroup = Group.getByName( "ClientGroup" )
|
||||
<pre class="example"><code>
|
||||
-- Send the 2 messages created with the @{New} method to the Client Group.
|
||||
-- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
|
||||
ClientGroup = Group.getByName( "ClientGroup" )
|
||||
|
||||
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
or
|
||||
MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
or
|
||||
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
|
||||
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
|
||||
MessageClient1:ToClient( ClientGroup )
|
||||
MessageClient2:ToClient( ClientGroup )</code></pre>
|
||||
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
or
|
||||
MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
|
||||
or
|
||||
MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
|
||||
MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
|
||||
MessageClient1:ToClient( ClientGroup )
|
||||
MessageClient2:ToClient( ClientGroup )
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2740,7 +2750,7 @@ MessageClient2:ToClient( ClientGroup )</code></pre>
|
||||
<h2><a id="#(MESSAGE).ToCoalition" ><strong>MESSAGE:ToCoalition(CoalitionSide, Settings)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a MESSAGE to a Coalition. </p>
|
||||
<p>Sends a MESSAGE to a Coalition.</p>
|
||||
|
||||
<div id= "#Functions##ToCoalition" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2787,13 +2797,15 @@ MessageClient2:ToClient( ClientGroup )</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Send a message created with the @{New} method to the RED coalition.
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
|
||||
or
|
||||
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
|
||||
or
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
|
||||
MessageRED:ToCoalition( coalition.side.RED )</code></pre>
|
||||
<pre class="example"><code>
|
||||
-- Send a message created with the @{New} method to the RED coalition.
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
|
||||
or
|
||||
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
|
||||
or
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
|
||||
MessageRED:ToCoalition( coalition.side.RED )
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2806,7 +2818,7 @@ MessageRED:ToCoalition( coalition.side.RED )</code></pre>
|
||||
<h2><a id="#(MESSAGE).ToCoalitionIf" ><strong>MESSAGE:ToCoalitionIf(CoalitionSide, Condition)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a MESSAGE to a Coalition if the given Condition is true. </p>
|
||||
<p>Sends a MESSAGE to a Coalition if the given Condition is true.</p>
|
||||
|
||||
<div id= "#Functions##ToCoalitionIf" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2836,7 +2848,7 @@ MessageRED:ToCoalition( coalition.side.RED )</code></pre>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Sends the message only if the condition is true. </p>
|
||||
<p>Sends the message only if the condition is true.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2862,7 +2874,7 @@ MessageRED:ToCoalition( coalition.side.RED )</code></pre>
|
||||
<h2><a id="#(MESSAGE).ToGroup" ><strong>MESSAGE:ToGroup(Group, Settings)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a MESSAGE to a Group. </p>
|
||||
<p>Sends a MESSAGE to a Group.</p>
|
||||
|
||||
<div id= "#Functions##ToGroup" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2916,7 +2928,7 @@ MessageRED:ToCoalition( coalition.side.RED )</code></pre>
|
||||
<h2><a id="#(MESSAGE).ToRed" ><strong>MESSAGE:ToRed()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sends a MESSAGE to the Red Coalition. </p>
|
||||
<p>Sends a MESSAGE to the Red Coalition.</p>
|
||||
|
||||
<div id= "#Functions##ToRed" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -2936,13 +2948,15 @@ MessageRED:ToCoalition( coalition.side.RED )</code></pre>
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>-- Send a message created with the @{New} method to the RED coalition.
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
|
||||
or
|
||||
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
|
||||
or
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
|
||||
MessageRED:ToRed()</code></pre>
|
||||
<pre class="example"><code>
|
||||
-- Send a message created with the @{New} method to the RED coalition.
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
|
||||
or
|
||||
MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
|
||||
or
|
||||
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
|
||||
MessageRED:ToRed()
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user