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

New documentation version

Browse Source
This commit is contained in:
FlightControl_Master 2017-09-13 21:41:46 +02:00
parent f47ac8baaf
commit 887faacdb1
18 changed files with 4557 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/Documentation/Account.html
View File

@ -245,19 +245,19 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ACCOUNT_DEADS).onafterEvent">ACT_ACCOUNT_DEADS:onafterEvent(ProcessClient, Task, From, Event, To, EventData)</a></td>
<td class="name" nowrap="nowrap"><a href="##(ACT_ACCOUNT_DEADS).onafterEvent">ACT_ACCOUNT_DEADS:onafterEvent(ProcessUnit, Task, From, Event, To, EventData)</a></td>
<td class="summary">
<p>StateMachine callback function</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ACCOUNT_DEADS).onenterAccountForOther">ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessClient, Task, From, Event, To, EventData)</a></td>
<td class="name" nowrap="nowrap"><a href="##(ACT_ACCOUNT_DEADS).onenterAccountForOther">ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessUnit, Task, From, Event, To, EventData)</a></td>
<td class="summary">
<p>StateMachine callback function</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ACT_ACCOUNT_DEADS).onenterAccountForPlayer">ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessClient, Task, From, Event, To, EventData)</a></td>
<td class="name" nowrap="nowrap"><a href="##(ACT_ACCOUNT_DEADS).onenterAccountForPlayer">ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessUnit, Task, From, Event, To, EventData)</a></td>
<td class="summary">
<p>StateMachine callback function</p>
</td>
@ -444,7 +444,7 @@ There are 2 moments when state transition methods will be called by the state ma
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -480,7 +480,7 @@ There are 2 moments when state transition methods will be called by the state ma
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -516,7 +516,7 @@ There are 2 moments when state transition methods will be called by the state ma
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -747,7 +747,7 @@ Each successful dead will trigger an Account state transition that can be scored
<dt>
<a id="#(ACT_ACCOUNT_DEADS).onafterEvent" >
<strong>ACT_ACCOUNT_DEADS:onafterEvent(ProcessClient, Task, From, Event, To, EventData)</strong>
<strong>ACT_ACCOUNT_DEADS:onafterEvent(ProcessUnit, Task, From, Event, To, EventData)</strong>
</a>
</dt>
<dd>
@ -758,7 +758,7 @@ Each successful dead will trigger an Account state transition that can be scored
<ul>
<li>
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> ProcessClient </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -793,7 +793,7 @@ Each successful dead will trigger an Account state transition that can be scored
<dt>
<a id="#(ACT_ACCOUNT_DEADS).onenterAccountForOther" >
<strong>ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessClient, Task, From, Event, To, EventData)</strong>
<strong>ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessUnit, Task, From, Event, To, EventData)</strong>
</a>
</dt>
<dd>
@ -804,7 +804,7 @@ Each successful dead will trigger an Account state transition that can be scored
<ul>
<li>
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> ProcessClient </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -839,7 +839,7 @@ Each successful dead will trigger an Account state transition that can be scored
<dt>
<a id="#(ACT_ACCOUNT_DEADS).onenterAccountForPlayer" >
<strong>ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessClient, Task, From, Event, To, EventData)</strong>
<strong>ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessUnit, Task, From, Event, To, EventData)</strong>
</a>
</dt>
<dd>
@ -850,7 +850,7 @@ Each successful dead will trigger an Account state transition that can be scored
<ul>
<li>
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> ProcessClient </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -896,7 +896,7 @@ Each successful dead will trigger an Account state transition that can be scored
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>

6
docs/Documentation/Assign.html
View File

@ -957,7 +957,7 @@ self</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -993,7 +993,7 @@ self</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -1029,7 +1029,7 @@ self</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>

76
docs/Documentation/CommandCenter.html
View File

