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

Documentation

Browse Source
This commit is contained in:
FlightControl
2017-05-29 14:09:07 +02:00
parent bc734f1190
commit 4e29565382
27 changed files with 1007 additions and 456 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
docs/Documentation/Detection.html
View File

@@ -360,9 +360,9 @@ 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).CleanDetectionItems">DETECTION_BASE:CleanDetectionItems()</a></td>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).CleanDetectionItem">DETECTION_BASE:CleanDetectionItem(DetectedItem, DetectedItemID)</a></td>
<td class="summary">
<p>Make a DetectionSet table.</p>
</td>
</tr>
<tr>
@@ -650,6 +650,12 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).InitDetectVisual">DETECTION_BASE:InitDetectVisual(DetectVisual)</a></td>
<td class="summary">
<p>Detect Visual.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).IsDetectedItemDetected">DETECTION_BASE:IsDetectedItemDetected(DetectedItem)</a></td>
<td class="summary">
<p>Checks if there is at least one UNIT detected in the Set of the the DetectedItem.</p>
</td>
</tr>
<tr>
@@ -854,6 +860,12 @@ The different values of Unit.Category can be:</p>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).UnIdentifyDetectedObject">DETECTION_BASE:UnIdentifyDetectedObject(DetectedObject)</a></td>
<td class="summary">
<p>UnIdentify a detected object during detection processing.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).UpdateDetectedItemDetection">DETECTION_BASE:UpdateDetectedItemDetection(DetectedItem)</a></td>
<td class="summary">
<p>Set IsDetected flag for all DetectedItems.</p>
</td>
</tr>
<tr>
@@ -893,7 +905,7 @@ The different values of Unit.Category can be:</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).onafterDetectionGroup">DETECTION_BASE:onafterDetectionGroup(From, Event, To, DetectionGroup)</a></td>
<td class="name" nowrap="nowrap"><a href="##(DETECTION_BASE).onafterDetectionGroup">DETECTION_BASE:onafterDetectionGroup(From, Event, To, DetectionGroup, DetectionTimeStamp)</a></td>
<td class="summary">
</td>
@@ -2188,22 +2200,32 @@ The index of the DetectedItem.</p>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).CleanDetectionItems" >
<strong>DETECTION_BASE:CleanDetectionItems()</strong>
<a id="#(DETECTION_BASE).CleanDetectionItem" >
<strong>DETECTION_BASE:CleanDetectionItem(DetectedItem, DetectedItemID)</strong>
</a>
</dt>
<dd>
<p>Make a DetectionSet table.</p>
<p>This function will be overridden in the derived clsses.</p>
<p> Clean the DetectedItem table.
@param #DETECTION<em>BASE self
@return #DETECTION</em>BASE</p>
<h3>Return value</h3>
<h3>Parameters</h3>
<ul>
<li>
<p><em><a href="##(DETECTION_BASE)">#DETECTION_BASE</a>:</em></p>
<p><code><em> DetectedItem </em></code>: </p>
</li>
<li>
<p><code><em> DetectedItemID </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
@@ -3145,6 +3167,32 @@ self</p>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).IsDetectedItemDetected" >
<strong>DETECTION_BASE:IsDetectedItemDetected(DetectedItem)</strong>
</a>
</dt>
<dd>
<p>Checks if there is at least one UNIT detected in the Set of the the DetectedItem.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DetectedItem </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).IsDetectedObjectIdentified" >
<strong>DETECTION_BASE:IsDetectedObjectIdentified(DetectedObject)</strong>
</a>
@@ -4099,6 +4147,42 @@ self</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(DETECTION_BASE).UpdateDetectedItemDetection" >
<strong>DETECTION_BASE:UpdateDetectedItemDetection(DetectedItem)</strong>
</a>
</dt>
<dd>
<p>Set IsDetected flag for all DetectedItems.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> DetectedItem </em></code>: </p>
</li>
</ul>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="##(DETECTION_BASE.DetectedItem)">#DETECTION_BASE.DetectedItem</a>:</em>
DetectedItem</p>
</li>
<li>
<p><em>#boolean:</em>
true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.</p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
@@ -4240,7 +4324,7 @@ The To State string.</p>
<dt>
<a id="#(DETECTION_BASE).onafterDetectionGroup" >
<strong>DETECTION_BASE:onafterDetectionGroup(From, Event, To, DetectionGroup)</strong>
<strong>DETECTION_BASE:onafterDetectionGroup(From, Event, To, DetectionGroup, DetectionTimeStamp)</strong>
</a>
</dt>
<dd>
@@ -4272,6 +4356,11 @@ The To State string.</p>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> DetectionGroup </em></code>:
The Group detecting.</p>
</li>
<li>
<p><code><em> DetectionTimeStamp </em></code>: </p>
</li>
</ul>
</dd>