FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to the documentation generation process

Browse Source 
Include a doc update too.
This commit is contained in:
Grey-Echo
2017-05-03 16:35:34 +02:00
parent 9ca007ccf4
commit 7b2f0fda9c
25 changed files with 2695 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Documentation/AI_Patrol.html
View File

@@ -951,6 +951,9 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI<em>PATROL</em>ZONE.M
<p> This table contains the targets detected during patrol.</p>
</dd>
</dl>
<dl class="function">

148
docs/Documentation/CommandCenter.html
View File

@@ -251,24 +251,60 @@
<td class="name" nowrap="nowrap"><a href="##(REPORT).Add">REPORT:Add(Text)</a></td>
<td class="summary">
<p>Add a new line to a REPORT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).AddIndent">REPORT:AddIndent(Text)</a></td>
<td class="summary">
<p>Add a new line to a REPORT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).ClassName">REPORT.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).HasText">REPORT:HasText()</a></td>
<td class="summary">
<p>Has the REPORT Text?</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).Indent">REPORT.Indent</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).New">REPORT:New(Title)</a></td>
<td class="summary">
<p>Create a new REPORT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).Report">REPORT.Report</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).SetIndent">REPORT:SetIndent(Indent)</a></td>
<td class="summary">
<p>Set indent of a REPORT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).Text">REPORT:Text(Delimiter)</a></td>
<td class="summary">
<p>Produces the text of the report, taking into account an optional delimeter, which is \n by default.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(REPORT).Title">REPORT.Title</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -765,6 +801,32 @@ Group#GROUP</p>
<p><em><a href="##(REPORT)">#REPORT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(REPORT).AddIndent" >
<strong>REPORT:AddIndent(Text)</strong>
</a>
</dt>
<dd>
<p>Add a new line to a REPORT.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string Text </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(REPORT)">#REPORT</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -779,6 +841,38 @@ Group#GROUP</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(REPORT).HasText" >
<strong>REPORT:HasText()</strong>
</a>
</dt>
<dd>
<p>Has the REPORT Text?</p>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(REPORT).Indent" >
<strong>REPORT.Indent</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -805,6 +899,46 @@ Group#GROUP</p>
<p><em><a href="##(REPORT)">#REPORT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(REPORT).Report" >
<strong>REPORT.Report</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(REPORT).SetIndent" >
<strong>REPORT:SetIndent(Indent)</strong>
</a>
</dt>
<dd>
<p>Set indent of a REPORT.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Indent </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(REPORT)">#REPORT</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -832,6 +966,20 @@ Group#GROUP</p>
<p><em>#string:</em>
The report text.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(REPORT).Title" >
<strong>REPORT.Title</strong>
</a>
</dt>
<dd>
</dd>
</dl>

36
docs/Documentation/Controllable.html
View File

@@ -382,7 +382,7 @@ This is different from the EnRoute tasks, where the targets of the task need to
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).IsTargetDetected">CONTROLLABLE:IsTargetDetected(DCSObject)</a></td>
<td class="name" nowrap="nowrap"><a href="##(CONTROLLABLE).IsTargetDetected">CONTROLLABLE:IsTargetDetected(DCSObject, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></td>
<td class="summary">
</td>
@@ -1466,19 +1466,49 @@ WayPoints If WayPoints is given, then return the WayPoints structure.</p>
<dt>
<a id="#(CONTROLLABLE).IsTargetDetected" >
<strong>CONTROLLABLE:IsTargetDetected(DCSObject)</strong>
<strong>CONTROLLABLE:IsTargetDetected(DCSObject, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> DCSObject </em></code>: </p>
</li>
<li>
<p><code><em> DetectVisual </em></code>: </p>
</li>
<li>
<p><code><em> DetectOptical </em></code>: </p>
</li>
<li>
<p><code><em> DetectRadar </em></code>: </p>
</li>
<li>
<p><code><em> DetectIRST </em></code>: </p>
</li>
<li>
<p><code><em> DetectRWR </em></code>: </p>
</li>
<li>
<p><code><em> DetectDLINK </em></code>: </p>
</li>
</ul>
</dd>

43
docs/Documentation/Database.html
View File

@@ -326,6 +326,12 @@ The following iterator methods are currently available within the DATABASE:</p>
<td class="name" nowrap="nowrap"><a href="##(DATABASE).ForEachPlayerJoined">DATABASE:ForEachPlayerJoined(IteratorFunction, ...)</a></td>
<td class="summary">
<p>Iterate the DATABASE and call an iterator function for each player who has joined the mission, providing the Unit of the player and optional parameters.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DATABASE).ForEachStatic">DATABASE:ForEachStatic(IteratorFunction, FinalizeFunction, ...)</a></td>
<td class="summary">
<p>Iterate the DATABASE and call an iterator function for each <strong>alive</strong> STATIC, providing the STATIC and optional parameters.</p>
</td>
</tr>
<tr>
@@ -1279,6 +1285,43 @@ self</p>
<dl class="function">
<dt>
<a id="#(DATABASE).ForEachStatic" >
<strong>DATABASE:ForEachStatic(IteratorFunction, FinalizeFunction, ...)</strong>
</a>
</dt>
<dd>
<p>Iterate the DATABASE and call an iterator function for each <strong>alive</strong> STATIC, providing the STATIC and optional parameters.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function IteratorFunction </em></code>:
The function that will be called for each object in the database. The function needs to accept a STATIC parameter.</p>
</li>
<li>
<p><code><em> FinalizeFunction </em></code>: </p>
</li>
<li>
<p><code><em> ... </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(DATABASE)">#DATABASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DATABASE).ForEachUnit" >
<strong>DATABASE:ForEachUnit(IteratorFunction, FinalizeFunction, ...)</strong>
</a>

21
docs/Documentation/Designate.html
View File

@@ -279,7 +279,7 @@ each detected set of potential targets can be lased or smoked...</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DESIGNATE).MenuStatus">DESIGNATE:MenuStatus(AttackGroup)</a></td>
<td class="name" nowrap="nowrap"><a href="##(DESIGNATE).MenuStatus">DESIGNATE:MenuStatus(AttackGroup, Duration)</a></td>
<td class="summary">
</td>
@@ -375,7 +375,7 @@ each detected set of potential targets can be lased or smoked...</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DESIGNATE).SendStatus">DESIGNATE:SendStatus(AttackGroup, MenuAttackGroup)</a></td>
<td class="name" nowrap="nowrap"><a href="##(DESIGNATE).SendStatus">DESIGNATE:SendStatus(AttackGroup, Duration, MenuAttackGroup)</a></td>
<td class="summary">
<p>Sends the status to the Attack Groups.</p>
</td>
@@ -1065,19 +1065,24 @@ function below will use the range 1-7 just in case</p>
<dt>
<a id="#(DESIGNATE).MenuStatus" >
<strong>DESIGNATE:MenuStatus(AttackGroup)</strong>
<strong>DESIGNATE:MenuStatus(AttackGroup, Duration)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> AttackGroup </em></code>: </p>
</li>
<li>
<p><code><em> Duration </em></code>: </p>
</li>
</ul>
</dd>
@@ -1556,7 +1561,7 @@ The Attack collection of GROUP objects to designate and report for.</p>
<dt>
<a id="#(DESIGNATE).SendStatus" >
<strong>DESIGNATE:SendStatus(AttackGroup, MenuAttackGroup)</strong>
<strong>DESIGNATE:SendStatus(AttackGroup, Duration, MenuAttackGroup)</strong>
</a>
</dt>
<dd>
@@ -1572,6 +1577,12 @@ The Attack collection of GROUP objects to designate and report for.</p>
</li>
<li>
<p><code><em>#number Duration </em></code>:
The time in seconds the report should be visible.</p>
</li>
<li>
<p><code><em> MenuAttackGroup </em></code>: </p>
</li>