@ -212,9 +212,21 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COMMANDCENTER).MessageToGroup">COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name)</a></td>
<td class="name" nowrap="nowrap"><a href="##(COMMANDCENTER).MessageToGroup">COMMANDCENTER:MessageToGroup(Message, TaskGroup)</a></td>
<td class="summary">
<p>Send a CC message to a GROUP.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COMMANDCENTER).MessageTypeToCoalition">COMMANDCENTER:MessageTypeToCoalition(Message, MessageType)</a></td>
<td class="summary">
<p>Send a CC message of a specified type to the coalition of the CC.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COMMANDCENTER).MessageTypeToGroup">COMMANDCENTER:MessageTypeToGroup(Message, TaskGroup, MessageType)</a></td>
<td class="summary">
<p>Send a CC message of a specified type to a GROUP.</p>
</td>
</tr>
<tr>
@ -591,7 +603,7 @@ true if in WWII mode.</p>
<dt>
<a id="#(COMMANDCENTER).MessageToGroup" >
<strong>COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name)</strong>
<strong>COMMANDCENTER:MessageToGroup(Message, TaskGroup)</strong>
</a>
</dt>
<dd>
@ -610,10 +622,64 @@ true if in WWII mode.</p>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> TaskGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COMMANDCENTER).MessageTypeToCoalition" >
<strong>COMMANDCENTER:MessageTypeToCoalition(Message, MessageType)</strong>
</a>
</dt>
<dd>
<p>Send a CC message of a specified type to the coalition of the CC.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="##(sring)">#sring</a> Name </em></code>:
(optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.</p>
<p><code><em>#string Message </em></code>:
The message.</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE.MessageType)">Core.Message#MESSAGE.MessageType</a> MessageType </em></code>:
The type of the message, resulting in automatic time duration and prefix of the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COMMANDCENTER).MessageTypeToGroup" >
<strong>COMMANDCENTER:MessageTypeToGroup(Message, TaskGroup, MessageType)</strong>
</a>
</dt>
<dd>
<p>Send a CC message of a specified type to a GROUP.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>: </p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> TaskGroup </em></code>: </p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE.MessageType)">Core.Message#MESSAGE.MessageType</a> MessageType </em></code>:
The type of the message, resulting in automatic time duration and prefix of the message.</p>
</li>
</ul>
@ -849,8 +915,6 @@ The name before the #-mark indicating the class of the Reference Zones.</p>
<h2><a id="#(list)" >Type <code>list</code></a></h2>
<h2><a id="#(sring)" >Type <code>sring</code></a></h2>
</div>
</div>

4
docs/Documentation/Designate.html
View File

@ -1151,10 +1151,6 @@ function below will use the range 1-7 just in case</p>
<dl class="function">
<dt>
<<<<<<< HEAD
<em></em>
=======
>>>>>>> master
<a id="#(DESIGNATE).LaserCodes" >
<strong>DESIGNATE.LaserCodes</strong>
</a>

21
docs/Documentation/Detection.html
View File

@ -1062,12 +1062,6 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedItem).Set">DETECTION_BASE.DetectedItem.Set</a></td>
<td class="summary">
<p>-- The Set of Units in the detected area.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedItem).ThreatLevel">DETECTION_BASE.DetectedItem.ThreatLevel</a></td>
<td class="summary">
</td>
</tr>
<tr>
@ -2466,7 +2460,6 @@ The index of the DetectedItem.</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE).DetectedItemCount" >
<strong>DETECTION_BASE.DetectedItemCount</strong>
</a>
@ -5009,20 +5002,6 @@ The To State string.</p>
<p>-- The Set of Units in the detected area.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(DETECTION_BASE.DetectedItem).ThreatLevel" >
<strong>DETECTION_BASE.DetectedItem.ThreatLevel</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">

3
docs/Documentation/Fsm.html
View File

@ -1599,7 +1599,7 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em></em>
<em>#string</em>
<a id="#(FSM)._StartState" >
<strong>FSM._StartState</strong>
</a>
@ -1898,7 +1898,6 @@ A string defining the start state.</p>
<dl class="function">
<dt>
<em></em>
<a id="#(FSM).current" >
<strong>FSM.current</strong>
</a>

