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

Event documentation

Browse Source
This commit is contained in:
FlightControl
2017-02-07 13:46:52 +01:00
parent 1441d035d7
commit 20f8a98cf0
10 changed files with 1246 additions and 936 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/Documentation/Unit.html
View File

@@ -289,6 +289,12 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
<td class="name" nowrap="nowrap"><a href="##(UNIT).GetUnits">UNIT:GetUnits()</a></td>
<td class="summary">
<p>Returns the UNIT in a UNIT list of one element.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(UNIT).HandleEvent">UNIT:HandleEvent(Event, EventFunction)</a></td>
<td class="summary">
<p>Subscribe to a DCS Event.</p>
</td>
</tr>
<tr>
@@ -409,6 +415,12 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
<td class="name" nowrap="nowrap"><a href="##(UNIT).SmokeWhite">UNIT:SmokeWhite()</a></td>
<td class="summary">
<p>Smoke the UNIT White.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(UNIT).UnHandleEvent">UNIT:UnHandleEvent(Event)</a></td>
<td class="summary">
<p>UnSubscribe to a DCS event.</p>
</td>
</tr>
</table>
@@ -1024,6 +1036,38 @@ The DCS Unit is not existing or alive. </p>
<p><em><a href="##(list)">#list</a>:</em>
Wrapper.Unit#UNIT> The UNITs wrappers.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(UNIT).HandleEvent" >
<strong>UNIT:HandleEvent(Event, EventFunction)</strong>
</a>
</dt>
<dd>
<p>Subscribe to a DCS Event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a> Event </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
(optional) The function to be called when the event occurs for the unit.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(UNIT)">#UNIT</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -1505,6 +1549,32 @@ The name of the DCS unit.</p>
<p>Smoke the UNIT White.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(UNIT).UnHandleEvent" >
<strong>UNIT:UnHandleEvent(Event)</strong>
</a>
</dt>
<dd>
<p>UnSubscribe to a DCS event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a> Event </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(UNIT)">#UNIT</a>:</em></p>
</dd>
</dl>