370
docs/Documentation/Detection.html
View File

@@ -192,6 +192,12 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
<td class="name" nowrap="nowrap"><a href="##(DETECTION_AREAS).CreateDetectionItems">DETECTION_AREAS:CreateDetectionItems()</a></td>
<td class="summary">
<p>Make a DetectionSet table.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_AREAS).DetectedItemMenu">DETECTION_AREAS:DetectedItemMenu(Index)</a></td>
<td class="summary">
<p>Menu of a detected item using a given numeric index.</p>
</td>
</tr>
<tr>
@@ -204,6 +210,12 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
<td class="name" nowrap="nowrap"><a href="##(DETECTION_AREAS).DetectedItems">DETECTION_AREAS.DetectedItems</a></td>
<td class="summary">
<p>A list of areas containing the set of <a href="Unit.html">Unit</a>s, <a href="Zone.html">Zone</a>s, the center <a href="Unit.html">Unit</a> within the zone, and ID of each area that was detected within a DetectionZoneRange.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_AREAS).DetectedReportDetailed">DETECTION_AREAS:DetectedReportDetailed()</a></td>
<td class="summary">
<p>Report detailed of a detection result.</p>
</td>
</tr>
<tr>
@@ -331,7 +343,7 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).AddDetectedItem">DETECTION_BASE:AddDetectedItem(DetectedItemIndex, Set)</a></td>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).AddDetectedItem">DETECTION_BASE:AddDetectedItem(ItemPrefix, DetectedItemIndex, Set)</a></td>
<td class="summary">
<p>Adds a new DetectedItem to the DetectedItems list.</p>
</td>
@@ -424,6 +436,12 @@ DETECTION uses the in-built detection capabilities of DCS World, but adds new fu
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectedItemMax">DETECTION_BASE.DetectedItemMax</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).DetectedItemMenu">DETECTION_BASE:DetectedItemMenu(Index)</a></td>
<td class="summary">
<p>Menu of a detected item using a given numeric index.</p>
</td>
</tr>
<tr>
@@ -513,12 +531,24 @@ The different values of Unit.Category can be:</p>
</ul>
<p>Multiple Unit.Category entries can be given as a table and then these will be evaluated as an OR expression.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedID">DETECTION_BASE:GetDetectedID(Index)</a></td>
<td class="summary">
<p>Get a detected ID using a given numeric index.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedItem">DETECTION_BASE:GetDetectedItem(Index)</a></td>
<td class="summary">
<p>Get a detected item using a given numeric index.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).GetDetectedItemID">DETECTION_BASE:GetDetectedItemID(Index)</a></td>
<td class="summary">
<p>Get a detected ItemID using a given numeric index.</p>
</td>
</tr>
<tr>
@@ -905,6 +935,42 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Identified">DETECTION_BASE.DetectedObject.Identified</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).IsVisible">DETECTION_BASE.DetectedObject.IsVisible</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).KnowDistance">DETECTION_BASE.DetectedObject.KnowDistance</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).KnowType">DETECTION_BASE.DetectedObject.KnowType</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).LastPos">DETECTION_BASE.DetectedObject.LastPos</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).LastTime">DETECTION_BASE.DetectedObject.LastTime</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).LastVelocity">DETECTION_BASE.DetectedObject.LastVelocity</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -917,12 +983,6 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Type">DETECTION_BASE.DetectedObject.Type</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE.DetectedObject).Visible">DETECTION_BASE.DetectedObject.Visible</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -939,6 +999,12 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_TYPES).CreateDetectionItems">DETECTION_TYPES:CreateDetectionItems()</a></td>
<td class="summary">
<p>Create the DetectedItems list from the DetectedObjects table.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_TYPES).DetectedItemMenu">DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName)</a></td>
<td class="summary">
<p>Menu of a DetectedItem using a given numeric index.</p>
</td>
</tr>
<tr>
@@ -1015,6 +1081,12 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITS).CreateDetectionItems">DETECTION_UNITS:CreateDetectionItems()</a></td>
<td class="summary">
<p>Create the DetectedItems list from the DetectedObjects table.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_UNITS).DetectedItemMenu">DETECTION_UNITS:DetectedItemMenu(Index)</a></td>
<td class="summary">
<p>Menu of a DetectedItem using a given numeric index.</p>
</td>
</tr>
<tr>
@@ -1476,6 +1548,32 @@ self</p>
<p><em><a href="##(DETECTION_AREAS)">#DETECTION_AREAS</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_AREAS).DetectedItemMenu" >
<strong>DETECTION_AREAS:DetectedItemMenu(Index)</strong>
</a>
</dt>
<dd>
<p>Menu of a detected item using a given numeric index.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Index </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
@@ -1516,6 +1614,24 @@ self</p>
<p>A list of areas containing the set of <a href="Unit.html">Unit</a>s, <a href="Zone.html">Zone</a>s, the center <a href="Unit.html">Unit</a> within the zone, and ID of each area that was detected within a DetectionZoneRange.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_AREAS).DetectedReportDetailed" >
<strong>DETECTION_AREAS:DetectedReportDetailed()</strong>
</a>
</dt>
<dd>
<p>Report detailed of a detection result.</p>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
@@ -1944,7 +2060,7 @@ self</p>
<dt>
<a id="#(DETECTION_BASE).AddDetectedItem" >
<strong>DETECTION_BASE:AddDetectedItem(DetectedItemIndex, Set)</strong>
<strong>DETECTION_BASE:AddDetectedItem(ItemPrefix, DetectedItemIndex, Set)</strong>
</a>
</dt>
<dd>
@@ -1958,6 +2074,11 @@ self</p>
<ul>
<li>
<p><code><em> ItemPrefix </em></code>: </p>
</li>
<li>
<p><code><em>#string DetectedItemIndex </em></code>:
The index of the DetectedItem.</p>
@@ -2223,6 +2344,32 @@ The index of the DetectedItem.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).DetectedItemMenu" >
<strong>DETECTION_BASE:DetectedItemMenu(Index)</strong>
</a>
</dt>
<dd>
<p>Menu of a detected item using a given numeric index.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Index </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
@@ -2468,6 +2615,32 @@ self</p>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).GetDetectedID" >
<strong>DETECTION_BASE:GetDetectedID(Index)</strong>
</a>
</dt>
<dd>
<p>Get a detected ID using a given numeric index.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Index </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
DetectedItemID</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).GetDetectedItem" >
<strong>DETECTION_BASE:GetDetectedItem(Index)</strong>
</a>
@@ -2489,6 +2662,32 @@ self</p>
<p><em><a href="##(DETECTION_BASE.DetectedItem)">#DETECTION_BASE.DetectedItem</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).GetDetectedItemID" >
<strong>DETECTION_BASE:GetDetectedItemID(Index)</strong>
</a>
</dt>
<dd>
<p>Get a detected ItemID using a given numeric index.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Index </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
DetectedItemID</p>
</dd>
</dl>
<dl class="function">
@@ -4061,6 +4260,90 @@ The To State string.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(DETECTION_BASE.DetectedObject).IsVisible" >
<strong>DETECTION_BASE.DetectedObject.IsVisible</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(DETECTION_BASE.DetectedObject).KnowDistance" >
<strong>DETECTION_BASE.DetectedObject.KnowDistance</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(DETECTION_BASE.DetectedObject).KnowType" >
<strong>DETECTION_BASE.DetectedObject.KnowType</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(DETECTION_BASE.DetectedObject).LastPos" >
<strong>DETECTION_BASE.DetectedObject.LastPos</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE.DetectedObject).LastTime" >
<strong>DETECTION_BASE.DetectedObject.LastTime</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(DETECTION_BASE.DetectedObject).LastVelocity" >
<strong>DETECTION_BASE.DetectedObject.LastVelocity</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -4089,20 +4372,6 @@ The To State string.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(DETECTION_BASE.DetectedObject).Visible" >
<strong>DETECTION_BASE.DetectedObject.Visible</strong>
</a>
</dt>
<dd>
</dd>
</dl>
@@ -4154,6 +4423,37 @@ Beware that when the amount of different types detected is large, the DetectedIt
<p><em><a href="##(DETECTION_TYPES)">#DETECTION_TYPES</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_TYPES).DetectedItemMenu" >
<strong>DETECTION_TYPES:DetectedItemMenu(Index, DetectedTypeName)</strong>
</a>
</dt>
<dd>
<p>Menu of a DetectedItem using a given numeric index.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> Index </em></code>: </p>
</li>
<li>
<p><code><em> DetectedTypeName </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
@@ -4389,6 +4689,32 @@ Beware that when the amount of units detected is large, the DetectedItems list w
<p><em><a href="##(DETECTION_UNITS)">#DETECTION_UNITS</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_UNITS).DetectedItemMenu" >
<strong>DETECTION_UNITS:DetectedItemMenu(Index)</strong>
</a>
</dt>
<dd>
<p>Menu of a DetectedItem using a given numeric index.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Index </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">