252
docs/Documentation/Message.html
View File

@ -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>

17
docs/Documentation/Mission.html
View File

@ -619,7 +619,7 @@
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).onenterCOMPLETED">MISSION:onenterCOMPLETED(From, Event, To)</a></td>
<td class="summary">
<p>FSM function for a MISSION</p>
</td>
</tr>
</table>
@ -2731,30 +2731,23 @@ The delay in seconds.</p>
</dt>
<dd>
<p> FSM function for a MISSION
@param #MISSION self
@param #string From
@param #string Event
@param #string To</p>
<p>FSM function for a MISSION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> From </em></code>: </p>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>

260
docs/Documentation/Point.html
View File

@ -268,12 +268,30 @@
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetDistanceText">COORDINATE:GetDistanceText(Distance, Settings)</a></td>
<td class="summary">
<p>Provides a distance text expressed in the units of measurement.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetHeading">COORDINATE:GetHeading()</a></td>
<td class="summary">
<p>Get the heading of the coordinate, if applicable.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetHeadingText">COORDINATE:GetHeadingText(Settings)</a></td>
<td class="summary">
<p>Return the heading text of the COORDINATE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetLandHeight">COORDINATE:GetLandHeight()</a></td>
<td class="summary">
<p>Return the height of the land at the coordinate.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetMovingText">COORDINATE:GetMovingText(Settings)</a></td>
<td class="summary">
<p>Return velocity text of the COORDINATE.</p>
</td>
</tr>
<tr>
@ -304,6 +322,24 @@
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetVec3">COORDINATE:GetVec3()</a></td>
<td class="summary">
<p>Return the coordinates of the COORDINATE in Vec3 format.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetVelocity">COORDINATE:GetVelocity()</a></td>
<td class="summary">
<p>Return the velocity of the COORDINATE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).GetVelocityText">COORDINATE:GetVelocityText(Settings)</a></td>
<td class="summary">
<p>Return the velocity text of the COORDINATE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).Heading">COORDINATE.Heading</a></td>
<td class="summary">
</td>
</tr>
<tr>
@ -340,6 +376,12 @@
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MarkToCoalitionRed">COORDINATE:MarkToCoalitionRed(MarkText)</a></td>
<td class="summary">
<p>Mark to Red Coalition</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MarkToGroup">COORDINATE:MarkToGroup(MarkText, MarkGroup)</a></td>
<td class="summary">
<p>Mark to Group</p>
</td>
</tr>
<tr>
@ -369,7 +411,13 @@
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).SetHeading">COORDINATE:SetHeading(Heading)</a></td>
<td class="summary">
<p>Set the heading of the coordinate, if applicable.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).SetVelocity">COORDINATE:SetVelocity(Velocity)</a></td>
<td class="summary">
<p>Set the velocity of the COORDINATE.</p>
</td>
</tr>
<tr>
@ -480,6 +528,12 @@
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).Translate">COORDINATE:Translate(Distance, Angle)</a></td>
<td class="summary">
<p>Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).Velocity">COORDINATE.Velocity</a></td>
<td class="summary">
</td>
</tr>
<tr>
@ -1572,6 +1626,50 @@ The distance text expressed in the units of measurement.</p>
<dl class="function">
<dt>
<a id="#(COORDINATE).GetHeading" >
<strong>COORDINATE:GetHeading()</strong>
</a>
</dt>
<dd>
<p>Get the heading of the coordinate, if applicable.</p>
<h3>Return value</h3>
<p><em>#number:</em>
or nil</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).GetHeadingText" >
<strong>COORDINATE:GetHeadingText(Settings)</strong>
</a>
</dt>
<dd>
<p>Return the heading text of the COORDINATE.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Settings </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
Heading text.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).GetLandHeight" >
<strong>COORDINATE:GetLandHeight()</strong>
</a>
@ -1585,6 +1683,32 @@ The distance text expressed in the units of measurement.</p>
<p><em>#number:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).GetMovingText" >
<strong>COORDINATE:GetMovingText(Settings)</strong>
</a>
</dt>
<dd>
<p>Return velocity text of the COORDINATE.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Settings </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
@ -1701,6 +1825,64 @@ The Vec2 format coordinate.</p>
<p><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a>:</em>
The Vec3 format coordinate.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).GetVelocity" >
<strong>COORDINATE:GetVelocity()</strong>
</a>
</dt>
<dd>
<p>Return the velocity of the COORDINATE.</p>
<h3>Return value</h3>
<p><em>#number:</em>
Velocity in meters per second.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).GetVelocityText" >
<strong>COORDINATE:GetVelocityText(Settings)</strong>
</a>
</dt>
<dd>
<p>Return the velocity text of the COORDINATE.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Settings </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
Velocity text.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(COORDINATE).Heading" >
<strong>COORDINATE.Heading</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@ -1874,6 +2056,44 @@ The resulting Mark ID which is a number.</p>
<dl class="function">
<dt>
<a id="#(COORDINATE).MarkToGroup" >
<strong>COORDINATE:MarkToGroup(MarkText, MarkGroup)</strong>
</a>
</dt>
<dd>
<p>Mark to Group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string MarkText </em></code>:
Free format text that shows the marking clarification.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MarkGroup </em></code>:
The <a href="Group.html">Group</a> that receives the mark.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#number:</em>
The resulting Mark ID which is a number.</p>
<h3>Usage:</h3>
<pre class="example"><code> local TargetCoord = TargetGroup:GetCoordinate()
local MarkGroup = GROUP:FindByName( "AttackGroup" )
local MarkID = TargetCoord:MarkToGroup( "This is a target for the attack group", AttackGroup )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).New" >
<strong>COORDINATE:New(x, y, z)</strong>
</a>
@ -2008,7 +2228,7 @@ The ID of the mark to be removed.</p>
</dt>
<dd>
<p>Set the heading of the coordinate, if applicable.</p>
<h3>Parameter</h3>
<ul>
@ -2023,6 +2243,28 @@ The ID of the mark to be removed.</p>
<dl class="function">
<dt>
<a id="#(COORDINATE).SetVelocity" >
<strong>COORDINATE:SetVelocity(Velocity)</strong>
</a>
</dt>
<dd>
<p>Set the velocity of the COORDINATE.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string Velocity </em></code>:
Velocity in meters per second.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).Smoke" >
<strong>COORDINATE:Smoke(SmokeColor)</strong>
</a>
@ -2503,6 +2745,20 @@ The Angle in degrees.</p>
<p><em><a href="##(COORDINATE)">#COORDINATE</a>:</em>
The new calculated COORDINATE.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(COORDINATE).Velocity" >
<strong>COORDINATE.Velocity</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">

