mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Finalization of patch.
This commit is contained in:
FlightControl
@@ -145,6 +145,13 @@ There are two functions which you use to subscribe to or unsubscribe from an eve
|
||||
<li><a href="Base.html##(BASE).UnHandleEvent">Base#BASE.UnHandleEvent</a>(): Unsubscribe from a DCS Event.</li>
|
||||
</ul>
|
||||
|
||||
<p>Note that for a UNIT, the event will be handled <strong>for that UNIT only</strong>!
|
||||
Note that for a GROUP, the event will be handled <strong>for all the UNITs in that GROUP only</strong>!</p>
|
||||
|
||||
<p>For all objects of other classes, the subscribed events will be handled for <strong>all UNITs within the Mission</strong>!
|
||||
So if a UNIT within the mission has the subscribed event for that object,
|
||||
then the object event handler will receive the event for that UNIT!</p>
|
||||
|
||||
<h3>1.3.2 Event Handling of DCS Events</h3>
|
||||
|
||||
<p>Once the class is subscribed to the event, an <strong>Event Handling</strong> method on the object or class needs to be written that will be called
|
||||
@@ -252,7 +259,8 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
|
||||
<p>Hereby the change log:</p>
|
||||
|
||||
<ul>
|
||||
<li>2016-02-07: Did a complete revision of the Event Handing API and underlying mechanisms.</li>
|
||||
<li><p>2017-03-07: Added the correct event dispatching in case the event is subscribed by a GROUP.</p></li>
|
||||
<li><p>2017-02-07: Did a complete revision of the Event Handing API and underlying mechanisms.</p></li>
|
||||
</ul>
|
||||
|
||||
<hr/>
|
||||
@@ -427,6 +435,12 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEngineStartUpRemove">EVENT:OnEngineStartUpRemove(EventClass)</a></td>
|
||||
<td class="summary">
|
||||
<p>Stop listening to S<em>EVENT</em>ENGINE_STARTUP event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventForGroup">EVENT:OnEventForGroup(GroupName, EventFunction, EventClass, EventID)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event for a GROUP.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -436,9 +450,9 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventForUnit">EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventClass, EventID)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventForUnit">EVENT:OnEventForUnit(UnitName, EventFunction, EventClass, EventID)</a></td>
|
||||
<td class="summary">
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event</p>
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event for a UNIT.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -574,9 +588,15 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).RemoveForUnit">EVENT:RemoveForUnit(EventClass, EventID, UnitName)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).RemoveForGroup">EVENT:RemoveForGroup(GroupName, EventClass, EventID)</a></td>
|
||||
<td class="summary">
|
||||
<p>Removes an Events entry for a Unit</p>
|
||||
<p>Removes an Events entry for a GROUP.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(EVENT).RemoveForUnit">EVENT:RemoveForUnit(UnitName, EventClass, EventID)</a></td>
|
||||
<td class="summary">
|
||||
<p>Removes an Events entry for a UNIT.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -1704,6 +1724,50 @@ The self instance of the class for which the event is.</p>
|
||||
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(EVENT).OnEventForGroup" >
|
||||
<strong>EVENT:OnEventForGroup(GroupName, EventFunction, EventClass, EventID)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event for a GROUP.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string GroupName </em></code>:
|
||||
The name of the GROUP.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#function EventFunction </em></code>:
|
||||
The function to be called when the event occurs for the GROUP.</p>
|
||||
|
||||
</li>
|
||||
<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> EventID </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -1753,24 +1817,25 @@ The instance of the class for which the event is.</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(EVENT).OnEventForUnit" >
|
||||
<strong>EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventClass, EventID)</strong>
|
||||
<strong>EVENT:OnEventForUnit(UnitName, EventFunction, EventClass, EventID)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event</p>
|
||||
<p>Set a new listener for an S<em>EVENT</em>X event for a UNIT.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string EventDCSUnitName </em></code>: </p>
|
||||
<p><code><em>#string UnitName </em></code>:
|
||||
The name of the UNIT.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#function EventFunction </em></code>:
|
||||
The function to be called when the event occurs for the unit.</p>
|
||||
The function to be called when the event occurs for the GROUP.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
@@ -2470,18 +2535,24 @@ 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 id="#(EVENT).RemoveForGroup" >
|
||||
<strong>EVENT:RemoveForGroup(GroupName, EventClass, EventID)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Removes an Events entry for a Unit</p>
|
||||
<p>Removes an Events entry for a GROUP.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string GroupName </em></code>:
|
||||
The name of the GROUP.</p>
|
||||
|
||||
</li>
|
||||
<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>
|
||||
|
||||
@@ -2491,9 +2562,42 @@ The self instance of the class for which the event is.</p>
|
||||
<p><code><em><a href="Dcs.DCSWorld.html##(world.event)">Dcs.DCSWorld#world.event</a> EventID </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).RemoveForUnit" >
|
||||
<strong>EVENT:RemoveForUnit(UnitName, EventClass, EventID)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Removes an Events entry for a UNIT.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> UnitName </em></code>: </p>
|
||||
<p><code><em>#string UnitName </em></code>:
|
||||
The name of the UNIT.</p>
|
||||
|
||||
</li>
|
||||
<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>
|
||||
</ul>
|
||||
|
||||
Reference in New Issue
Block a user