3
docs/Documentation/Fsm.html
View File

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

244
docs/Documentation/Mission.html
View File

@@ -167,7 +167,7 @@ A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MI
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetMenu">MISSION:GetMenu(TaskGroup)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetMenu">MISSION:GetMenu()</a></td>
<td class="summary">
<p>Gets the mission menu for the coalition.</p>
</td>
@@ -200,6 +200,12 @@ A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MI
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTasks">MISSION:GetTasks()</a></td>
<td class="summary">
<p>Get all the TASKs from the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTasksRemaining">MISSION:GetTasksRemaining()</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -209,39 +215,51 @@ A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MI
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsCompleted">MISSION:IsCompleted()</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsCOMPLETED">MISSION:IsCOMPLETED()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>Completed</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>COMPLETED</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsFailed">MISSION:IsFailed()</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsENGAGED">MISSION:IsENGAGED()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>Failed</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>ENGAGED</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsHold">MISSION:IsHold()</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsFAILED">MISSION:IsFAILED()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>Hold</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>FAILED</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsIdle">MISSION:IsIdle()</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsHOLD">MISSION:IsHOLD()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>Idle</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>HOLD</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsOngoing">MISSION:IsOngoing()</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsIDLE">MISSION:IsIDLE()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>Ongoing</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>IDLE</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).JoinUnit">MISSION:JoinUnit(PlayerUnit, PlayerGroup)</a></td>
<td class="summary">
<p>Add a Unit to join the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportOverview">MISSION:MenuReportOverview(TaskStatus, ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportSummary">MISSION:MenuReportSummary(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -323,51 +341,51 @@ A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MI
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterCompleted">MISSION:OnEnterCompleted(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterCOMPLETED">MISSION:OnEnterCOMPLETED(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State Completed.</p>
<p>OnEnter Transition Handler for State COMPLETED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterFailed">MISSION:OnEnterFailed(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterENGAGED">MISSION:OnEnterENGAGED(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State Failed.</p>
<p>OnEnter Transition Handler for State ENGAGED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterIdle">MISSION:OnEnterIdle(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterFAILED">MISSION:OnEnterFAILED(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State Idle.</p>
<p>OnEnter Transition Handler for State FAILED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterOngoing">MISSION:OnEnterOngoing(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterIDLE">MISSION:OnEnterIDLE(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State Ongoing.</p>
<p>OnEnter Transition Handler for State IDLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveCompleted">MISSION:OnLeaveCompleted(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveCOMPLETED">MISSION:OnLeaveCOMPLETED(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State Completed.</p>
<p>OnLeave Transition Handler for State COMPLETED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveFailed">MISSION:OnLeaveFailed(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveENGAGED">MISSION:OnLeaveENGAGED(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State Failed.</p>
<p>OnLeave Transition Handler for State ENGAGED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveIdle">MISSION:OnLeaveIdle(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveFAILED">MISSION:OnLeaveFAILED(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State Idle.</p>
<p>OnLeave Transition Handler for State FAILED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveOngoing">MISSION:OnLeaveOngoing(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveIDLE">MISSION:OnLeaveIDLE(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State Ongoing.</p>
<p>OnLeave Transition Handler for State IDLE.</p>
</td>
</tr>
<tr>
@@ -395,7 +413,7 @@ A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MI
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportOverview">MISSION:ReportOverview()</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportOverview">MISSION:ReportOverview(TaskStatus)</a></td>
<td class="summary">
<p>Create a overview report of the Mission (multiple lines).</p>
</td>
@@ -467,7 +485,7 @@ A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MI
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).onenterCompleted">MISSION:onenterCompleted(From, Event, To)</a></td>
<td class="name" nowrap="nowrap"><a href="##(MISSION).onenterCOMPLETED">MISSION:onenterCOMPLETED(From, Event, To)</a></td>
<td class="summary">
</td>
@@ -697,21 +715,13 @@ true if Unit is part of a Task in the Mission.</p>
<dt>
<a id="#(MISSION).GetMenu" >
<strong>MISSION:GetMenu(TaskGroup)</strong>
<strong>MISSION:GetMenu()</strong>
</a>
</dt>
<dd>
<p>Gets the mission menu for the coalition.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> TaskGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Menu.html##(MENU_COALITION)">Core.Menu#MENU_COALITION</a>:</em>
@@ -851,6 +861,24 @@ Returns nil if no task was found.</p>
Tasks = Mission:GetTasks()
env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetTasksRemaining" >
<strong>MISSION:GetTasksRemaining()</strong>
</a>
</dt>
<dd>
<h3>Return value</h3>
<p><em>#number:</em></p>
</dd>
</dl>
<dl class="function">
@@ -893,13 +921,13 @@ true if the Mission has a Group.</p>
<dl class="function">
<dt>
<a id="#(MISSION).IsCompleted" >
<strong>MISSION:IsCompleted()</strong>
<a id="#(MISSION).IsCOMPLETED" >
<strong>MISSION:IsCOMPLETED()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>Completed</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>COMPLETED</strong>.</p>
<h3>Return value</h3>
@@ -911,13 +939,13 @@ true if the Mission has a Group.</p>
<dl class="function">
<dt>
<a id="#(MISSION).IsFailed" >
<strong>MISSION:IsFailed()</strong>
<a id="#(MISSION).IsENGAGED" >
<strong>MISSION:IsENGAGED()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>Failed</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>ENGAGED</strong>.</p>
<h3>Return value</h3>
@@ -929,13 +957,13 @@ true if the Mission has a Group.</p>
<dl class="function">
<dt>
<a id="#(MISSION).IsHold" >
<strong>MISSION:IsHold()</strong>
<a id="#(MISSION).IsFAILED" >
<strong>MISSION:IsFAILED()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>Hold</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>FAILED</strong>.</p>
<h3>Return value</h3>
@@ -947,13 +975,13 @@ true if the Mission has a Group.</p>
<dl class="function">
<dt>
<a id="#(MISSION).IsIdle" >
<strong>MISSION:IsIdle()</strong>
<a id="#(MISSION).IsHOLD" >
<strong>MISSION:IsHOLD()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>Idle</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>HOLD</strong>.</p>
<h3>Return value</h3>
@@ -965,13 +993,13 @@ true if the Mission has a Group.</p>
<dl class="function">
<dt>
<a id="#(MISSION).IsOngoing" >
<strong>MISSION:IsOngoing()</strong>
<a id="#(MISSION).IsIDLE" >
<strong>MISSION:IsIDLE()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>Ongoing</strong>.</p>
<p>Is the <a href="Mission.html">Mission</a> <strong>IDLE</strong>.</p>
<h3>Return value</h3>
@@ -1016,6 +1044,54 @@ The GROUP of the player joining the Mission.</p>
<p><em>#boolean:</em>
true if Unit is part of a Task in the Mission.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportOverview" >
<strong>MISSION:MenuReportOverview(TaskStatus, ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string TaskStatus </em></code>:
The status</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportSummary" >
<strong>MISSION:MenuReportSummary(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
@@ -1422,13 +1498,13 @@ Return false to cancel Transition.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterCompleted" >
<strong>MISSION:OnEnterCompleted(From, Event, To)</strong>
<a id="#(MISSION).OnEnterCOMPLETED" >
<strong>MISSION:OnEnterCOMPLETED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State Completed.</p>
<p>OnEnter Transition Handler for State COMPLETED.</p>
<h3>Parameters</h3>
<ul>
@@ -1456,13 +1532,13 @@ The To State string.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterFailed" >
<strong>MISSION:OnEnterFailed(From, Event, To)</strong>
<a id="#(MISSION).OnEnterENGAGED" >
<strong>MISSION:OnEnterENGAGED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State Failed.</p>
<p>OnEnter Transition Handler for State ENGAGED.</p>
<h3>Parameters</h3>
<ul>
@@ -1490,13 +1566,13 @@ The To State string.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterIdle" >
<strong>MISSION:OnEnterIdle(From, Event, To)</strong>
<a id="#(MISSION).OnEnterFAILED" >
<strong>MISSION:OnEnterFAILED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State Idle.</p>
<p>OnEnter Transition Handler for State FAILED.</p>
<h3>Parameters</h3>
<ul>
@@ -1524,13 +1600,13 @@ The To State string.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterOngoing" >
<strong>MISSION:OnEnterOngoing(From, Event, To)</strong>
<a id="#(MISSION).OnEnterIDLE" >
<strong>MISSION:OnEnterIDLE(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State Ongoing.</p>
<p>OnEnter Transition Handler for State IDLE.</p>
<h3>Parameters</h3>
<ul>
@@ -1558,13 +1634,13 @@ The To State string.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveCompleted" >
<strong>MISSION:OnLeaveCompleted(From, Event, To)</strong>
<a id="#(MISSION).OnLeaveCOMPLETED" >
<strong>MISSION:OnLeaveCOMPLETED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State Completed.</p>
<p>OnLeave Transition Handler for State COMPLETED.</p>
<h3>Parameters</h3>
<ul>
@@ -1597,13 +1673,13 @@ Return false to cancel Transition.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveFailed" >
<strong>MISSION:OnLeaveFailed(From, Event, To)</strong>
<a id="#(MISSION).OnLeaveENGAGED" >
<strong>MISSION:OnLeaveENGAGED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State Failed.</p>
<p>OnLeave Transition Handler for State ENGAGED.</p>
<h3>Parameters</h3>
<ul>
@@ -1636,13 +1712,13 @@ Return false to cancel Transition.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveIdle" >
<strong>MISSION:OnLeaveIdle(From, Event, To)</strong>
<a id="#(MISSION).OnLeaveFAILED" >
<strong>MISSION:OnLeaveFAILED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State Idle.</p>
<p>OnLeave Transition Handler for State FAILED.</p>
<h3>Parameters</h3>
<ul>
@@ -1675,13 +1751,13 @@ Return false to cancel Transition.</p>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveOngoing" >
<strong>MISSION:OnLeaveOngoing(From, Event, To)</strong>
<a id="#(MISSION).OnLeaveIDLE" >
<strong>MISSION:OnLeaveIDLE(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State Ongoing.</p>
<p>OnLeave Transition Handler for State IDLE.</p>
<h3>Parameters</h3>
<ul>
@@ -1811,13 +1887,21 @@ self</p>
<dt>
<a id="#(MISSION).ReportOverview" >
<strong>MISSION:ReportOverview()</strong>
<strong>MISSION:ReportOverview(TaskStatus)</strong>
</a>
</dt>
<dd>
<p>Create a overview report of the Mission (multiple lines).</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskStatus </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
@@ -2047,8 +2131,8 @@ The delay in seconds.</p>
<dl class="function">
<dt>
<a id="#(MISSION).onenterCompleted" >
<strong>MISSION:onenterCompleted(From, Event, To)</strong>
<a id="#(MISSION).onenterCOMPLETED" >
<strong>MISSION:onenterCOMPLETED(From, Event, To)</strong>
</a>
</dt>
<dd>

4
docs/Documentation/Movement.html
View File

@@ -213,7 +213,6 @@ on defined intervals (currently every minute).</p>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MOVEMENT).AliveUnits" >
<strong>MOVEMENT.AliveUnits</strong>
</a>
@@ -222,9 +221,6 @@ on defined intervals (currently every minute).</p>
<p> Contains the counter how many units are currently alive</p>
</dd>
</dl>
<dl class="function">

575
docs/Documentation/Point.html
View File

@@ -157,6 +157,14 @@
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#COORDINATE">COORDINATE</a></td>
<td class="summary">
<h1>COORDINATE class, extends <a href="Point.html##(COORDINATE)">Point#COORDINATE</a></h1>
<p>The COORDINATE class defines a 2D coordinate in the simulator.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#POINT_VEC2">POINT_VEC2</a></td>
<td class="summary">
@@ -174,6 +182,107 @@
</td>
</tr>
</table>
<h2><a id="#(COORDINATE)">Type <code>COORDINATE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).CoordinateMenu">COORDINATE:CoordinateMenu(RootMenu)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).LL_Accuracy">COORDINATE.LL_Accuracy</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).LL_DMS">COORDINATE.LL_DMS</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MGRS_Accuracy">COORDINATE.MGRS_Accuracy</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MenuLL_Accuracy">COORDINATE:MenuLL_Accuracy(LL_Accuracy)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MenuLL_DMS">COORDINATE:MenuLL_DMS(LL_DMS)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MenuMGRS_Accuracy">COORDINATE:MenuMGRS_Accuracy(MGRS_Accuracy)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).MenuSystem">COORDINATE:MenuSystem(System)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).New">COORDINATE:New(x, y, LandHeightAdd)</a></td>
<td class="summary">
<p>COORDINATE constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).NewFromVec2">COORDINATE:NewFromVec2(Vec2, LandHeightAdd)</a></td>
<td class="summary">
<p>Create a new COORDINATE object from Vec2 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).NewFromVec3">COORDINATE:NewFromVec3(Vec3)</a></td>
<td class="summary">
<p>Create a new COORDINATE object from Vec3 coordinates.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).System">COORDINATE.System</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).SystemMenu">COORDINATE.SystemMenu</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).ToString">COORDINATE:ToString()</a></td>
<td class="summary">
<p>Provides a coordinate string of the point, based on a coordinate format system:
* Uses default settings in COORDINATE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).ToStringLL">COORDINATE:ToStringLL(LL_Accuracy, LL_DMS)</a></td>
<td class="summary">
<p>Provides a Lat Lon string</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(COORDINATE).ToStringMGRS">COORDINATE:ToStringMGRS(MGRS_Accuracy)</a></td>
<td class="summary">
<p>Provides a MGRS string</p>
</td>
</tr>
</table>
<h2><a id="#(POINT_VEC2)">Type <code>POINT_VEC2</code></a></h2>
<table class="function_list">
<tr>
@@ -622,12 +731,6 @@
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).ToStringBR">POINT_VEC3:ToStringBR(AngleRadians, Distance)</a></td>
<td class="summary">
<p>Provides a Bearing / Range string</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(POINT_VEC3).ToStringLL">POINT_VEC3:ToStringLL(AngleRadians, Distance, acc, DMS)</a></td>
<td class="summary">
<p>Provides a Bearing / Range string</p>
</td>
</tr>
<tr>
@@ -702,6 +805,51 @@
<dl class="function">
<dt>
<em><a href="##(COORDINATE)">#COORDINATE</a></em>
<a id="COORDINATE" >
<strong>COORDINATE</strong>
</a>
</dt>
<dd>
<h1>COORDINATE class, extends <a href="Point.html##(COORDINATE)">Point#COORDINATE</a></h1>
<p>The COORDINATE class defines a 2D coordinate in the simulator.</p>
<p>The height coordinate (if needed) will be the land height + an optional added height specified.
A COORDINATE can be expressed in LL or in MGRS.</p>
<h2>COORDINATE constructor</h2>
<p>A new COORDINATE instance can be created with:</p>
<ul>
<li><a href="Point.html##(COORDINATE).New">Point#COORDINATE.New</a>(): a 2D point, taking an additional height parameter.</li>
<li><a href="Point.html##(COORDINATE).NewFromVec2">Point#COORDINATE.NewFromVec2</a>(): a 2D point created from a <a href="DCSTypes.html##(Vec2)">DCSTypes#Vec2</a>.</li>
</ul>
<h2>Manupulate the X, Altitude, Y coordinates of the 2D point</h2>
<p>A COORDINATE class works in 2D space, with an altitude setting. It contains internally an X, Altitude, Y coordinate.
Methods exist to manupulate these coordinates.</p>
<p>The current X, Altitude, Y axis can be retrieved with the methods <a href="##(COORDINATE).GetX">COORDINATE.GetX</a>(), <a href="##(COORDINATE).GetAlt">COORDINATE.GetAlt</a>(), <a href="##(COORDINATE).GetY">COORDINATE.GetY</a>() respectively.
The methods <a href="##(COORDINATE).SetX">COORDINATE.SetX</a>(), <a href="##(COORDINATE).SetAlt">COORDINATE.SetAlt</a>(), <a href="##(COORDINATE).SetY">COORDINATE.SetY</a>() change the respective axis with a new value.
The current Lat(itude), Alt(itude), Lon(gitude) values can also be retrieved with the methods <a href="##(COORDINATE).GetLat">COORDINATE.GetLat</a>(), <a href="##(COORDINATE).GetAlt">COORDINATE.GetAlt</a>(), <a href="##(COORDINATE).GetLon">COORDINATE.GetLon</a>() respectively.
The current axis values can be changed by using the methods <a href="##(COORDINATE).AddX">COORDINATE.AddX</a>(), <a href="##(COORDINATE).AddAlt">COORDINATE.AddAlt</a>(), <a href="##(COORDINATE).AddY">COORDINATE.AddY</a>()
to add or substract a value from the current respective axis value.
Note that the Set and Add methods return the current COORDINATE object, so these manipulation methods can be chained... For example:</p>
<pre><code> local Vec2 = PointVec2:AddX( 100 ):AddY( 2000 ):GetVec2()
</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(POINT_VEC2)">#POINT_VEC2</a></em>
<a id="POINT_VEC2" >
<strong>POINT_VEC2</strong>
@@ -904,6 +1052,378 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
</dl>
<h2><a id="#(Point)" >Type <code>Point</code></a></h2>
<h2><a id="#(COORDINATE)" >Type <code>COORDINATE</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(COORDINATE).CoordinateMenu" >
<strong>COORDINATE:CoordinateMenu(RootMenu)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> RootMenu </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The coordinate Text in the configured coordinate system.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(COORDINATE).LL_Accuracy" >
<strong>COORDINATE.LL_Accuracy</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(COORDINATE).LL_DMS" >
<strong>COORDINATE.LL_DMS</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(COORDINATE).MGRS_Accuracy" >
<strong>COORDINATE.MGRS_Accuracy</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).MenuLL_Accuracy" >
<strong>COORDINATE:MenuLL_Accuracy(LL_Accuracy)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> LL_Accuracy </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).MenuLL_DMS" >
<strong>COORDINATE:MenuLL_DMS(LL_DMS)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> LL_DMS </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).MenuMGRS_Accuracy" >
<strong>COORDINATE:MenuMGRS_Accuracy(MGRS_Accuracy)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> MGRS_Accuracy </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).MenuSystem" >
<strong>COORDINATE:MenuSystem(System)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> System </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).New" >
<strong>COORDINATE:New(x, y, LandHeightAdd)</strong>
</a>
</dt>
<dd>
<p>COORDINATE constructor.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> x </em></code>:
The x coordinate of the Vec3 point, pointing to the North.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> y </em></code>:
The y coordinate of the Vec3 point, pointing to the Right.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> LandHeightAdd </em></code>:
(optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).NewFromVec2" >
<strong>COORDINATE:NewFromVec2(Vec2, LandHeightAdd)</strong>
</a>
</dt>
<dd>
<p>Create a new COORDINATE object from Vec2 coordinates.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec2)">Dcs.DCSTypes#Vec2</a> Vec2 </em></code>:
The Vec2 point.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> LandHeightAdd </em></code>:
(optional) The default height if required to be evaluated will be the land height of the x, y coordinate. You can specify an extra height to be added to the land height.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).NewFromVec3" >
<strong>COORDINATE:NewFromVec3(Vec3)</strong>
</a>
</dt>
<dd>
<p>Create a new COORDINATE object from Vec3 coordinates.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Vec3)">Dcs.DCSTypes#Vec3</a> Vec3 </em></code>:
The Vec3 point.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(COORDINATE).System" >
<strong>COORDINATE.System</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).SystemMenu" >
<strong>COORDINATE.SystemMenu</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).ToString" >
<strong>COORDINATE:ToString()</strong>
</a>
</dt>
<dd>
<p>Provides a coordinate string of the point, based on a coordinate format system:
* Uses default settings in COORDINATE.</p>
<ul>
<li>Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The coordinate Text in the configured coordinate system.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).ToStringLL" >
<strong>COORDINATE:ToStringLL(LL_Accuracy, LL_DMS)</strong>
</a>
</dt>
<dd>
<p>Provides a Lat Lon string</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number LL_Accuracy </em></code>:
The accurancy of significant numbers behind the comma... So Accurancy of 2 is 0.01.</p>
</li>
<li>
<p><code><em>#boolean LL_DMS </em></code>:
true = Degrees, Minutes, Seconds; false = Degrees, Minutes</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The LL Text</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(COORDINATE).ToStringMGRS" >
<strong>COORDINATE:ToStringMGRS(MGRS_Accuracy)</strong>
</a>
</dt>
<dd>
<p>Provides a MGRS string</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number MGRS_Accuracy </em></code>:
of the 5 digit code.
Precision depends on the Accuracy choosen:
* 0 = no digits - precision level 100 km
* 1 = 1 digits - precision level 10 km
* 2 = 2 digits - precision level 1 km
* 3 = 3 digits - precision level 100 m
* 4 = 4 digits - precision level 10 m.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The MGRS Text</p>
</dd>
</dl>
<h2><a id="#(POINT_VEC2)" >Type <code>POINT_VEC2</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
@@ -2664,49 +3184,6 @@ The BR Text</p>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).ToStringLL" >
<strong>POINT_VEC3:ToStringLL(AngleRadians, Distance, acc, DMS)</strong>
</a>
</dt>
<dd>
<p>Provides a Bearing / Range string</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#number AngleRadians </em></code>:
The angle in randians</p>
</li>
<li>
<p><code><em>#number Distance </em></code>:
The distance</p>
</li>
<li>
<p><code><em> acc </em></code>: </p>
</li>
<li>
<p><code><em> DMS </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em>
The BR Text</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POINT_VEC3).Translate" >
<strong>POINT_VEC3:Translate(Distance, Angle)</strong>
</a>