138
docs/Documentation/Positionable.html
View File

@ -246,6 +246,12 @@
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessageText">POSITIONABLE:GetMessageText(Message, Name)</a></td>
<td class="summary">
<p>Returns the message text with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessageType">POSITIONABLE:GetMessageType(Message, MessageType, Name)</a></td>
<td class="summary">
<p>Returns a message of a specified type with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr>
@ -402,6 +408,18 @@
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToSetGroup">POSITIONABLE:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)</a></td>
<td class="summary">
<p>Send a message to a <a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageTypeToCoalition">POSITIONABLE:MessageTypeToCoalition(Message, MessageType, MessageCoalition)</a></td>
<td class="summary">
<p>Send a message to a coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageTypeToGroup">POSITIONABLE:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)</a></td>
<td class="summary">
<p>Send a message of a message type to a <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
@ -912,6 +930,45 @@ The message text</p>
<p><em>#string:</em>
The message text</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetMessageType" >
<strong>POSITIONABLE:GetMessageType(Message, MessageType, Name)</strong>
</a>
</dt>
<dd>
<p>Returns a message of a specified type with the callsign embedded (if there is one).</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a> MessageType </em></code>:
MessageType The message type.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a>:</em></p>
</dd>
</dl>
<dl class="function">
@ -1685,6 +1742,86 @@ The SET_GROUP collection receiving the message.</p>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageTypeToCoalition" >
<strong>POSITIONABLE:MessageTypeToCoalition(Message, MessageType, MessageCoalition)</strong>
</a>
</dt>
<dd>
<p>Send a message to a coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE.Type)">Core.Message#MESSAGE.Type</a> MessageType </em></code>:
The message type that determines the duration.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCScoalition.html##(coalition)">Dcs.DCScoalition#coalition</a> MessageCoalition </em></code>:
The Coalition receiving the message.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).MessageTypeToGroup" >
<strong>POSITIONABLE:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)</strong>
</a>
</dt>
<dd>
<p>Send a message of a message type to a <a href="Group.html">Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string Message </em></code>:
The message text</p>
</li>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE.Type)">Core.Message#MESSAGE.Type</a> MessageType </em></code>:
The message type that determines the duration.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MessageGroup </em></code>:
The GROUP object receiving the message.</p>
</li>
<li>
<p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).New" >
<strong>POSITIONABLE:New(PositionableName)</strong>
</a>
@ -1837,6 +1974,7 @@ The height in meters to add to the altitude of the positionable.</p>
<dl class="function">
<dt>
<em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a></em>
<a id="#(POSITIONABLE).Spot" >
<strong>POSITIONABLE.Spot</strong>
</a>

