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

86
docs/Documentation/Event.html
View File

@@ -71,10 +71,21 @@
<div id="content">
<h1>Module <code>Event</code></h1>
<p>This module contains the EVENT class.</p>
<p>This module contains the <strong>EVENT</strong> class, which models the dispatching of DCS Events to subscribed MOOSE classes,
following a given priority.</p>
<h2></h2>
<p><img src="..\Presentations\FSM\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
<ul>
<li>This module contains the EVENT class.</li>
</ul>
<hr/>
<p>Takes care of EVENT dispatching between DCS events and event handling functions defined in MOOSE classes.</p>
@@ -95,6 +106,12 @@
<td class="name" nowrap="nowrap"><a href="#EVENT">EVENT</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#EVENTS">EVENTS</a></td>
<td class="summary">
</td>
</tr>
</table>
@@ -125,7 +142,7 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).Init">EVENT:Init(EventID, EventPriority, EventClass)</a></td>
<td class="name" nowrap="nowrap"><a href="##(EVENT).Init">EVENT:Init(EventID, EventClass)</a></td>
<td class="summary">
<p>Initializes the Events structure for the event</p>
</td>
@@ -380,6 +397,12 @@
<td class="name" nowrap="nowrap"><a href="##(EVENT).RemoveAll">EVENT:RemoveAll(EventObject)</a></td>
<td class="summary">
<p>Clears all event subscriptions for a <a href="Base.html##(BASE)">Base#BASE</a> derived object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).RemoveForUnit">EVENT:RemoveForUnit(EventClass, EventID, UnitName)</a></td>
<td class="summary">
<p>Removes an Events entry for a Unit</p>
</td>
</tr>
<tr>
@@ -537,6 +560,20 @@
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="EVENTS" >
<strong>EVENTS</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Event)" >Type <code>Event</code></a></h2>
@@ -613,7 +650,7 @@
<dt>
<a id="#(EVENT).Init" >
<strong>EVENT:Init(EventID, EventPriority, EventClass)</strong>
<strong>EVENT:Init(EventID, EventClass)</strong>
</a>
</dt>
<dd>
@@ -629,12 +666,6 @@
</li>
<li>
<p><code><em>#number EventPriority </em></code>:
The priority of the EventClass.</p>
</li>
<li>
<p><code><em><a href="Core.Base.html##(BASE)">Core.Base#BASE</a> EventClass </em></code>: </p>
</li>
@@ -2006,6 +2037,43 @@ The self instance of the class for which the event is.</p>
<dl class="function">
<dt>
<a id="#(EVENT).RemoveForUnit" >
<strong>EVENT:RemoveForUnit(EventClass, EventID, UnitName)</strong>
</a>
</dt>
<dd>
<p>Removes an Events entry for a Unit</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Base.html##(BASE)">Core.Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSWorld.html##(world.event)">Dcs.DCSWorld#world.event</a> EventID </em></code>: </p>
</li>
<li>
<p><code><em> UnitName </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT.Events)">#EVENT.Events</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).onEvent" >
<strong>EVENT:onEvent(Event)</strong>
</a>