34
docs/Documentation/Positionable.html
View File

@@ -163,6 +163,12 @@
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).GetBeacon">POSITIONABLE:GetBeacon()</a></td>
<td class="summary">
<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).GetCoordinate">POSITIONABLE:GetCoordinate()</a></td>
<td class="summary">
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr>
@@ -457,6 +463,34 @@ Radio</p>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetCoordinate" >
<strong>POSITIONABLE:GetCoordinate()</strong>
</a>
</dt>
<dd>
<p>Returns a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The COORDINATE of the POSITIONABLE.</p>
</li>
<li>
<p><em>#nil:</em>
The POSITIONABLE is not existing or alive. </p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(POSITIONABLE).GetHeading" >
<strong>POSITIONABLE:GetHeading()</strong>
</a>

12
docs/Documentation/Spawn.html
View File

@@ -2527,9 +2527,6 @@ when nothing was spawned.</p>
<p> Overwrite unit names by default with group name.</p>
</dd>
</dl>
<dl class="function">
@@ -2544,6 +2541,9 @@ when nothing was spawned.</p>
<p> By default, no InitLimit</p>
</dd>
</dl>
<dl class="function">
@@ -2579,7 +2579,7 @@ when nothing was spawned.</p>
<dl class="function">
<dt>
<em></em>
<em>#number</em>
<a id="#(SPAWN).SpawnMaxGroups" >
<strong>SPAWN.SpawnMaxGroups</strong>
</a>
@@ -2596,7 +2596,7 @@ when nothing was spawned.</p>
<dl class="function">
<dt>
<em></em>
<em>#number</em>
<a id="#(SPAWN).SpawnMaxUnitsAlive" >
<strong>SPAWN.SpawnMaxUnitsAlive</strong>
</a>
@@ -2948,7 +2948,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
</dd>
</dl>

