documentation

This commit is contained in:
FlightControl
2016-12-18 14:17:26 +01:00
parent 637b5113fa
commit 837796ed0b
64 changed files with 159 additions and 119 deletions

View File

@@ -71,7 +71,6 @@
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_Client_Menu.html">Task_Client_Menu</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
<li><a href="Unit.html">Unit</a></li>
@@ -156,7 +155,7 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessage">POSITIONABLE:GetMessage(Message, Duration)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetMessage">POSITIONABLE:GetMessage(Message, Duration, Name)</a></td>
<td class="summary">
<p>Returns a message with the callsign embedded (if there is one).</p>
</td>
@@ -216,43 +215,43 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Message">POSITIONABLE:Message(Message, Duration)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Message">POSITIONABLE:Message(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to the players in the <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToAll">POSITIONABLE:MessageToAll(Message, Duration)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToAll">POSITIONABLE:MessageToAll(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to all coalitions.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToBlue">POSITIONABLE:MessageToBlue(Message, Duration)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToBlue">POSITIONABLE:MessageToBlue(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to the blue coalition.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToClient">POSITIONABLE:MessageToClient(Message, Duration, Client)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToClient">POSITIONABLE:MessageToClient(Message, Duration, Client, Name)</a></td>
<td class="summary">
<p>Send a message to a client.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToCoalition">POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToCoalition">POSITIONABLE:MessageToCoalition(Message, Duration, Name, 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).MessageToGroup">POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToGroup">POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup, Name)</a></td>
<td class="summary">
<p>Send a message to a <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToRed">POSITIONABLE:MessageToRed(Message, Duration)</a></td>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToRed">POSITIONABLE:MessageToRed(Message, Duration, Name)</a></td>
<td class="summary">
<p>Send a message to the red coalition.</p>
</td>
@@ -376,7 +375,7 @@ The POSTIONABLE heading</p>
<dt>
<a id="#(POSITIONABLE).GetMessage" >
<strong>POSITIONABLE:GetMessage(Message, Duration)</strong>
<strong>POSITIONABLE:GetMessage(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
@@ -396,6 +395,12 @@ The message text</p>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of 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>
<h3>Return value</h3>
@@ -669,7 +674,7 @@ The POSITIONABLE is not existing or alive. </p>
<dt>
<a id="#(POSITIONABLE).Message" >
<strong>POSITIONABLE:Message(Message, Duration)</strong>
<strong>POSITIONABLE:Message(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
@@ -692,6 +697,12 @@ The message text</p>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of 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>
@@ -700,7 +711,7 @@ The duration of the message.</p>
<dt>
<a id="#(POSITIONABLE).MessageToAll" >
<strong>POSITIONABLE:MessageToAll(Message, Duration)</strong>
<strong>POSITIONABLE:MessageToAll(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
@@ -723,6 +734,12 @@ The message text</p>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of 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>
@@ -731,7 +748,7 @@ The duration of the message.</p>
<dt>
<a id="#(POSITIONABLE).MessageToBlue" >
<strong>POSITIONABLE:MessageToBlue(Message, Duration)</strong>
<strong>POSITIONABLE:MessageToBlue(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
@@ -754,6 +771,12 @@ The message text</p>
<p><code><em><a href="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
The duration of 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>
@@ -762,7 +785,7 @@ The duration of the message.</p>
<dt>
<a id="#(POSITIONABLE).MessageToClient" >
<strong>POSITIONABLE:MessageToClient(Message, Duration, Client)</strong>
<strong>POSITIONABLE:MessageToClient(Message, Duration, Client, Name)</strong>
</a>
</dt>
<dd>
@@ -791,6 +814,12 @@ The duration of the message.</p>
<p><code><em><a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a> Client </em></code>:
The client 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>
@@ -799,7 +828,7 @@ The client object receiving the message.</p>
<dt>
<a id="#(POSITIONABLE).MessageToCoalition" >
<strong>POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition)</strong>
<strong>POSITIONABLE:MessageToCoalition(Message, Duration, Name, MessageCoalition)</strong>
</a>
</dt>
<dd>
@@ -825,6 +854,12 @@ The duration of 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>
<li>
<p><code><em> MessageCoalition </em></code>: </p>
</li>
@@ -835,7 +870,7 @@ The duration of the message.</p>
<dt>
<a id="#(POSITIONABLE).MessageToGroup" >
<strong>POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup)</strong>
<strong>POSITIONABLE:MessageToGroup(Message, Duration, MessageGroup, Name)</strong>
</a>
</dt>
<dd>
@@ -864,6 +899,12 @@ The duration of the message.</p>
<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>
@@ -872,7 +913,7 @@ The GROUP object receiving the message.</p>
<dt>
<a id="#(POSITIONABLE).MessageToRed" >
<strong>POSITIONABLE:MessageToRed(Message, Duration)</strong>
<strong>POSITIONABLE:MessageToRed(Message, Duration, Name)</strong>
</a>
</dt>
<dd>
@@ -895,6 +936,12 @@ The message text</p>
<p><code><em><a href="Dcs.DCSTYpes.html##(Duration)">Dcs.DCSTYpes#Duration</a> Duration </em></code>:
The duration of 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>