MOOSE/docs/Documentation/Event.html
2017-03-04 16:02:21 +01:00

3415 lines
74 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
<li><a href="Assign.html">Assign</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="Cargo.html">Cargo</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="CommandCenter.html">CommandCenter</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li>Event</li>
<li><a href="Fsm.html">Fsm</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li><a href="Route.html">Route</a></li>
<li><a href="Scenery.html">Scenery</a></li>
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</a></li>
<li><a href="Scheduler.html">Scheduler</a></li>
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="Static.html">Static</a></li>
<li><a href="Task.html">Task</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Event</code></h1>
<p>This core module models the dispatching of DCS Events to subscribed MOOSE classes,
following a given priority.</p>
<p><img src="..\Presentations\EVENT\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
<h1>1) Event Handling Overview</h1>
<p><img src="..\Presentations\EVENT\Dia2.JPG" alt="Objects"/></p>
<p>Within a running mission, various DCS events occur. Units are dynamically created, crash, die, shoot stuff, get hit etc.
This module provides a mechanism to dispatch those events occuring within your running mission, to the different objects orchestrating your mission.</p>
<p><img src="..\Presentations\EVENT\Dia3.JPG" alt="Objects"/></p>
<p>Objects can subscribe to different events. The Event dispatcher will publish the received DCS events to the subscribed MOOSE objects, in a specified order.
In this way, the subscribed MOOSE objects are kept in sync with your evolving running mission.</p>
<h2>1.1) Event Dispatching</h2>
<p><img src="..\Presentations\EVENT\Dia4.JPG" alt="Objects"/></p>
<p>The _EVENTDISPATCHER object is automatically created within MOOSE,
and handles the dispatching of DCS Events occurring
in the simulator to the subscribed objects
in the correct processing order.</p>
<p><img src="..\Presentations\EVENT\Dia5.JPG" alt="Objects"/></p>
<p>There are 5 levels of kind of objects that the _EVENTDISPATCHER services:</p>
<ul>
<li>_DATABASE object: The core of the MOOSE objects. Any object that is created, deleted or updated, is done in this database.</li>
<li>SET_ derived classes: Subsets of the _DATABASE object. These subsets are updated by the _EVENTDISPATCHER as the second priority.</li>
<li>UNIT objects: UNIT objects can subscribe to DCS events. Each DCS event will be directly published to teh subscribed UNIT object.</li>
<li>GROUP objects: GROUP objects can subscribe to DCS events. Each DCS event will be directly published to the subscribed GROUP object.</li>
<li>Any other object: Various other objects can subscribe to DCS events. Each DCS event triggered will be published to each subscribed object.</li>
</ul>
<p><img src="..\Presentations\EVENT\Dia6.JPG" alt="Objects"/></p>
<p>For most DCS events, the above order of updating will be followed.</p>
<p><img src="..\Presentations\EVENT\Dia7.JPG" alt="Objects"/></p>
<p>But for some DCS events, the publishing order is reversed. This is due to the fact that objects need to be <strong>erased</strong> instead of added.</p>
<h2>1.2) Event Handling</h2>
<p><img src="..\Presentations\EVENT\Dia8.JPG" alt="Objects"/></p>
<p>The actual event subscribing and handling is not facilitated through the _EVENTDISPATCHER, but it is done through the <a href="BASE.html">BASE</a> class, <a href="UNIT.html">UNIT</a> class and <a href="GROUP.html">GROUP</a> class.
The _EVENTDISPATCHER is a component that is quietly working in the background of MOOSE.</p>
<p><img src="..\Presentations\EVENT\Dia9.JPG" alt="Objects"/></p>
<p>The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator,
and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.</p>
<h3>1.2.1 Subscribe / Unsubscribe to DCS Events</h3>
<p>At first, the mission designer will need to <strong>Subscribe</strong> to a specific DCS event for the class.
So, when the DCS event occurs, the class will be notified of that event.
There are two functions which you use to subscribe to or unsubscribe from an event.</p>
<ul>
<li><a href="Base.html##(BASE).HandleEvent">Base#BASE.HandleEvent</a>(): Subscribe to a DCS Event.</li>
<li><a href="Base.html##(BASE).UnHandleEvent">Base#BASE.UnHandleEvent</a>(): Unsubscribe from a DCS Event.</li>
</ul>
<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
when the DCS event occurs. The Event Handling method receives an <a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> structure, which contains a lot of information
about the event that occurred.</p>
<p>Find below an example of the prototype how to write an event handling function for two units: </p>
<pre><code> local Tank1 = UNIT:FindByName( "Tank A" )
local Tank2 = UNIT:FindByName( "Tank B" )
-- Here we subscribe to the Dead events. So, if one of these tanks dies, the Tank1 or Tank2 objects will be notified.
Tank1:HandleEvent( EVENTS.Dead )
Tank2:HandleEvent( EVENTS.Dead )
--- This function is an Event Handling function that will be called when Tank1 is Dead.
-- @param Wrapper.Unit#UNIT self
-- @param Core.Event#EVENTDATA EventData
function Tank1:OnEventDead( EventData )
self:SmokeGreen()
end
--- This function is an Event Handling function that will be called when Tank2 is Dead.
-- @param Wrapper.Unit#UNIT self
-- @param Core.Event#EVENTDATA EventData
function Tank2:OnEventDead( EventData )
self:SmokeBlue()
end
</code></pre>
<h3>1.3.3 Event Handling methods that are automatically called upon subscribed DCS events</h3>
<p><img src="..\Presentations\EVENT\Dia10.JPG" alt="Objects"/></p>
<p>The following list outlines which EVENTS item in the structure corresponds to which Event Handling method.
Always ensure that your event handling methods align with the events being subscribed to, or nothing will be executed.</p>
<h1>2) EVENTS type</h1>
<p>The EVENTS structure contains names for all the different DCS events that objects can subscribe to using the
<a href="Base.html##(BASE).HandleEvent">Base#BASE.HandleEvent</a>() method.</p>
<h1>3) EVENTDATA type</h1>
<p>The <a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> structure contains all the fields that are populated with event information before
an Event Handler method is being called by the event dispatcher.
The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events.
There are basically 4 main categories of information stored in the EVENTDATA structure:</p>
<ul>
<li><p>Initiator Unit data: Several fields documenting the initiator unit related to the event.</p></li>
<li><p>Target Unit data: Several fields documenting the target unit related to the event.</p></li>
<li><p>Weapon data: Certain events populate weapon information.</p></li>
<li><p>Place data: Certain events populate place information.</p>
<p> --- This function is an Event Handling function that will be called when Tank1 is Dead.
-- EventData is an EVENTDATA structure.
-- We use the EventData.IniUnit to smoke the tank Green.
-- @param Wrapper.Unit#UNIT self
-- @param Core.Event#EVENTDATA EventData
function Tank1:OnEventDead( EventData )</p>
<p> EventData.IniUnit:SmokeGreen()
end</p></li>
</ul>
<p>Find below an overview which events populate which information categories:</p>
<p><img src="..\Presentations\EVENT\Dia14.JPG" alt="Objects"/></p>
<p><strong>IMPORTANT NOTE:</strong> Some events can involve not just UNIT objects, but also STATIC objects!!!
In that case the initiator or target unit fields will refer to a STATIC object!
In case a STATIC object is involved, the documentation indicates which fields will and won't not be populated.
The fields <strong>IniObjectCategory</strong> and <strong>TgtObjectCategory</strong> contain the indicator which <strong>kind of object is involved</strong> in the event.
You can use the enumerator <strong>Object.Category.UNIT</strong> and <strong>Object.Category.STATIC</strong> to check on IniObjectCategory and TgtObjectCategory.
Example code snippet:</p>
<pre><code> if Event.IniObjectCategory == Object.Category.UNIT then
...
end
if Event.IniObjectCategory == Object.Category.STATIC then
...
end
</code></pre>
<p>When a static object is involved in the event, the Group and Player fields won't be populated.</p>
<hr/>
<h1><strong>API CHANGE HISTORY</strong></h1>
<p>The underlying change log documents the API changes. Please read this carefully. The following notation is used:</p>
<ul>
<li><strong>Added</strong> parts are expressed in bold type face.</li>
<li><em>Removed</em> parts are expressed in italic type face.</li>
</ul>
<p>YYYY-MM-DD: CLASS:<strong>NewFunction</strong>( Params ) replaces CLASS:<em>OldFunction</em>( Params )
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>
</ul>
<hr/>
<h1><strong>AUTHORS and CONTRIBUTIONS</strong></h1>
<h3>Contributions:</h3>
<h3>Authors:</h3>
<ul>
<li><a href="https://forums.eagle.ru/member.php?u=89536"><strong>FlightControl</strong></a>: Design &amp; Programming &amp; documentation.</li>
</ul>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#EVENT">EVENT</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#EVENTHANDLER">EVENTHANDLER</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>
<h2><a id="#(EVENT)">Type <code>EVENT</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).ClassID">EVENT.ClassID</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).ClassName">EVENT.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).EventText">EVENT:EventText(EventID)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).Events">EVENT.Events</a></td>
<td class="summary">
</td>
</tr>
<tr>
<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>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).New">EVENT:New()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnBirth">EVENT:OnBirth(EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>BIRTH event, and registers the unit born.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnBirthForTemplate">EVENT:OnBirthForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)</a></td>
<td class="summary">
<p>Create an OnBirth event handler for a group</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnBirthForUnit">EVENT:OnBirthForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>BIRTH event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnBirthRemove">EVENT:OnBirthRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>BIRTH event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnCrash">EVENT:OnCrash(EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>CRASH event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnCrashForTemplate">EVENT:OnCrashForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)</a></td>
<td class="summary">
<p>Create an OnCrash event handler for a group</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnCrashForUnit">EVENT:OnCrashForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>CRASH event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnCrashRemove">EVENT:OnCrashRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>CRASH event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnDead">EVENT:OnDead(EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>DEAD event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnDeadForTemplate">EVENT:OnDeadForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)</a></td>
<td class="summary">
<p>Create an OnDead event handler for a group</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnDeadForUnit">EVENT:OnDeadForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>DEAD event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnDeadRemove">EVENT:OnDeadRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>DEAD event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEngineShutDownForTemplate">EVENT:OnEngineShutDownForTemplate(EventTemplate, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Create an OnDead event handler for a group</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEngineShutDownForUnit">EVENT:OnEngineShutDownForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>ENGINE_SHUTDOWN event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEngineShutDownRemove">EVENT:OnEngineShutDownRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>ENGINE_SHUTDOWN event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEngineStartUpForUnit">EVENT:OnEngineStartUpForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>ENGINE_STARTUP event.</p>
</td>
</tr>
<tr>
<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).OnEventForTemplate">EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction)</a></td>
<td class="summary">
<p>Create an OnDead event handler for a group</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventForUnit">EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventClass, EventID)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>X event</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnEventGeneric">EVENT:OnEventGeneric(EventFunction, EventClass, EventID)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>X event independent from a unit or a weapon.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnHit">EVENT:OnHit(EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>HIT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnHitForUnit">EVENT:OnHitForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>HIT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnHitRemove">EVENT:OnHitRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>HIT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnLandForTemplate">EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventClass)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnLandForUnit">EVENT:OnLandForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>LAND event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnLandRemove">EVENT:OnLandRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>LAND event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPilotDead">EVENT:OnPilotDead(EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>PILOT_DEAD event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPilotDeadForUnit">EVENT:OnPilotDeadForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>PILOT_DEAD event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPilotDeadRemove">EVENT:OnPilotDeadRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>PILOT_DEAD event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPlayerEnterRemove">EVENT:OnPlayerEnterRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>PLAYER<em>ENTER</em>UNIT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPlayerEnterUnit">EVENT:OnPlayerEnterUnit(EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>PLAYER<em>ENTER</em>UNIT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPlayerLeaveRemove">EVENT:OnPlayerLeaveRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>PLAYER<em>LEAVE</em>UNIT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnPlayerLeaveUnit">EVENT:OnPlayerLeaveUnit(EventFunction, EventClass)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnShot">EVENT:OnShot(EventFunction, EventClass)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnShotForUnit">EVENT:OnShotForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>SHOT event for a unit.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnShotRemove">EVENT:OnShotRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>SHOT event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnTakeOffForTemplate">EVENT:OnTakeOffForTemplate(EventTemplate, EventFunction, EventClass)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnTakeOffForUnit">EVENT:OnTakeOffForUnit(EventDCSUnitName, EventFunction, EventClass)</a></td>
<td class="summary">
<p>Set a new listener for an S<em>EVENT</em>TAKEOFF event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).OnTakeOffRemove">EVENT:OnTakeOffRemove(EventClass)</a></td>
<td class="summary">
<p>Stop listening to S<em>EVENT</em>TAKEOFF event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT).Remove">EVENT:Remove(EventClass, EventID)</a></td>
<td class="summary">
<p>Removes an Events entry</p>
</td>
</tr>
<tr>
<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>
<td class="name" nowrap="nowrap"><a href="##(EVENT).onEvent">EVENT:onEvent(Event)</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(EVENT.Events)">Type <code>EVENT.Events</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENT.Events).IniUnit">EVENT.Events.IniUnit</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(EVENTDATA)">Type <code>EVENTDATA</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniCategory">EVENTDATA.IniCategory</a></td>
<td class="summary">
<p>(UNIT) The category of the initiator.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniCoalition">EVENTDATA.IniCoalition</a></td>
<td class="summary">
<p>(UNIT) The coalition of the initiator.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSGroup">EVENTDATA.IniDCSGroup</a></td>
<td class="summary">
<p>(UNIT) The initiating {DCSGroup#Group}.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSGroupName">EVENTDATA.IniDCSGroupName</a></td>
<td class="summary">
<p>(UNIT) The initiating Group name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSUnit">EVENTDATA.IniDCSUnit</a></td>
<td class="summary">
<p>(UNIT/STATIC) The initiating <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSUnitName">EVENTDATA.IniDCSUnitName</a></td>
<td class="summary">
<p>(UNIT/STATIC) The initiating Unit name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniGroup">EVENTDATA.IniGroup</a></td>
<td class="summary">
<p>(UNIT) The initiating MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the initiator Group object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniGroupName">EVENTDATA.IniGroupName</a></td>
<td class="summary">
<p>UNIT) The initiating GROUP name (same as IniDCSGroupName).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniObjectCategory">EVENTDATA.IniObjectCategory</a></td>
<td class="summary">
<p>(UNIT/STATIC/SCENERY) The initiator object category ( Object.Category.UNIT or Object.Category.STATIC ).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniPlayerName">EVENTDATA.IniPlayerName</a></td>
<td class="summary">
<p>(UNIT) The name of the initiating player in case the Unit is a client or player slot.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniTypeName">EVENTDATA.IniTypeName</a></td>
<td class="summary">
<p>(UNIT) The type name of the initiator.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniUnit">EVENTDATA.IniUnit</a></td>
<td class="summary">
<p>(UNIT/STATIC) The initiating MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the initiator Unit object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniUnitName">EVENTDATA.IniUnitName</a></td>
<td class="summary">
<p>(UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtCategory">EVENTDATA.TgtCategory</a></td>
<td class="summary">
<p>(UNIT) The category of the target.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtCoalition">EVENTDATA.TgtCoalition</a></td>
<td class="summary">
<p>(UNIT) The coalition of the target.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSGroup">EVENTDATA.TgtDCSGroup</a></td>
<td class="summary">
<p>(UNIT) The target {DCSGroup#Group}.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSGroupName">EVENTDATA.TgtDCSGroupName</a></td>
<td class="summary">
<p>(UNIT) The target Group name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSUnit">EVENTDATA.TgtDCSUnit</a></td>
<td class="summary">
<p>(UNIT/STATIC) The target <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSUnitName">EVENTDATA.TgtDCSUnitName</a></td>
<td class="summary">
<p>(UNIT/STATIC) The target Unit name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtGroup">EVENTDATA.TgtGroup</a></td>
<td class="summary">
<p>(UNIT) The target MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the target Group object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtGroupName">EVENTDATA.TgtGroupName</a></td>
<td class="summary">
<p>(UNIT) The target GROUP name (same as TgtDCSGroupName).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtObjectCategory">EVENTDATA.TgtObjectCategory</a></td>
<td class="summary">
<p>(UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtPlayerName">EVENTDATA.TgtPlayerName</a></td>
<td class="summary">
<p>(UNIT) The name of the target player in case the Unit is a client or player slot.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtTypeName">EVENTDATA.TgtTypeName</a></td>
<td class="summary">
<p>(UNIT) The type name of the target.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtUnit">EVENTDATA.TgtUnit</a></td>
<td class="summary">
<p>(UNIT/STATIC) The target MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the target Unit object.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtUnitName">EVENTDATA.TgtUnitName</a></td>
<td class="summary">
<p>(UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).Weapon">EVENTDATA.Weapon</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).WeaponName">EVENTDATA.WeaponName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).WeaponTgtDCSUnit">EVENTDATA.WeaponTgtDCSUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).id">EVENTDATA.id</a></td>
<td class="summary">
<p>The identifier of the event.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).initiator">EVENTDATA.initiator</a></td>
<td class="summary">
<p>(UNIT/STATIC/SCENERY) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).target">EVENTDATA.target</a></td>
<td class="summary">
<p>(UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).weapon">EVENTDATA.weapon</a></td>
<td class="summary">
<p>The weapon used during the event.</p>
</td>
</tr>
</table>
<h2><a id="#(EVENTHANDLER)">Type <code>EVENTHANDLER</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTHANDLER).ClassID">EVENTHANDLER.ClassID</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTHANDLER).ClassName">EVENTHANDLER.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTHANDLER).New">EVENTHANDLER:New()</a></td>
<td class="summary">
<p>The EVENTHANDLER constructor</p>
</td>
</tr>
</table>
<h2><a id="#(EVENTS)">Type <code>EVENTS</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).BaseCaptured">EVENTS.BaseCaptured</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Birth">EVENTS.Birth</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Crash">EVENTS.Crash</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Dead">EVENTS.Dead</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Ejection">EVENTS.Ejection</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).EngineShutdown">EVENTS.EngineShutdown</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).EngineStartup">EVENTS.EngineStartup</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Hit">EVENTS.Hit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).HumanFailure">EVENTS.HumanFailure</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Land">EVENTS.Land</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).MissionEnd">EVENTS.MissionEnd</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).MissionStart">EVENTS.MissionStart</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).PilotDead">EVENTS.PilotDead</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).PlayerComment">EVENTS.PlayerComment</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).PlayerEnterUnit">EVENTS.PlayerEnterUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).PlayerLeaveUnit">EVENTS.PlayerLeaveUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Refueling">EVENTS.Refueling</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).RefuelingStop">EVENTS.RefuelingStop</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).ShootingEnd">EVENTS.ShootingEnd</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).ShootingStart">EVENTS.ShootingStart</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Shot">EVENTS.Shot</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).Takeoff">EVENTS.Takeoff</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTS).TookControl">EVENTS.TookControl</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(EVENT)">#EVENT</a></em>
<a id="EVENT" >
<strong>EVENT</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(EVENTHANDLER)">#EVENTHANDLER</a></em>
<a id="EVENTHANDLER" >
<strong>EVENTHANDLER</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(EVENTS)">#EVENTS</a></em>
<a id="EVENTS" >
<strong>EVENTS</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Event)" >Type <code>Event</code></a></h2>
<h2><a id="#(EVENT)" >Type <code>EVENT</code></a></h2>
<p>The EVENT structure</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(EVENT).ClassID" >
<strong>EVENT.ClassID</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENT).ClassName" >
<strong>EVENT.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).EventText" >
<strong>EVENT:EventText(EventID)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> EventID </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(EVENT.Events)">#EVENT.Events</a></em>
<a id="#(EVENT).Events" >
<strong>EVENT.Events</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).Init" >
<strong>EVENT:Init(EventID, EventClass)</strong>
</a>
</dt>
<dd>
<p>Initializes the Events structure for the event</p>
<h3>Parameters</h3>
<ul>
<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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a> EventClass </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).New" >
<strong>EVENT:New()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnBirth" >
<strong>EVENT:OnBirth(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>BIRTH event, and registers the unit born.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnBirthForTemplate" >
<strong>EVENT:OnBirthForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)</strong>
</a>
</dt>
<dd>
<p>Create an OnBirth event handler for a group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EventGroup </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
<li>
<p><code><em> EventTemplate </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnBirthForUnit" >
<strong>EVENT:OnBirthForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>BIRTH event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>:
The id of the unit for the event to be handled.</p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnBirthRemove" >
<strong>EVENT:OnBirthRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>BIRTH event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnCrash" >
<strong>EVENT:OnCrash(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>CRASH event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnCrashForTemplate" >
<strong>EVENT:OnCrashForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)</strong>
</a>
</dt>
<dd>
<p>Create an OnCrash event handler for a group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EventGroup </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
<li>
<p><code><em> EventTemplate </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnCrashForUnit" >
<strong>EVENT:OnCrashForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>CRASH event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnCrashRemove" >
<strong>EVENT:OnCrashRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>CRASH event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnDead" >
<strong>EVENT:OnDead(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>DEAD event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnDeadForTemplate" >
<strong>EVENT:OnDeadForTemplate(EventGroup, EventFunction, EventClass, EventTemplate)</strong>
</a>
</dt>
<dd>
<p>Create an OnDead event handler for a group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> EventGroup </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
<li>
<p><code><em> EventTemplate </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnDeadForUnit" >
<strong>EVENT:OnDeadForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>DEAD event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnDeadRemove" >
<strong>EVENT:OnDeadRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>DEAD event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEngineShutDownForTemplate" >
<strong>EVENT:OnEngineShutDownForTemplate(EventTemplate, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Create an OnDead event handler for a group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#table EventTemplate </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEngineShutDownForUnit" >
<strong>EVENT:OnEngineShutDownForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>ENGINE_SHUTDOWN event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEngineShutDownRemove" >
<strong>EVENT:OnEngineShutDownRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>ENGINE_SHUTDOWN event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEngineStartUpForUnit" >
<strong>EVENT:OnEngineStartUpForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>ENGINE_STARTUP event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEngineStartUpRemove" >
<strong>EVENT:OnEngineStartUpRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>ENGINE_STARTUP event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEventForTemplate" >
<strong>EVENT:OnEventForTemplate(EventTemplate, EventFunction, EventClass, OnEventFunction)</strong>
</a>
</dt>
<dd>
<p>Create an OnDead event handler for a group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#table EventTemplate </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em> EventClass </em></code>:
The instance of the class for which the event is.</p>
</li>
<li>
<p><code><em>#function OnEventFunction </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEventForUnit" >
<strong>EVENT:OnEventForUnit(EventDCSUnitName, EventFunction, EventClass, EventID)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>X event</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for 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> EventID </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnEventGeneric" >
<strong>EVENT:OnEventGeneric(EventFunction, EventClass, EventID)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>X event independent from a unit or a weapon.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for 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 captured. When the event happens, the event process will be called in this class provided.</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">
<dt>
<a id="#(EVENT).OnHit" >
<strong>EVENT:OnHit(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>HIT event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnHitForUnit" >
<strong>EVENT:OnHitForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>HIT event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnHitRemove" >
<strong>EVENT:OnHitRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>HIT event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnLandForTemplate" >
<strong>EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> EventTemplate </em></code>: </p>
</li>
<li>
<p><code><em> EventFunction </em></code>: </p>
</li>
<li>
<p><code><em> EventClass </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnLandForUnit" >
<strong>EVENT:OnLandForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>LAND event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnLandRemove" >
<strong>EVENT:OnLandRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>LAND event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPilotDead" >
<strong>EVENT:OnPilotDead(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>PILOT_DEAD event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPilotDeadForUnit" >
<strong>EVENT:OnPilotDeadForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>PILOT_DEAD event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPilotDeadRemove" >
<strong>EVENT:OnPilotDeadRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>PILOT_DEAD event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPlayerEnterRemove" >
<strong>EVENT:OnPlayerEnterRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>PLAYER<em>ENTER</em>UNIT event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPlayerEnterUnit" >
<strong>EVENT:OnPlayerEnterUnit(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>PLAYER<em>ENTER</em>UNIT event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPlayerLeaveRemove" >
<strong>EVENT:OnPlayerLeaveRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>PLAYER<em>LEAVE</em>UNIT event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnPlayerLeaveUnit" >
<strong>EVENT:OnPlayerLeaveUnit(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> EventFunction </em></code>: </p>
</li>
<li>
<p><code><em> EventClass </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnShot" >
<strong>EVENT:OnShot(EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> EventFunction </em></code>: </p>
</li>
<li>
<p><code><em> EventClass </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnShotForUnit" >
<strong>EVENT:OnShotForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>SHOT event for a unit.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnShotRemove" >
<strong>EVENT:OnShotRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>SHOT event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnTakeOffForTemplate" >
<strong>EVENT:OnTakeOffForTemplate(EventTemplate, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> EventTemplate </em></code>: </p>
</li>
<li>
<p><code><em> EventFunction </em></code>: </p>
</li>
<li>
<p><code><em> EventClass </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnTakeOffForUnit" >
<strong>EVENT:OnTakeOffForUnit(EventDCSUnitName, EventFunction, EventClass)</strong>
</a>
</dt>
<dd>
<p>Set a new listener for an S<em>EVENT</em>TAKEOFF event.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string EventDCSUnitName </em></code>: </p>
</li>
<li>
<p><code><em>#function EventFunction </em></code>:
The function to be called when the event occurs for the unit.</p>
</li>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>:
The self instance of the class for which the event is.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).OnTakeOffRemove" >
<strong>EVENT:OnTakeOffRemove(EventClass)</strong>
</a>
</dt>
<dd>
<p>Stop listening to S<em>EVENT</em>TAKEOFF event.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Base.html##(BASE)">Base#BASE</a> EventClass </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(EVENT)">#EVENT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENT).Remove" >
<strong>EVENT:Remove(EventClass, EventID)</strong>
</a>
</dt>
<dd>
<p>Removes an Events entry</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>
</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).RemoveAll" >
<strong>EVENT:RemoveAll(EventObject)</strong>
</a>
</dt>
<dd>
<p>Clears all event subscriptions for a <a href="Base.html##(BASE)">Base#BASE</a> derived object.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Base.html##(BASE)">Core.Base#BASE</a> EventObject </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<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>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="##(EVENTDATA)">#EVENTDATA</a> Event </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<h2><a id="#(EVENT.Events)" >Type <code>EVENT.Events</code></a></h2>
<p>The Events structure</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(EVENT.Events).IniUnit" >
<strong>EVENT.Events.IniUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(EVENTDATA)" >Type <code>EVENTDATA</code></a></h2>
<p>The Event structure
Note that at the beginning of each field description, there is an indication which field will be populated depending on the object type involved in the Event:</p>
<ul>
<li>A (Object.Category.)UNIT : A UNIT object type is involved in the Event.</li>
</ul>
<ul>
<li>A (Object.Category.)STATIC : A STATIC object type is involved in the Event.<2E>
</li>
</ul>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em><a href="Dcs.DCSUnit.html##(Unit.Category)">Dcs.DCSUnit#Unit.Category</a></em>
<a id="#(EVENTDATA).IniCategory" >
<strong>EVENTDATA.IniCategory</strong>
</a>
</dt>
<dd>
<p>(UNIT) The category of the initiator.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCScoalition.html##(coalition.side)">Dcs.DCScoalition#coalition.side</a></em>
<a id="#(EVENTDATA).IniCoalition" >
<strong>EVENTDATA.IniCoalition</strong>
</a>
</dt>
<dd>
<p>(UNIT) The coalition of the initiator.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSGroup.html##(Group)">Dcs.DCSGroup#Group</a></em>
<a id="#(EVENTDATA).IniDCSGroup" >
<strong>EVENTDATA.IniDCSGroup</strong>
</a>
</dt>
<dd>
<p>(UNIT) The initiating {DCSGroup#Group}.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).IniDCSGroupName" >
<strong>EVENTDATA.IniDCSGroupName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The initiating Group name.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a></em>
<a id="#(EVENTDATA).IniDCSUnit" >
<strong>EVENTDATA.IniDCSUnit</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The initiating <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).IniDCSUnitName" >
<strong>EVENTDATA.IniDCSUnitName</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The initiating Unit name.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a></em>
<a id="#(EVENTDATA).IniGroup" >
<strong>EVENTDATA.IniGroup</strong>
</a>
</dt>
<dd>
<p>(UNIT) The initiating MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the initiator Group object.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).IniGroupName" >
<strong>EVENTDATA.IniGroupName</strong>
</a>
</dt>
<dd>
<p>UNIT) The initiating GROUP name (same as IniDCSGroupName).</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSObject.html##(Object.Category)">Dcs.DCSObject#Object.Category</a></em>
<a id="#(EVENTDATA).IniObjectCategory" >
<strong>EVENTDATA.IniObjectCategory</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC/SCENERY) The initiator object category ( Object.Category.UNIT or Object.Category.STATIC ).</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).IniPlayerName" >
<strong>EVENTDATA.IniPlayerName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The name of the initiating player in case the Unit is a client or player slot.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).IniTypeName" >
<strong>EVENTDATA.IniTypeName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The type name of the initiator.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></em>
<a id="#(EVENTDATA).IniUnit" >
<strong>EVENTDATA.IniUnit</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The initiating MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the initiator Unit object.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).IniUnitName" >
<strong>EVENTDATA.IniUnitName</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSUnit.html##(Unit.Category)">Dcs.DCSUnit#Unit.Category</a></em>
<a id="#(EVENTDATA).TgtCategory" >
<strong>EVENTDATA.TgtCategory</strong>
</a>
</dt>
<dd>
<p>(UNIT) The category of the target.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCScoalition.html##(coalition.side)">Dcs.DCScoalition#coalition.side</a></em>
<a id="#(EVENTDATA).TgtCoalition" >
<strong>EVENTDATA.TgtCoalition</strong>
</a>
</dt>
<dd>
<p>(UNIT) The coalition of the target.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSGroup.html##(Group)">Dcs.DCSGroup#Group</a></em>
<a id="#(EVENTDATA).TgtDCSGroup" >
<strong>EVENTDATA.TgtDCSGroup</strong>
</a>
</dt>
<dd>
<p>(UNIT) The target {DCSGroup#Group}.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).TgtDCSGroupName" >
<strong>EVENTDATA.TgtDCSGroupName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The target Group name.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a></em>
<a id="#(EVENTDATA).TgtDCSUnit" >
<strong>EVENTDATA.TgtDCSUnit</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The target <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).TgtDCSUnitName" >
<strong>EVENTDATA.TgtDCSUnitName</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The target Unit name.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a></em>
<a id="#(EVENTDATA).TgtGroup" >
<strong>EVENTDATA.TgtGroup</strong>
</a>
</dt>
<dd>
<p>(UNIT) The target MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the target Group object.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).TgtGroupName" >
<strong>EVENTDATA.TgtGroupName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The target GROUP name (same as TgtDCSGroupName).</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSObject.html##(Object.Category)">Dcs.DCSObject#Object.Category</a></em>
<a id="#(EVENTDATA).TgtObjectCategory" >
<strong>EVENTDATA.TgtObjectCategory</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).TgtPlayerName" >
<strong>EVENTDATA.TgtPlayerName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The name of the target player in case the Unit is a client or player slot.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).TgtTypeName" >
<strong>EVENTDATA.TgtTypeName</strong>
</a>
</dt>
<dd>
<p>(UNIT) The type name of the target.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></em>
<a id="#(EVENTDATA).TgtUnit" >
<strong>EVENTDATA.TgtUnit</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The target MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the target Unit object.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTDATA).TgtUnitName" >
<strong>EVENTDATA.TgtUnitName</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENTDATA).Weapon" >
<strong>EVENTDATA.Weapon</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENTDATA).WeaponName" >
<strong>EVENTDATA.WeaponName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENTDATA).WeaponTgtDCSUnit" >
<strong>EVENTDATA.WeaponTgtDCSUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(EVENTDATA).id" >
<strong>EVENTDATA.id</strong>
</a>
</dt>
<dd>
<p>The identifier of the event.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a></em>
<a id="#(EVENTDATA).initiator" >
<strong>EVENTDATA.initiator</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC/SCENERY) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a></em>
<a id="#(EVENTDATA).target" >
<strong>EVENTDATA.target</strong>
</a>
</dt>
<dd>
<p>(UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENTDATA).weapon" >
<strong>EVENTDATA.weapon</strong>
</a>
</dt>
<dd>
<p>The weapon used during the event.</p>
</dd>
</dl>
<h2><a id="#(EVENTHANDLER)" >Type <code>EVENTHANDLER</code></a></h2>
<p>The EVENTHANDLER structure</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(EVENTHANDLER).ClassID" >
<strong>EVENTHANDLER.ClassID</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(EVENTHANDLER).ClassName" >
<strong>EVENTHANDLER.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(EVENTHANDLER).New" >
<strong>EVENTHANDLER:New()</strong>
</a>
</dt>
<dd>
<p>The EVENTHANDLER constructor</p>
<h3>Return value</h3>
<p><em><a href="##(EVENTHANDLER)">#EVENTHANDLER</a>:</em></p>
</dd>
</dl>
<h2><a id="#(EVENTS)" >Type <code>EVENTS</code></a></h2>
<p>The different types of events supported by MOOSE.</p>
<p>Use this structure to subscribe to events using the <a href="Base.html##(BASE).HandleEvent">Base#BASE.HandleEvent</a>() method.</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).BaseCaptured" >
<strong>EVENTS.BaseCaptured</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Birth" >
<strong>EVENTS.Birth</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Crash" >
<strong>EVENTS.Crash</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Dead" >
<strong>EVENTS.Dead</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Ejection" >
<strong>EVENTS.Ejection</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).EngineShutdown" >
<strong>EVENTS.EngineShutdown</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).EngineStartup" >
<strong>EVENTS.EngineStartup</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Hit" >
<strong>EVENTS.Hit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).HumanFailure" >
<strong>EVENTS.HumanFailure</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Land" >
<strong>EVENTS.Land</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).MissionEnd" >
<strong>EVENTS.MissionEnd</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).MissionStart" >
<strong>EVENTS.MissionStart</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).PilotDead" >
<strong>EVENTS.PilotDead</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).PlayerComment" >
<strong>EVENTS.PlayerComment</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).PlayerEnterUnit" >
<strong>EVENTS.PlayerEnterUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).PlayerLeaveUnit" >
<strong>EVENTS.PlayerLeaveUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Refueling" >
<strong>EVENTS.Refueling</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).RefuelingStop" >
<strong>EVENTS.RefuelingStop</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).ShootingEnd" >
<strong>EVENTS.ShootingEnd</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).ShootingStart" >
<strong>EVENTS.ShootingStart</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Shot" >
<strong>EVENTS.Shot</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).Takeoff" >
<strong>EVENTS.Takeoff</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(EVENTS).TookControl" >
<strong>EVENTS.TookControl</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>