59
docs/Documentation/Task.html
View File

@@ -424,6 +424,12 @@
<td class="name" nowrap="nowrap"><a href="##(TASK).ReportDetails">TASK:ReportDetails()</a></td>
<td class="summary">
<p>Create a detailed report of the Task.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).ReportOverview">TASK:ReportOverview()</a></td>
<td class="summary">
<p>Create an overiew report of the Task.</p>
</td>
</tr>
<tr>
@@ -466,6 +472,12 @@
<td class="name" nowrap="nowrap"><a href="##(TASK).SetID">TASK:SetID(TaskID)</a></td>
<td class="summary">
<p>Sets the ID of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).SetInfo">TASK:SetInfo(TaskInfo, TaskInfoText)</a></td>
<td class="summary">
<p>Sets the Information on the Task</p>
</td>
</tr>
<tr>
@@ -1859,6 +1871,27 @@ self</p>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK).ReportOverview" >
<strong>TASK:ReportOverview()</strong>
</a>
</dt>
<dd>
<p>Create an overiew report of the Task.</p>
<p>List the Task Name and Status</p>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
@@ -2016,6 +2049,32 @@ self</p>
<dl class="function">
<dt>
<a id="#(TASK).SetInfo" >
<strong>TASK:SetInfo(TaskInfo, TaskInfoText)</strong>
</a>
</dt>
<dd>
<p>Sets the Information on the Task</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string TaskInfo </em></code>: </p>
</li>
<li>
<p><code><em> TaskInfoText </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK).SetMenu" >
<strong>TASK:SetMenu(MenuTime)</strong>
</a>

