mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -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>
|
||||
@@ -1678,7 +1738,7 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).CreateEventDead">REPORT:CreateEventDead(EventTime, Initiator)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).CreateEventDead">REPORT: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>
|
||||
@@ -1699,6 +1759,12 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).CreateEventTakeoff">REPORT: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="##(REPORT).CreateEventUnitLost">REPORT: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">
|
||||
@@ -1812,7 +1878,7 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).OnEvent">REPORT: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">
|
||||
@@ -1861,7 +1927,7 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).OnEventEjection">REPORT: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">
|
||||
@@ -1898,7 +1964,7 @@ initiator : The unit that has ejected</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).OnEventLand">REPORT: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">
|
||||
@@ -1934,13 +2000,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="##(REPORT).OnEventMissionEnd">REPORT: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="##(REPORT).OnEventMissionStart">REPORT: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">
|
||||
@@ -2040,7 +2108,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="##(REPORT).ScheduleStop">REPORT:ScheduleStop(SchedulerFunction)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(REPORT).ScheduleStop">REPORT:ScheduleStop(SchedulerID)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Stops the Schedule.</p>
|
||||
</td>
|
||||
@@ -2158,7 +2226,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="##(REPORT).onEvent">REPORT: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>
|
||||
@@ -2767,7 +2835,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="#(REPORT).CreateEventDead" ><strong>REPORT:CreateEventDead(EventTime, Initiator)</strong></a></h2>
|
||||
<h2><a id="#(REPORT).CreateEventDead" ><strong>REPORT:CreateEventDead(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Creation of a Dead Event.</p>
|
||||
@@ -2805,6 +2873,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>
|
||||
@@ -2932,6 +3010,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="#(REPORT).CreateEventUnitLost" ><strong>REPORT: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>
|
||||
|
||||
@@ -3665,10 +3789,11 @@ end
|
||||
<h2><a id="#(REPORT).OnEvent" ><strong>REPORT: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">
|
||||
@@ -3703,6 +3828,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>
|
||||
@@ -3737,8 +3865,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">
|
||||
@@ -3774,7 +3903,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">
|
||||
@@ -3810,7 +3940,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">
|
||||
@@ -3846,7 +3977,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">
|
||||
@@ -3922,6 +4054,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>
|
||||
@@ -3954,7 +4089,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">
|
||||
@@ -3990,7 +4128,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">
|
||||
@@ -4026,7 +4165,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">
|
||||
@@ -4062,9 +4202,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">
|
||||
@@ -4100,7 +4241,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">
|
||||
@@ -4136,10 +4278,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>
|
||||
@@ -4177,10 +4320,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">
|
||||
@@ -4216,7 +4360,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>
|
||||
@@ -4258,6 +4403,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>
|
||||
@@ -4292,7 +4440,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">
|
||||
@@ -4328,7 +4477,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">
|
||||
@@ -4364,7 +4514,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">
|
||||
@@ -4397,7 +4548,8 @@ initiator : The unit that has landed.</p>
|
||||
<h2><a id="#(REPORT).OnEventMissionEnd" ><strong>REPORT: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">
|
||||
@@ -4430,7 +4582,8 @@ initiator : The unit that has landed.</p>
|
||||
<h2><a id="#(REPORT).OnEventMissionStart" ><strong>REPORT: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">
|
||||
@@ -4466,7 +4619,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">
|
||||
@@ -4503,7 +4657,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">
|
||||
@@ -4539,8 +4694,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">
|
||||
@@ -4576,7 +4732,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">
|
||||
@@ -4612,7 +4770,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">
|
||||
@@ -4648,7 +4807,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">
|
||||
@@ -4684,7 +4844,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">
|
||||
@@ -4720,7 +4881,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">
|
||||
@@ -4757,7 +4919,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">
|
||||
@@ -4793,7 +4956,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>
|
||||
|
||||
@@ -4831,7 +4995,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">
|
||||
@@ -4867,8 +5032,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">
|
||||
@@ -4903,6 +5069,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>
|
||||
@@ -4937,6 +5106,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>
|
||||
@@ -5028,11 +5198,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>
|
||||
@@ -5140,11 +5310,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>
|
||||
@@ -5156,7 +5326,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="#(REPORT).ScheduleStop" ><strong>REPORT:ScheduleStop(SchedulerFunction)</strong></a></h2>
|
||||
<h2><a id="#(REPORT).ScheduleStop" ><strong>REPORT:ScheduleStop(SchedulerID)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Stops the Schedule.</p>
|
||||
@@ -5171,13 +5341,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>
|
||||
@@ -5464,7 +5634,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>
|
||||
@@ -5495,7 +5667,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">
|
||||
@@ -5506,7 +5680,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>
|
||||
@@ -5796,13 +5972,10 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
<h2><a id="#(REPORT).onEvent" ><strong>REPORT: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">
|
||||
@@ -5814,6 +5987,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>
|
||||
|
||||
Reference in New Issue
Block a user