3559
docs/Documentation/Rat.html Normal file
View File

File diff suppressed because it is too large Load Diff

16
docs/Documentation/Route.html
View File

@ -617,7 +617,7 @@ Upon arrival at the zone, a confirmation of arrival is sent, and the process wil
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> Controllable </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> Controllable </em></code>: </p>
</li>
</ul>
@ -809,7 +809,7 @@ self</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -845,7 +845,7 @@ self</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -881,7 +881,7 @@ self</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
</ul>
@ -1172,7 +1172,7 @@ The Range to consider the arrival. Default is 10000 meters.</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -1208,7 +1208,7 @@ The Range to consider the arrival. Default is 10000 meters.</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
</ul>
@ -1478,7 +1478,7 @@ The Zone object where to route to.</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
<li>
@ -1514,7 +1514,7 @@ The Zone object where to route to.</p>
<ul>
<li>
<p><code><em><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> ProcessUnit </em></code>: </p>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> ProcessUnit </em></code>: </p>
</li>
</ul>

72
docs/Documentation/Set.html
View File

@ -1027,12 +1027,24 @@ mission designer to add a dedicated method</p>
<td class="summary">
<p>Iterate the SET_UNIT <strong>sorted *per Threat Level</strong> and call an interator function for each <strong>alive</strong> UNIT, providing the UNIT and optional parameters.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_UNIT).GetCoordinate">SET_UNIT:GetCoordinate()</a></td>
<td class="summary">
<p>Get the center coordinate of the SET_UNIT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_UNIT).GetFirst">SET_UNIT:GetFirst()</a></td>
<td class="summary">
<p>Get the first unit from the set.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_UNIT).GetHeading">SET_UNIT:GetHeading()</a></td>
<td class="summary">
<p>Get the average heading of the SET_UNIT.</p>
</td>
</tr>
<tr>
@ -1057,6 +1069,12 @@ mission designer to add a dedicated method</p>
<td class="name" nowrap="nowrap"><a href="##(SET_UNIT).GetUnitTypesText">SET_UNIT:GetUnitTypesText()</a></td>
<td class="summary">
<p>Returns a comma separated string of the unit types with a count in the <a href="Set.html">Set</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SET_UNIT).GetVelocity">SET_UNIT:GetVelocity()</a></td>
<td class="summary">
<p>Get the maximum velocity of the SET_UNIT.</p>
</td>
</tr>
<tr>
@ -5022,6 +5040,24 @@ self</p>
<dl class="function">
<dt>
<a id="#(SET_UNIT).GetCoordinate" >
<strong>SET_UNIT:GetCoordinate()</strong>
</a>
</dt>
<dd>
<p>Get the center coordinate of the SET_UNIT.</p>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The center coordinate of all the units in the set, including heading in degrees and speed in mps in case of moving units.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SET_UNIT).GetFirst" >
<strong>SET_UNIT:GetFirst()</strong>
</a>
@ -5040,6 +5076,24 @@ The UNIT object.</p>
<dl class="function">
<dt>
<a id="#(SET_UNIT).GetHeading" >
<strong>SET_UNIT:GetHeading()</strong>
</a>
</dt>
<dd>
<p>Get the average heading of the SET_UNIT.</p>
<h3>Return value</h3>
<p><em>#number:</em>
Heading Heading in degrees and speed in mps in case of moving units.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SET_UNIT).GetTypeNames" >
<strong>SET_UNIT:GetTypeNames(Delimiter)</strong>
</a>
@ -5121,6 +5175,24 @@ The unit types string</p>
<dl class="function">
<dt>
<a id="#(SET_UNIT).GetVelocity" >
<strong>SET_UNIT:GetVelocity()</strong>
</a>
</dt>
<dd>
<p>Get the maximum velocity of the SET_UNIT.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The speed in mps in case of moving units.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SET_UNIT).HasFriendlyUnits" >
<strong>SET_UNIT:HasFriendlyUnits(FriendlyCoalition)</strong>
</a>

