mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Documentation
This commit is contained in:
FlightControl
@@ -162,13 +162,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetBeacon">POSITIONABLE:GetBeacon()</a></td>
|
||||
<td class="summary">
|
||||
<p>(R2.1) Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
|
||||
<p>Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetHeading">POSITIONABLE:GetHeading()</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns the POSITIONABLE heading in degrees.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetLaserCode">POSITIONABLE:GetLaserCode()</a></td>
|
||||
<td class="summary">
|
||||
<p>Get the last assigned laser code</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -198,13 +204,19 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetRadio">POSITIONABLE:GetRadio()</a></td>
|
||||
<td class="summary">
|
||||
<p>(R2.1) Create a <a href="Radio.html##(RADIO)">Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
|
||||
<p>Create a <a href="Radio.html##(RADIO)">Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetRandomVec3">POSITIONABLE:GetRandomVec3(Radius)</a></td>
|
||||
<td class="summary">
|
||||
<p>Returns a random <a href="DCSTypes.html##(Vec3)">DCSTypes#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetSpot">POSITIONABLE:GetSpot()</a></td>
|
||||
<td class="summary">
|
||||
<p>Get the Spot</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -246,19 +258,25 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).IsLasing">POSITIONABLE:IsLasing()</a></td>
|
||||
<td class="summary">
|
||||
<p>(R2.1) Check if the POSITIONABLE is lasing a target</p>
|
||||
<p>Check if the POSITIONABLE is lasing a target</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).LaseOff">POSITIONABLE:LaseOff()</a></td>
|
||||
<td class="summary">
|
||||
<p>(R2.1) Stop Lasing a POSITIONABLE</p>
|
||||
<p>Stop Lasing a POSITIONABLE</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).LaseUnit">POSITIONABLE:LaseUnit(Target, LaserCode, Duration)</a></td>
|
||||
<td class="summary">
|
||||
<p>(R2.1) Start Lasing a POSITIONABLE</p>
|
||||
<p>Start Lasing a POSITIONABLE</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).LaserCode">POSITIONABLE.LaserCode</a></td>
|
||||
<td class="summary">
|
||||
<p>The last assigned laser code.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -301,6 +319,12 @@
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
@@ -318,7 +342,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).Spot">POSITIONABLE.Spot</a></td>
|
||||
<td class="summary">
|
||||
|
||||
<p>The laser Spot.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -415,7 +439,7 @@ The POSITIONABLE is not existing or alive. </p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(R2.1) Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
|
||||
<p>Create a <a href="Radio.html##(BEACON)">Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
@@ -455,6 +479,24 @@ The POSITIONABLE is not existing or alive.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(POSITIONABLE).GetLaserCode" >
|
||||
<strong>POSITIONABLE:GetLaserCode()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Get the last assigned laser code</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#number:</em>
|
||||
The laser code</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(POSITIONABLE).GetMessage" >
|
||||
<strong>POSITIONABLE:GetMessage(Message, Duration, Name)</strong>
|
||||
</a>
|
||||
@@ -584,7 +626,7 @@ The POSITIONABLE is not existing or alive. </p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(R2.1) Create a <a href="Radio.html##(RADIO)">Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
|
||||
<p>Create a <a href="Radio.html##(RADIO)">Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
|
||||
|
||||
|
||||
<p>Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message</p>
|
||||
@@ -639,6 +681,24 @@ The POSITIONABLE is not existing or alive. </p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(POSITIONABLE).GetSpot" >
|
||||
<strong>POSITIONABLE:GetSpot()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Get the Spot</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>:</em>
|
||||
The Spot</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(POSITIONABLE).GetVec2" >
|
||||
<strong>POSITIONABLE:GetVec2()</strong>
|
||||
</a>
|
||||
@@ -816,7 +876,7 @@ The POSITIONABLE is not existing or alive. </p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(R2.1) Check if the POSITIONABLE is lasing a target</p>
|
||||
<p>Check if the POSITIONABLE is lasing a target</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
@@ -834,7 +894,7 @@ true if it is lasing a target</p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(R2.1) Stop Lasing a POSITIONABLE</p>
|
||||
<p>Stop Lasing a POSITIONABLE</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
@@ -852,7 +912,7 @@ true if it is lasing a target</p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>(R2.1) Start Lasing a POSITIONABLE</p>
|
||||
<p>Start Lasing a POSITIONABLE</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
@@ -877,6 +937,20 @@ true if it is lasing a target</p>
|
||||
<p><em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#number</em>
|
||||
<a id="#(POSITIONABLE).LaserCode" >
|
||||
<strong>POSITIONABLE.LaserCode</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>The last assigned laser code.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -1159,6 +1233,49 @@ The duration of the message.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(POSITIONABLE).MessageToSetGroup" >
|
||||
<strong>POSITIONABLE:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Send a message to a <a href="Set.html##(SET_GROUP)">Set#SET_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="Dcs.DCSTypes.html##(Duration)">Dcs.DCSTypes#Duration</a> Duration </em></code>:
|
||||
The duration of the message.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> MessageSetGroup </em></code>:
|
||||
The SET_GROUP collection 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>
|
||||
@@ -1207,7 +1324,7 @@ self</p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<p>The laser Spot.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
Reference in New Issue
Block a user