36
docs/Documentation/Task_A2G_Dispatcher.html
View File

@@ -182,7 +182,7 @@ Find a summary below describing for which situation a task type is created:</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_DISPATCHER).EvaluateRemoveTask">TASK_A2G_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedItem)</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_DISPATCHER).EvaluateRemoveTask">TASK_A2G_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedItemID, DetectedItemChange, DetectedItemChanged)</a></td>
<td class="summary">
<p>Evaluates the removal of the Task from the Mission.</p>
</td>
@@ -221,6 +221,12 @@ Find a summary below describing for which situation a task type is created:</p>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_DISPATCHER).SetGroup">TASK_A2G_DISPATCHER.SetGroup</a></td>
<td class="summary">
<p>The groups to which the FAC will report to.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G_DISPATCHER).Tasks">TASK_A2G_DISPATCHER.Tasks</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -336,7 +342,7 @@ Find a summary below describing for which situation a task type is created:</p>
<dt>
<a id="#(TASK_A2G_DISPATCHER).EvaluateRemoveTask" >
<strong>TASK_A2G_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedItem)</strong>
<strong>TASK_A2G_DISPATCHER:EvaluateRemoveTask(Mission, Task, DetectedItemID, DetectedItemChange, DetectedItemChanged)</strong>
</a>
</dt>
<dd>
@@ -360,7 +366,17 @@ Find a summary below describing for which situation a task type is created:</p>
</li>
<li>
<p><code><em><a href="Functional.Detection.html##(DETECTION_AREAS.DetectedItem)">Functional.Detection#DETECTION_AREAS.DetectedItem</a> DetectedItem </em></code>: </p>
<p><code><em>#boolean DetectedItemID </em></code>: </p>
</li>
<li>
<p><code><em>#boolean DetectedItemChange </em></code>: </p>
</li>
<li>
<p><code><em> DetectedItemChanged </em></code>: </p>
</li>
</ul>
@@ -548,6 +564,20 @@ Return true if you want the task assigning to continue... false will cancel the
<p>The groups to which the FAC will report to.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_A2G_DISPATCHER).Tasks" >
<strong>TASK_A2G_DISPATCHER.Tasks</strong>
</a>
</dt>
<dd>
</dd>
</dl>