177
docs/Documentation/Settings.html
View File

@ -182,6 +182,12 @@
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).GetMGRS_Accuracy">SETTINGS:GetMGRS_Accuracy()</a></td>
<td class="summary">
<p>Gets the SETTINGS MGRS accuracy.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).GetMessageTime">SETTINGS:GetMessageTime(MessageType)</a></td>
<td class="summary">
<p>Gets the SETTINGS Message Display Timing of a MessageType</p>
</td>
</tr>
<tr>
@ -296,6 +302,12 @@
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).MenuGroupMWSystem">SETTINGS:MenuGroupMWSystem(PlayerUnit, PlayerGroup, PlayerName, MW)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).MenuGroupMessageTimingsSystem">SETTINGS:MenuGroupMessageTimingsSystem(PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@ -314,6 +326,18 @@
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).MenuMWSystem">SETTINGS:MenuMWSystem(MenuGroup, RootMenu, MW)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).MenuMessageTimingsSystem">SETTINGS:MenuMessageTimingsSystem(MenuGroup, RootMenu, MessageType, MessageTime)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).MessageTypeTimings">SETTINGS.MessageTypeTimings</a></td>
<td class="summary">
</td>
</tr>
<tr>
@ -410,6 +434,12 @@
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).SetMGRS_Accuracy">SETTINGS:SetMGRS_Accuracy(MGRS_Accuracy)</a></td>
<td class="summary">
<p>Sets the SETTINGS MGRS accuracy.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SETTINGS).SetMessageTime">SETTINGS:SetMessageTime(MessageType, MessageTime)</a></td>
<td class="summary">
<p>Sets the SETTINGS Message Display Timing of a MessageType</p>
</td>
</tr>
<tr>
@ -576,6 +606,33 @@
<p><em>#number:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SETTINGS).GetMessageTime" >
<strong>SETTINGS:GetMessageTime(MessageType)</strong>
</a>
</dt>
<dd>
<p>Gets the SETTINGS Message Display Timing of a MessageType</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a> MessageType </em></code>:
The type of the message.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#number:</em></p>
</dd>
</dl>
<dl class="function">
@ -1001,6 +1058,47 @@ true if metric.</p>
<dl class="function">
<dt>
<a id="#(SETTINGS).MenuGroupMessageTimingsSystem" >
<strong>SETTINGS:MenuGroupMessageTimingsSystem(PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> PlayerUnit </em></code>: </p>
</li>
<li>
<p><code><em> PlayerGroup </em></code>: </p>
</li>
<li>
<p><code><em> PlayerName </em></code>: </p>
</li>
<li>
<p><code><em> MessageType </em></code>: </p>
</li>
<li>
<p><code><em> MessageTime </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SETTINGS).MenuLL_DDM_Accuracy" >
<strong>SETTINGS:MenuLL_DDM_Accuracy(MenuGroup, RootMenu, LL_Accuracy)</strong>
</a>
@ -1094,7 +1192,56 @@ true if metric.</p>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(SETTINGS).MenuMessageTimingsSystem" >
<strong>SETTINGS:MenuMessageTimingsSystem(MenuGroup, RootMenu, MessageType, MessageTime)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> MenuGroup </em></code>: </p>
</li>
<li>
<p><code><em> RootMenu </em></code>: </p>
</li>
<li>
<p><code><em> MessageType </em></code>: </p>
</li>
<li>
<p><code><em> MessageTime </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SETTINGS).MessageTypeTimings" >
<strong>SETTINGS.MessageTypeTimings</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SETTINGS).Metric" >
<strong>SETTINGS.Metric</strong>
</a>
@ -1406,6 +1553,34 @@ true if metric.</p>
<dl class="function">
<dt>
<a id="#(SETTINGS).SetMessageTime" >
<strong>SETTINGS:SetMessageTime(MessageType, MessageTime)</strong>
</a>
</dt>
<dd>
<p>Sets the SETTINGS Message Display Timing of a MessageType</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a> MessageType </em></code>:
The type of the message.</p>
</li>
<li>
<p><code><em>#number MessageTime </em></code>:
The display time duration in seconds of the MessageType.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SETTINGS).SetMetric" >
<strong>SETTINGS:SetMetric()</strong>
</a>

