weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2022-09-10 10:03:11 +00:00
parent d50178d2f1
commit ce5f4834e1
137 changed files with 72992 additions and 13371 deletions
Download Patch File Download Diff File Expand all files Collapse all files

316
Documentation/Functional.MissileTrainer.html
View File

@@ -483,6 +483,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> - Management of single cargo logistics, which are based on a <a href="Wrapper.Unit.html">Wrapper.Unit</a> object.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/CORE_Astar.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Astar.html">Core.Astar</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - A* Pathfinding.</p>
</p></div>
</div>
</div>
@@ -505,6 +516,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - TACAN and other beacons.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Core_Conditon.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Condition.html">Core.Condition</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Define any or all conditions to be evaluated.</p>
</p></div>
</div>
</div>
@@ -681,6 +703,33 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Management of spotting logistics, that can be activated and deactivated upon command.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.TextAndSound.html">Core.TextAndSound</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - TEXTANDSOUND (MOOSE gettext) system</p>
<hr/>
<h2>Main Features:</h2>
<ul>
<li>A GetText for Moose</li>
<li>Build a set of localized text entries, alongside their sounds and subtitles</li>
<li>Aimed at class developers to offer localizable language support</li>
</ul>
<hr/>
<h2>Example Missions:</h2>
<p>Demo missions can be found on <a href="https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/">github</a>.</p>
</p></div>
</div>
</div>
@@ -1316,11 +1365,22 @@ Controls a network of short range air/missile defense groups.</p>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE.JPG" alt="Image">
<img src= "../Images/Utils_Profiler.jpg" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.PROFILER.html">Utilities.PROFILER</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utils</strong> - Lua Profiler.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Utilities_Socket.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Socket.html">Utilities.Socket</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utilities</strong> - Socket.</p>
</p></div>
</div>
</div>
@@ -1429,7 +1489,7 @@ Controls a network of short range air/missile defense groups.</p>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Wrapper_Marker.png" alt="Image">
<img src= "../Images/MOOSE_Core.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Marker.html">Wrapper.Marker</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
@@ -1523,7 +1583,7 @@ Controls a network of short range air/missile defense groups.</p>
<ul>
<li>Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.</li>
<li>Provide alerts of missile launches, including detailed information of the units launching, including bearing, range °</li>
<li>Provide alerts of missile launches, including detailed information of the units launching, including bearing, range</li>
<li>Provide alerts when a missile would have killed your aircraft.</li>
<li>Provide alerts when the missile self destructs.</li>
<li>Enable / Disable and Configure the Missile Trainer using the various menu options.</li>
@@ -1573,7 +1633,7 @@ the class will destroy the missile within a certain range, to avoid damage to yo
<li><strong>Bearing On</strong>: Shows bearing information when a missile is fired to a target.</li>
<li><strong>Bearing Off</strong>: Disable bearing information when a missile is fired to a target.</li>
</ul></li>
<li><strong>Distance</strong>: Menu to configure the distance when a missile needs to be destroyed when near to a player, during tracking. This will improve/influence hit calculation accuracy, but has the risk of damaging the aircraft when the missile reaches the aircraft before the distance is measured.
<li><strong>Distance</strong>: Menu to configure the distance when a missile needs to be destroyed when near to a player, during tracking. This will improve/influence hit calculation accuracy, but has the risk of damaging the aircraft when the missile reaches the aircraft before the distance is measured.
<ul>
<li><strong>50 meter</strong>: Destroys the missile when the distance to the aircraft is below or equal to 50 meter.</li>
<li><strong>100 meter</strong>: Destroys the missile when the distance to the aircraft is below or equal to 100 meter.</li>
@@ -1589,8 +1649,8 @@ the class will destroy the missile within a certain range, to avoid damage to yo
<h3>Contributions:</h3>
<ul>
<li><strong>Stuka (Danny)</strong>: Who you can search on the Eagle Dynamics Forums. Working together with Danny has resulted in the MISSILETRAINER class. <br/>
Danny has shared his ideas and together we made a design.
<li><strong>Stuka (Danny)</strong>: Who you can search on the Eagle Dynamics Forums. Working together with Danny has resulted in the MISSILETRAINER class.
Danny has shared his ideas and together we made a design.
Together with the <strong>476 virtual team</strong>, we tested the MISSILETRAINER class, and got much positive feedback!</li>
<li><strong>132nd Squadron</strong>: Testing and optimizing the logic.</li>
</ul>
@@ -1882,7 +1942,7 @@ the class will destroy the missile within a certain range, to avoid damage to yo
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).CreateEventDead">MISSILETRAINER:CreateEventDead(EventTime, Initiator)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).CreateEventDead">MISSILETRAINER:CreateEventDead(EventTime, Initiator, IniObjectCategory)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Dead Event.</p>
</td>
@@ -1903,6 +1963,12 @@ the class will destroy the missile within a certain range, to avoid damage to yo
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).CreateEventTakeoff">MISSILETRAINER:CreateEventTakeoff(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Takeoff Event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).CreateEventUnitLost">MISSILETRAINER:CreateEventUnitLost(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Crash Event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2016,7 +2082,7 @@ the class will destroy the missile within a certain range, to avoid damage to yo
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).OnEvent">MISSILETRAINER:OnEvent(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when an object is completely destroyed.</p>
<p>Occurs when an Event for an object is triggered.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2065,7 +2131,7 @@ the class will destroy the missile within a certain range, to avoid damage to yo
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).OnEventEjection">MISSILETRAINER:OnEventEjection(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a pilot ejects from an aircraft
initiator : The unit that has ejected</p>
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2102,7 +2168,7 @@ initiator : The unit that has ejected</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).OnEventLand">MISSILETRAINER:OnEventLand(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed.</p>
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2138,13 +2204,15 @@ initiator : The unit that has landed.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).OnEventMissionEnd">MISSILETRAINER:OnEventMissionEnd(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission ends.</p>
<p>Occurs when a mission ends
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).OnEventMissionStart">MISSILETRAINER:OnEventMissionStart(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission starts.</p>
<p>Occurs when a mission starts
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes. </p>
</td>
</tr>
<tr class="w3-border">
@@ -2244,7 +2312,7 @@ initiator : The unit that has landed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).ScheduleStop">MISSILETRAINER:ScheduleStop(SchedulerFunction)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).ScheduleStop">MISSILETRAINER:ScheduleStop(SchedulerID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the Schedule.</p>
</td>
@@ -2362,7 +2430,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MISSILETRAINER).onEvent">MISSILETRAINER:onEvent(event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The main event handling function...</p>
</td>
</tr>
</table>
@@ -2828,7 +2896,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Provide a negative or positive value in seconds to incraese or decrease the display frequency. </p>
<p>Provide a negative or positive value in seconds to incraese or decrease the display frequency.</p>
</div>
</div>
@@ -2976,7 +3044,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>(Optional) Will show a text to the players when starting their mission. Can be used for briefing purposes. </p>
<p>(Optional) Will show a text to the players when starting their mission. Can be used for briefing purposes.</p>
</div>
</div>
@@ -3507,7 +3575,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MISSILETRAINER).CreateEventDead" ><strong>MISSILETRAINER:CreateEventDead(EventTime, Initiator)</strong></a></h2>
<h2><a id="#(MISSILETRAINER).CreateEventDead" ><strong>MISSILETRAINER:CreateEventDead(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
</div>
<p>Creation of a Dead Event.</p>
@@ -3545,6 +3613,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>IniObjectCategory</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -3672,6 +3750,52 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MISSILETRAINER).CreateEventUnitLost" ><strong>MISSILETRAINER:CreateEventUnitLost(EventTime, Initiator)</strong></a></h2>
</div>
<p>Creation of a Crash Event.</p>
<div id= "#Functions##CreateEventUnitLost" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Time)">DCS#Time</a>
<strong><strong>EventTime</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The time stamp of the event.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Object)">DCS#Object</a>
<strong><strong>Initiator</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The initiating object of the event.</p>
</div>
</div>
</div>
</div>
</div>
@@ -4405,10 +4529,11 @@ end
<h2><a id="#(MISSILETRAINER).OnEvent" ><strong>MISSILETRAINER:OnEvent(EventData)</strong></a></h2>
</div>
<p>Occurs when an object is completely destroyed.</p>
<p>Occurs when an Event for an object is triggered.</p>
<p>initiator : The unit that is was destroyed.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that triggered the event. </p>
<div id= "#Functions##OnEvent" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4443,6 +4568,9 @@ end
<p>BDA.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventBDA" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -4477,8 +4605,9 @@ end
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
<p>initiator : The unit that captured the base.
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that captured the base
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. </p>
<div id= "#Functions##OnEventBaseCaptured" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4514,7 +4643,8 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Occurs when any object is spawned into the mission.</p>
<p>initiator : The unit that was spawned.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that was spawned </p>
<div id= "#Functions##OnEventBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4550,7 +4680,8 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
<p>initiator : The unit that has crashed.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that has crashed </p>
<div id= "#Functions##OnEventCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4586,7 +4717,8 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Occurs when an object is dead.</p>
<p>initiator : The unit that is dead.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that is dead. </p>
<div id= "#Functions##OnEventDead" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4662,6 +4794,9 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
<p>Discard chair after ejection.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventDiscardChairAfterEjection" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -4694,7 +4829,10 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
</div>
<p>Occurs when a pilot ejects from an aircraft
initiator : The unit that has ejected</p>
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<p>initiator : The unit that has ejected </p>
<div id= "#Functions##OnEventEjection" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4730,7 +4868,8 @@ initiator : The unit that has ejected</p>
<p>Occurs when any aircraft shuts down its engines.</p>
<p>initiator : The unit that is stopping its engines..</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that is stopping its engines. </p>
<div id= "#Functions##OnEventEngineShutdown" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4766,7 +4905,8 @@ initiator : The unit that has ejected</p>
<p>Occurs when any aircraft starts its engines.</p>
<p>initiator : The unit that is starting its engines..</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that is starting its engines. </p>
<div id= "#Functions##OnEventEngineStartup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4802,9 +4942,10 @@ initiator : The unit that has ejected</p>
<p>Occurs whenever an object is hit by a weapon.</p>
<p>initiator : The unit object the fired the weapon.
weapon: Weapon object that hit the target.
target: The Object that was hit.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit object the fired the weapon
weapon: Weapon object that hit the target
target: The Object that was hit. </p>
<div id= "#Functions##OnEventHit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4840,7 +4981,8 @@ target: The Object that was hit.</p>
<p>Occurs when any system fails on a human controlled aircraft.</p>
<p>initiator : The unit that had the failure.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that had the failure </p>
<div id= "#Functions##OnEventHumanFailure" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4876,10 +5018,11 @@ target: The Object that was hit.</p>
<p>Occurs on the death of a unit.</p>
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.</p>
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<ul>
<li>initiator: The unit that killed the target.</li>
<li>initiator: The unit that killed the target</li>
<li>target: Target Object</li>
<li>weapon: Weapon Object</li>
</ul>
@@ -4917,10 +5060,11 @@ target: The Object that was hit.</p>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed.</p>
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<p>place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships.</p>
<p>initiator : The unit that has landed
place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventLand" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4956,7 +5100,8 @@ initiator : The unit that has landed.</p>
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
<p>Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.</p>
<p>Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<ul>
<li>initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.</li>
@@ -4998,6 +5143,9 @@ initiator : The unit that has landed.</p>
<p>Landing quality mark.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventLandingQualityMark" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -5032,7 +5180,8 @@ initiator : The unit that has landed.</p>
<p>Occurs when a new mark was added.</p>
<p>MarkID: ID of the mark.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
MarkID: ID of the mark. </p>
<div id= "#Functions##OnEventMarkAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5068,7 +5217,8 @@ initiator : The unit that has landed.</p>
<p>Occurs when a mark text was changed.</p>
<p>MarkID: ID of the mark.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
MarkID: ID of the mark. </p>
<div id= "#Functions##OnEventMarkChange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5104,7 +5254,8 @@ initiator : The unit that has landed.</p>
<p>Occurs when a mark was removed.</p>
<p>MarkID: ID of the mark.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
MarkID: ID of the mark. </p>
<div id= "#Functions##OnEventMarkRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5137,7 +5288,8 @@ initiator : The unit that has landed.</p>
<h2><a id="#(MISSILETRAINER).OnEventMissionEnd" ><strong>MISSILETRAINER:OnEventMissionEnd(EventData)</strong></a></h2>
</div>
<p>Occurs when a mission ends.</p>
<p>Occurs when a mission ends
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventMissionEnd" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5170,7 +5322,8 @@ initiator : The unit that has landed.</p>
<h2><a id="#(MISSILETRAINER).OnEventMissionStart" ><strong>MISSILETRAINER:OnEventMissionStart(EventData)</strong></a></h2>
</div>
<p>Occurs when a mission starts.</p>
<p>Occurs when a mission starts
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes. </p>
<div id= "#Functions##OnEventMissionStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5206,7 +5359,8 @@ initiator : The unit that has landed.</p>
<p>Weapon add.</p>
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.</p>
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventParatrooperLanding" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5243,7 +5397,8 @@ initiator : The unit that has landed.</p>
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
initiator : The unit that the pilot has died in.</p>
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that the pilot has died in. </p>
<div id= "#Functions##OnEventPilotDead" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5279,8 +5434,9 @@ initiator : The unit that the pilot has died in.</p>
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
<p><strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
initiator : The unit that is being taken control of.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
<strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
initiator : The unit that is being taken control of. </p>
<div id= "#Functions##OnEventPlayerEnterAircraft" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5316,7 +5472,9 @@ initiator : The unit that is being taken control of.</p>
<p>Occurs when any player assumes direct control of a unit.</p>
<p>initiator : The unit that is being taken control of.</p>
<p>Note - not Mulitplayer safe. Use PlayerEnterAircraft.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that is being taken control of. </p>
<div id= "#Functions##OnEventPlayerEnterUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5352,7 +5510,8 @@ initiator : The unit that is being taken control of.</p>
<p>Occurs when any player relieves control of a unit to the AI.</p>
<p>initiator : The unit that the player left.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that the player left. </p>
<div id= "#Functions##OnEventPlayerLeaveUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5388,7 +5547,8 @@ initiator : The unit that is being taken control of.</p>
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
<p>initiator : The unit that is receiving fuel.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that is receiving fuel. </p>
<div id= "#Functions##OnEventRefueling" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5424,7 +5584,8 @@ initiator : The unit that is being taken control of.</p>
<p>Occurs when an aircraft is finished taking fuel.</p>
<p>initiator : The unit that was receiving fuel.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that was receiving fuel. </p>
<div id= "#Functions##OnEventRefuelingStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5460,7 +5621,8 @@ initiator : The unit that is being taken control of.</p>
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
<p>There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.</p>
<p>There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventScore" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5497,7 +5659,8 @@ initiator : The unit that is being taken control of.</p>
<p>Event will always correspond with a shooting start event.
initiator : The unit that was doing the shooting.</p>
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that was doing the shooting. </p>
<div id= "#Functions##OnEventShootingEnd" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5533,7 +5696,8 @@ initiator : The unit that was doing the shooting.</p>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), auto cannons, and machine guns.
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that is doing the shooting.
target: The unit that is being targeted.</p>
@@ -5571,7 +5735,8 @@ target: The unit that is being targeted.</p>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventShot" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5607,8 +5772,9 @@ target: The unit that is being targeted.</p>
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
<p>initiator : The unit that took off.
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
initiator : The unit that tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -5643,6 +5809,9 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<p>Trigger zone.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<div id= "#Functions##OnEventTriggerZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
@@ -5677,6 +5846,7 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<p>Occurs when the game thinks an object is destroyed.</p>
<p>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</p>
<ul>
<li>initiator: The unit that is was destroyed.</li>
@@ -5768,11 +5938,11 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
<p>#string:</p>
</div>
<div class="w3-half">
<p>The ScheduleID of the planned schedule.</p>
<p>The Schedule ID of the planned schedule.</p>
</div>
</div>
@@ -5880,11 +6050,11 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
<p>#string:</p>
</div>
<div class="w3-half">
<p>The ScheduleID of the planned schedule.</p>
<p>The Schedule ID of the planned schedule.</p>
</div>
</div>
@@ -5896,7 +6066,7 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MISSILETRAINER).ScheduleStop" ><strong>MISSILETRAINER:ScheduleStop(SchedulerFunction)</strong></a></h2>
<h2><a id="#(MISSILETRAINER).ScheduleStop" ><strong>MISSILETRAINER:ScheduleStop(SchedulerID)</strong></a></h2>
</div>
<p>Stops the Schedule.</p>
@@ -5911,13 +6081,13 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>SchedulerFunction</strong></strong>
#string
<strong><strong>SchedulerID</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
<p>(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.</p>
</div>
</div>
@@ -6204,7 +6374,9 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Class name.</p>
</div>
</div>
</div>
@@ -6235,7 +6407,9 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Class name.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -6246,7 +6420,9 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Method.</p>
</div>
</div>
</div>
@@ -6536,13 +6712,10 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(MISSILETRAINER).onEvent" ><strong>MISSILETRAINER:onEvent(event)</strong></a></h2>
</div>
<p>The main event handling function...</p>
<p> TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class.
@param #BASE self
@param DCS#Event event</p>
<p>This function captures all events generated for the class.</p>
<div id= "#Functions##onEvent" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6554,6 +6727,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(Event)">DCS#Event</a>
<strong><strong>event</strong></strong>
</p>
</div>