35
docs/Documentation/Utils.html
View File

@@ -299,6 +299,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<td class="name" nowrap="nowrap"><a href="##(UTILS).tostringLL">UTILS.tostringLL(lat, lon, acc, DMS)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(UTILS).tostringMGRS">UTILS.tostringMGRS(MGRS, acc)</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -867,6 +873,35 @@ So:
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(UTILS).tostringMGRS" >
<strong>UTILS.tostringMGRS(MGRS, acc)</strong>
</a>
</dt>
<dd>
<p> acc- the accuracy of each easting/northing. 0, 1, 2, 3, 4, or 5.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> MGRS </em></code>: </p>
</li>
<li>
<p><code><em> acc </em></code>: </p>
</li>
</ul>
</dd>
</dl>
</div>

33
docs/Documentation/Zone.html
View File

@@ -252,6 +252,12 @@
<td class="name" nowrap="nowrap"><a href="##(ZONE_BASE).GetBoundingSquare">ZONE_BASE:GetBoundingSquare()</a></td>
<td class="summary">
<p>Get the bounding square the zone.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_BASE).GetCoordinate">ZONE_BASE:GetCoordinate(Height)</a></td>
<td class="summary">
<p>Returns a <a href="Point.html##(COORDINATE)">Point#COORDINATE</a> of the zone.</p>
</td>
</tr>
<tr>
@@ -933,6 +939,33 @@ The bounding square.</p>
<dl class="function">
<dt>
<a id="#(ZONE_BASE).GetCoordinate" >
<strong>ZONE_BASE:GetCoordinate(Height)</strong>
</a>
</dt>
<dd>
<p>Returns a <a href="Point.html##(COORDINATE)">Point#COORDINATE</a> of the zone.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Dcs.DCSTypes.html##(Distance)">Dcs.DCSTypes#Distance</a> Height </em></code>:
The height to add to the land height where the center of the zone is located.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</em>
The Coordinate of the zone.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_BASE).GetName" >
<strong>ZONE_BASE:GetName()</strong>
</a>