MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-21 04:18:38 +00:00
parent 8fe5c5ff1c
commit e2dde8a474
140 changed files with 7523 additions and 7539 deletions

View File

@@ -402,7 +402,7 @@
<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="Actions.Account.html">Actions.Account</a></strong></h2></div>
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Account.html">Actions.Act_Account</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count &amp; report) various DCS events occuring on <a href="Wrapper.Unit.html">Wrapper.Unit</a>s.</p>
@@ -413,7 +413,7 @@
<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="Actions.Assign.html">Actions.Assign</a></strong></h2></div>
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Assign.html">Actions.Act_Assign</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>(SP) (MP) (FSM) Accept or reject process for player (task) assignments.</p>
@@ -424,7 +424,7 @@
<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="Actions.Assist.html">Actions.Assist</a></strong></h2></div>
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Assist.html">Actions.Act_Assist</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>(SP) (MP) (FSM) Route AI or players through waypoints or to zones.</p>
@@ -435,7 +435,7 @@
<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="Actions.Route.html">Actions.Route</a></strong></h2></div>
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Route.html">Actions.Act_Route</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>(SP) (MP) (FSM) Route AI or players through waypoints or to zones.</p>
@@ -460,7 +460,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoCrate.html">Cargo.CargoCrate</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> - Management of single cargo crates, which are based on a <a href="Static.html">Static</a> object.</p>
<p><strong>Cargo</strong> - Management of single cargo crates, which are based on a <a href="Wrapper.Static.html">Wrapper.Static</a> object.</p>
</p></div>
</div>
</div>
@@ -482,7 +482,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoSlingload.html">Cargo.CargoSlingload</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> - Management of single cargo crates, which are based on a <a href="Static.html">Static</a> object.</p>
<p><strong>Cargo</strong> - Management of single cargo crates, which are based on a <a href="Wrapper.Static.html">Wrapper.Static</a> object.</p>
</p></div>
</div>
</div>
@@ -533,7 +533,7 @@
<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">
<img src= "../Images/MOOSE.JPG" 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>
@@ -791,7 +791,7 @@
<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/" alt="Image">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone_Detection.html">Core.Zone_Detection</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
@@ -871,7 +871,7 @@
<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/" alt="Image">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.DetectionZones.html">Functional.DetectionZones</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
@@ -1441,7 +1441,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/Utilities_Socket.png" alt="Image">
<img src= "../Images/MOOSE.JPG" 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>
@@ -1649,7 +1649,7 @@ Controls a network of short range air/missile defense groups.</p>
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SPAWNSTATIC</strong></h2></p></td>
<td class="style="width:60%;">
<p>Allows to spawn dynamically new <a href="Static.html">Static</a>s into your mission.</p>
<p>Allows to spawn dynamically new <a href="Wrapper.Static.html">Wrapper.Static</a>s into your mission.</p>
</td>
</tr>
</table>
@@ -1660,18 +1660,18 @@ Controls a network of short range air/missile defense groups.</p>
<a href="##(SPAWNSTATIC)">#SPAWNSTATIC</a>
<a id="SPAWNSTATIC" ><strong>SPAWNSTATIC</strong></a>
<p>Allows to spawn dynamically new <a href="Static.html">Static</a>s into your mission.</p>
<p>Allows to spawn dynamically new <a href="Wrapper.Static.html">Wrapper.Static</a>s into your mission.</p>
<p>Through creating a copy of an existing static object template as defined in the Mission Editor (ME), SPAWNSTATIC can retireve the properties of the defined static object template (like type, category etc),
and "copy" these properties to create a new static object and place it at the desired coordinate.</p>
<p>New spawned <a href="Static.html">Static</a>s get <strong>the same name</strong> as the name of the template Static, or gets the given name when a new name is provided at the Spawn method. <br/>
By default, spawned <a href="Static.html">Static</a>s will follow a naming convention at run-time:</p>
<p>New spawned <a href="Wrapper.Static.html">Wrapper.Static</a>s get <strong>the same name</strong> as the name of the template Static, or gets the given name when a new name is provided at the Spawn method. <br/>
By default, spawned <a href="Wrapper.Static.html">Wrapper.Static</a>s will follow a naming convention at run-time:</p>
<ul>
<li>Spawned <a href="Static.html">Static</a>s will have the name <em>StaticName</em>#<em>nnn</em>, where <em>StaticName</em> is the name of the <strong>Template Static</strong>, and <em>nnn</em> is a <strong>counter from 0 to 99999</strong>.</li>
<li>Spawned <a href="Wrapper.Static.html">Wrapper.Static</a>s will have the name <em>StaticName</em>#<em>nnn</em>, where <em>StaticName</em> is the name of the <strong>Template Static</strong>, and <em>nnn</em> is a <strong>counter from 0 to 99999</strong>.</li>
</ul>
<h1>SPAWNSTATIC Constructors</h1>
@@ -1936,19 +1936,19 @@ such as position and heading.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).NewFromStatic">SPAWNSTATIC:NewFromStatic(SpawnTemplateName, SpawnCountryID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates the main object to spawn a <a href="Static.html">Static</a> defined in the mission editor (ME).</p>
<p>Creates the main object to spawn a <a href="Wrapper.Static.html">Wrapper.Static</a> defined in the mission editor (ME).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).NewFromTemplate">SPAWNSTATIC:NewFromTemplate(SpawnTemplate, CountryID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates the main object to spawn a <a href="Static.html">Static</a> given a template table.</p>
<p>Creates the main object to spawn a <a href="Wrapper.Static.html">Wrapper.Static</a> given a template table.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).NewFromType">SPAWNSTATIC:NewFromType(StaticType, StaticCategory, CountryID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates the main object to spawn a <a href="Static.html">Static</a> from a given type.</p>
<p>Creates the main object to spawn a <a href="Wrapper.Static.html">Wrapper.Static</a> from a given type.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1960,19 +1960,19 @@ such as position and heading.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).SpawnFromCoordinate">SPAWNSTATIC:SpawnFromCoordinate(Coordinate, Heading, NewName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new <a href="Static.html">Static</a> from a COORDINATE.</p>
<p>Creates a new <a href="Wrapper.Static.html">Wrapper.Static</a> from a COORDINATE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).SpawnFromPointVec2">SPAWNSTATIC:SpawnFromPointVec2(PointVec2, Heading, NewName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new <a href="Static.html">Static</a> from a POINT_VEC2.</p>
<p>Creates a new <a href="Wrapper.Static.html">Wrapper.Static</a> from a POINT_VEC2.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).SpawnFromZone">SPAWNSTATIC:SpawnFromZone(Zone, Heading, NewName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new <a href="Static.html">Static</a> from a <a href="Zone.html">Zone</a>.</p>
<p>Creates a new <a href="Wrapper.Static.html">Wrapper.Static</a> from a <a href="Zone.html">Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1997,24 +1997,6 @@ such as position and heading.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC)._SpawnStatic">SPAWNSTATIC:_SpawnStatic(Template, CountryID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Spawns a new static using a given template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).heliport_callsign_id">SPAWNSTATIC.heliport_callsign_id</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).heliport_frequency">SPAWNSTATIC.heliport_frequency</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).heliport_modulation">SPAWNSTATIC.heliport_modulation</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -2251,7 +2233,7 @@ such as position and heading.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).OnEventEjection">SPAWNSTATIC: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
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</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">
@@ -2288,7 +2270,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).OnEventLand">SPAWNSTATIC: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
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</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">
@@ -2325,14 +2307,14 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWNSTATIC).OnEventMissionEnd">SPAWNSTATIC:OnEventMissionEnd(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<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>
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="##(SPAWNSTATIC).OnEventMissionStart">SPAWNSTATIC:OnEventMissionStart(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<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>
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">
@@ -2929,39 +2911,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).heliport_callsign_id" ><strong>SPAWNSTATIC.heliport_callsign_id</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).heliport_frequency" ><strong>SPAWNSTATIC.heliport_frequency</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).heliport_modulation" ><strong>SPAWNSTATIC.heliport_modulation</strong></a>
</div>
</div>
@@ -3586,7 +3535,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(SPAWNSTATIC).NewFromStatic" ><strong>SPAWNSTATIC:NewFromStatic(SpawnTemplateName, SpawnCountryID)</strong></a></h2>
</div>
<p>Creates the main object to spawn a <a href="Static.html">Static</a> defined in the mission editor (ME).</p>
<p>Creates the main object to spawn a <a href="Wrapper.Static.html">Wrapper.Static</a> defined in the mission editor (ME).</p>
<div id= "#Functions##NewFromStatic" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3643,7 +3592,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(SPAWNSTATIC).NewFromTemplate" ><strong>SPAWNSTATIC:NewFromTemplate(SpawnTemplate, CountryID)</strong></a></h2>
</div>
<p>Creates the main object to spawn a <a href="Static.html">Static</a> given a template table.</p>
<p>Creates the main object to spawn a <a href="Wrapper.Static.html">Wrapper.Static</a> given a template table.</p>
<div id= "#Functions##NewFromTemplate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3700,7 +3649,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(SPAWNSTATIC).NewFromType" ><strong>SPAWNSTATIC:NewFromType(StaticType, StaticCategory, CountryID)</strong></a></h2>
</div>
<p>Creates the main object to spawn a <a href="Static.html">Static</a> from a given type.</p>
<p>Creates the main object to spawn a <a href="Wrapper.Static.html">Wrapper.Static</a> from a given type.</p>
<p>NOTE that you have to init many other parameters as spawn coordinate etc.</p>
@@ -3830,7 +3779,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(SPAWNSTATIC).SpawnFromCoordinate" ><strong>SPAWNSTATIC:SpawnFromCoordinate(Coordinate, Heading, NewName)</strong></a></h2>
</div>
<p>Creates a new <a href="Static.html">Static</a> from a COORDINATE.</p>
<p>Creates a new <a href="Wrapper.Static.html">Wrapper.Static</a> from a COORDINATE.</p>
<div id= "#Functions##SpawnFromCoordinate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3900,7 +3849,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(SPAWNSTATIC).SpawnFromPointVec2" ><strong>SPAWNSTATIC:SpawnFromPointVec2(PointVec2, Heading, NewName)</strong></a></h2>
</div>
<p>Creates a new <a href="Static.html">Static</a> from a POINT_VEC2.</p>
<p>Creates a new <a href="Wrapper.Static.html">Wrapper.Static</a> from a POINT_VEC2.</p>
<div id= "#Functions##SpawnFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3970,7 +3919,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(SPAWNSTATIC).SpawnFromZone" ><strong>SPAWNSTATIC:SpawnFromZone(Zone, Heading, NewName)</strong></a></h2>
</div>
<p>Creates a new <a href="Static.html">Static</a> from a <a href="Zone.html">Zone</a>.</p>
<p>Creates a new <a href="Wrapper.Static.html">Wrapper.Static</a> from a <a href="Zone.html">Zone</a>.</p>
<div id= "#Functions##SpawnFromZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4325,39 +4274,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).heliport_callsign_id" ><strong>SPAWNSTATIC.heliport_callsign_id</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).heliport_frequency" ><strong>SPAWNSTATIC.heliport_frequency</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).heliport_modulation" ><strong>SPAWNSTATIC.heliport_modulation</strong></a>
</div>
</div>
@@ -5503,7 +5419,7 @@ end
<p>Occurs when an Event for an object is triggered.</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>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">
@@ -5540,7 +5456,7 @@ initiator : The unit that triggered the event. </p>
<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>
<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">
@@ -5576,7 +5492,7 @@ initiator : The unit that triggered the event. </p>
<p>Occurs when a ground unit captures either an airbase or a farp.</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>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>
@@ -5614,7 +5530,7 @@ 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>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
<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">
@@ -5651,7 +5567,7 @@ initiator : The unit that was spawned </p>
<p>Occurs when any aircraft crashes into the ground and is completely 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>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">
@@ -5688,7 +5604,7 @@ initiator : The unit that has crashed </p>
<p>Occurs when an object 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.
<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">
@@ -5766,7 +5682,7 @@ initiator : The unit that is dead. </p>
<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>
<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">
@@ -5800,7 +5716,7 @@ initiator : The unit that is dead. </p>
</div>
<p>Occurs when a pilot ejects from an aircraft
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</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>
@@ -5839,7 +5755,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<p>Occurs when any aircraft shuts down 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.
<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">
@@ -5876,7 +5792,7 @@ initiator : The unit that is stopping its engines. </p>
<p>Occurs when any aircraft starts 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.
<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">
@@ -5913,7 +5829,7 @@ initiator : The unit that is starting its engines. </p>
<p>Occurs whenever an object is hit by a weapon.</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>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>
@@ -5952,7 +5868,7 @@ target: The Object that was hit. </p>
<p>Occurs when any system fails on a human controlled aircraft.</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>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">
@@ -5990,7 +5906,7 @@ initiator : The unit that had the failure </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>
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>
@@ -6031,7 +5947,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.</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 landed
@@ -6072,7 +5988,7 @@ place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
<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>
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>
@@ -6115,7 +6031,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<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>
<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">
@@ -6151,7 +6067,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<p>Occurs when a new mark was added.</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>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">
@@ -6188,7 +6104,7 @@ MarkID: ID of the mark. </p>
<p>Occurs when a mark text was changed.</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>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">
@@ -6225,7 +6141,7 @@ MarkID: ID of the mark. </p>
<p>Occurs when a mark was removed.</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>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">
@@ -6260,7 +6176,7 @@ MarkID: ID of the mark. </p>
</div>
<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>
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">
@@ -6294,7 +6210,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
</div>
<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>
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">
@@ -6331,7 +6247,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<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>
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">
@@ -6368,7 +6284,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
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">
@@ -6405,7 +6321,7 @@ 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>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
<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>
@@ -6444,7 +6360,7 @@ 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.
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">
@@ -6481,7 +6397,7 @@ 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>Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
<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">
@@ -6518,7 +6434,7 @@ initiator : The unit that the player left. </p>
<p>Occurs when an aircraft connects with a tanker and begins taking on 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.
<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">
@@ -6555,7 +6471,7 @@ initiator : The unit that is receiving fuel. </p>
<p>Occurs when an aircraft is finished taking 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.
<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">
@@ -6593,7 +6509,7 @@ initiator : The unit that was receiving fuel. </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>
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">
@@ -6630,7 +6546,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<p>Event will always correspond with a shooting start event.
Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a> as these are just the prototypes.
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">
@@ -6668,7 +6584,7 @@ initiator : The unit that was doing the shooting. </p>
<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.
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>
@@ -6707,7 +6623,7 @@ target: The unit that is being targeted.</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>
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">
@@ -6743,7 +6659,7 @@ Have a look at the class <a href="Core.EVENT.html##(EVENT)">Core.EVENT#EVENT</a>
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</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>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>
@@ -6781,7 +6697,7 @@ 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>
<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">
@@ -6817,7 +6733,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>
<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>