10
docs/Documentation/Spawn.html
View File

@ -2201,6 +2201,9 @@ The group that was spawned. You can use this group for further actions.</p>
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
</dd>
</dl>
<dl class="function">
@ -2739,9 +2742,6 @@ when nothing was spawned.</p>
<p> Overwrite unit names by default with group name.</p>
</dd>
</dl>
<dl class="function">
@ -3139,7 +3139,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<dl class="function">
<dt>
<em></em>
<em>#boolean</em>
<a id="#(SPAWN).SpawnUnControlled" >
<strong>SPAWN.SpawnUnControlled</strong>
</a>
@ -3163,7 +3163,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</dd>
</dl>

4
docs/Documentation/Spot.html
View File

@ -766,6 +766,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).ScheduleID" >
<strong>SPOT.ScheduleID</strong>
</a>
@ -779,6 +780,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).SpotIR" >
<strong>SPOT.SpotIR</strong>
</a>
@ -792,6 +794,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).SpotLaser" >
<strong>SPOT.SpotLaser</strong>
</a>
@ -805,6 +808,7 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).Target" >
<strong>SPOT.Target</strong>
</a>

2
docs/Documentation/Task_Cargo.html
View File

@ -553,7 +553,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
<dl class="function">
<dt>
<em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a></em>
<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
<a id="#(FSM_PROCESS).Cargo" >
<strong>FSM_PROCESS.Cargo</strong>
</a>

1
docs/README.md
View File

@ -118,6 +118,7 @@ MOOSE Functional Classes provide various functions that are useful in mission de
* [CLEANUP\_AIRBASE](Documentation/CleanUp.html): Keeps the airbases clean from clutter. (Only partly functional due to a bug in DCS, destroyed objects cannot be removed).
* [RAT](Documentation/Rat.html): Random Air Traffic engine developed by FunkyFranky, use the available airspace!
## 2.4. MOOSE Wrapper Classes