mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
New documentation version
This commit is contained in:
FlightControl_Master
@@ -129,9 +129,27 @@
|
||||
<h2><a id="#(MESSAGE)">Type <code>MESSAGE</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).MessageCategory">MESSAGE.MessageCategory</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).MessageDuration">MESSAGE.MessageDuration</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).New">MESSAGE:New(MessageText, MessageDuration, MessageCategory)</a></td>
|
||||
<td class="summary">
|
||||
<p>Creates a new MESSAGE object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).NewType">MESSAGE:NewType(MessageText, MessageType)</a></td>
|
||||
<td class="summary">
|
||||
<p>Creates a new MESSAGE object of a certain type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -153,13 +171,13 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToClient">MESSAGE:ToClient(Client)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToClient">MESSAGE:ToClient(Client, Settings)</a></td>
|
||||
<td class="summary">
|
||||
<p>Sends a MESSAGE to a Client Group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToCoalition">MESSAGE:ToCoalition(CoalitionSide)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToCoalition">MESSAGE:ToCoalition(CoalitionSide, Settings)</a></td>
|
||||
<td class="summary">
|
||||
<p>Sends a MESSAGE to a Coalition. </p>
|
||||
</td>
|
||||
@@ -171,7 +189,7 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToGroup">MESSAGE:ToGroup(Group)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToGroup">MESSAGE:ToGroup(Group, Settings)</a></td>
|
||||
<td class="summary">
|
||||
<p>Sends a MESSAGE to a Group. </p>
|
||||
</td>
|
||||
@@ -180,6 +198,46 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).ToRed">MESSAGE:ToRed()</a></td>
|
||||
<td class="summary">
|
||||
<p>Sends a MESSAGE to the Red Coalition. </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE).Type">MESSAGE.Type</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2><a id="#(MESSAGE.Type)">Type <code>MESSAGE.Type</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE.Type).Briefing">MESSAGE.Type.Briefing</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE.Type).Detailed">MESSAGE.Type.Detailed</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE.Type).Information">MESSAGE.Type.Information</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE.Type).Overview">MESSAGE.Type.Overview</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MESSAGE.Type).Update">MESSAGE.Type.Update</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -250,6 +308,33 @@ To send messages, you need to use the To functions.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).MessageCategory" >
|
||||
<strong>MESSAGE.MessageCategory</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(MESSAGE).MessageDuration" >
|
||||
<strong>MESSAGE.MessageDuration</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).New" >
|
||||
<strong>MESSAGE:New(MessageText, MessageDuration, MessageCategory)</strong>
|
||||
</a>
|
||||
@@ -303,6 +388,50 @@ MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).NewType" >
|
||||
<strong>MESSAGE:NewType(MessageText, MessageType)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<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.
|
||||
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>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string MessageText </em></code>:
|
||||
is the text of the Message.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="##(MESSAGE.Type)">#MESSAGE.Type</a> MessageType </em></code>:
|
||||
The type of the message.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(MESSAGE)">#MESSAGE</a>:</em></p>
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<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>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).ToAll" >
|
||||
<strong>MESSAGE:ToAll()</strong>
|
||||
</a>
|
||||
@@ -384,7 +513,7 @@ MessageBLUE:ToBlue()</code></pre>
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).ToClient" >
|
||||
<strong>MESSAGE:ToClient(Client)</strong>
|
||||
<strong>MESSAGE:ToClient(Client, Settings)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -394,13 +523,18 @@ MessageBLUE:ToBlue()</code></pre>
|
||||
|
||||
<p>Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> Client </em></code>:
|
||||
is the Group of the Client.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Settings </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
@@ -430,20 +564,25 @@ MessageClient2:ToClient( ClientGroup )</code></pre>
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).ToCoalition" >
|
||||
<strong>MESSAGE:ToCoalition(CoalitionSide)</strong>
|
||||
<strong>MESSAGE:ToCoalition(CoalitionSide, Settings)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Sends a MESSAGE to a Coalition. </p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> CoalitionSide </em></code>:
|
||||
needs to be filled out by the defined structure of the standard scripting engine <a href="coalition.side.html">coalition.side</a>. </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Settings </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
@@ -498,20 +637,25 @@ needs to be filled out by the defined structure of the standard scripting engine
|
||||
<dt>
|
||||
|
||||
<a id="#(MESSAGE).ToGroup" >
|
||||
<strong>MESSAGE:ToGroup(Group)</strong>
|
||||
<strong>MESSAGE:ToGroup(Group, Settings)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Sends a MESSAGE to a Group. </p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> Group </em></code>:
|
||||
is the Group.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Settings </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
@@ -546,6 +690,96 @@ 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>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="##(MESSAGE.Type)">#MESSAGE.Type</a></em>
|
||||
<a id="#(MESSAGE).Type" >
|
||||
<strong>MESSAGE.Type</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h2><a id="#(MESSAGE.Type)" >Type <code>MESSAGE.Type</code></a></h2>
|
||||
|
||||
<p>Message Types</p>
|
||||
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(MESSAGE.Type).Briefing" >
|
||||
<strong>MESSAGE.Type.Briefing</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(MESSAGE.Type).Detailed" >
|
||||
<strong>MESSAGE.Type.Detailed</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(MESSAGE.Type).Information" >
|
||||
<strong>MESSAGE.Type.Information</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(MESSAGE.Type).Overview" >
|
||||
<strong>MESSAGE.Type.Overview</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(MESSAGE.Type).Update" >
|
||||
<strong>MESSAGE.Type.Update</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user