MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-01-02 23:13:23 +00:00
parent 57b032b0e7
commit 3fbca8e731
97 changed files with 10993 additions and 518 deletions

View File

@@ -3024,6 +3024,12 @@ The different values of Unit.Category can be:</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).CreateEventDead">DETECTION_AREAS:CreateEventDead(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Dead Event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).CreateEventPlayerEnterAircraft">DETECTION_AREAS:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3267,6 +3273,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).OnEventPilotDead">DETECTION_AREAS:OnEventPilotDead(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when the pilot of an aircraft is killed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_AREAS).OnEventPlayerEnterAircraft">DETECTION_AREAS:OnEventPlayerEnterAircraft(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4559,6 +4571,12 @@ The different values of Unit.Category can be:</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_BASE).CreateEventDead">DETECTION_BASE:CreateEventDead(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Dead Event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_BASE).CreateEventPlayerEnterAircraft">DETECTION_BASE:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4802,6 +4820,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_BASE).OnEventPilotDead">DETECTION_BASE:OnEventPilotDead(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when the pilot of an aircraft is killed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_BASE).OnEventPlayerEnterAircraft">DETECTION_BASE:OnEventPlayerEnterAircraft(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
</td>
</tr>
<tr class="w3-border">
@@ -6411,6 +6435,12 @@ The different values of Unit.Category can be:</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_TYPES).CreateEventDead">DETECTION_TYPES:CreateEventDead(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Dead Event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_TYPES).CreateEventPlayerEnterAircraft">DETECTION_TYPES:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -6654,6 +6684,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_TYPES).OnEventPilotDead">DETECTION_TYPES:OnEventPilotDead(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when the pilot of an aircraft is killed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_TYPES).OnEventPlayerEnterAircraft">DETECTION_TYPES:OnEventPlayerEnterAircraft(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
</td>
</tr>
<tr class="w3-border">
@@ -8021,6 +8057,12 @@ The different values of Unit.Category can be:</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_UNITS).CreateEventDead">DETECTION_UNITS:CreateEventDead(EventTime, Initiator)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Dead Event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_UNITS).CreateEventPlayerEnterAircraft">DETECTION_UNITS:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -8264,6 +8306,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_UNITS).OnEventPilotDead">DETECTION_UNITS:OnEventPilotDead(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when the pilot of an aircraft is killed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DETECTION_UNITS).OnEventPlayerEnterAircraft">DETECTION_UNITS:OnEventPlayerEnterAircraft(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
</td>
</tr>
<tr class="w3-border">
@@ -15389,6 +15437,39 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_AREAS).CreateEventPlayerEnterAircraft" ><strong>DETECTION_AREAS:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
</div>
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>PlayerUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The aircraft unit the player entered.</p>
</div>
</div>
</div>
</div>
</div>
@@ -16942,6 +17023,43 @@ initiator : The unit that the pilot has died in. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_AREAS).OnEventPlayerEnterAircraft" ><strong>DETECTION_AREAS:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
</div>
<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>
<div id= "#Functions##OnEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -18417,6 +18535,17 @@ BASE:TraceOnOff( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(DETECTION_BASE).Locking" ><strong>DETECTION_BASE.Locking</strong></a>
</div>
</div>
@@ -23108,6 +23237,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(DETECTION_BASE).Locking" ><strong>DETECTION_BASE.Locking</strong></a>
</div>
</div>
@@ -24855,6 +24995,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(DETECTION_BASE).Locking" ><strong>DETECTION_BASE.Locking</strong></a>
</div>
</div>
@@ -25128,6 +25279,39 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_BASE).CreateEventPlayerEnterAircraft" ><strong>DETECTION_BASE:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
</div>
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>PlayerUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The aircraft unit the player entered.</p>
</div>
</div>
</div>
</div>
</div>
@@ -26681,6 +26865,43 @@ initiator : The unit that the pilot has died in. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_BASE).OnEventPlayerEnterAircraft" ><strong>DETECTION_BASE:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
</div>
<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>
<div id= "#Functions##OnEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -34869,6 +35090,39 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_TYPES).CreateEventPlayerEnterAircraft" ><strong>DETECTION_TYPES:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
</div>
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>PlayerUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The aircraft unit the player entered.</p>
</div>
</div>
</div>
</div>
</div>
@@ -36422,6 +36676,43 @@ initiator : The unit that the pilot has died in. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_TYPES).OnEventPlayerEnterAircraft" ><strong>DETECTION_TYPES:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
</div>
<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>
<div id= "#Functions##OnEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -44220,6 +44511,39 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_UNITS).CreateEventPlayerEnterAircraft" ><strong>DETECTION_UNITS:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
</div>
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>PlayerUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The aircraft unit the player entered.</p>
</div>
</div>
</div>
</div>
</div>
@@ -45773,6 +46097,43 @@ initiator : The unit that the pilot has died in. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DETECTION_UNITS).OnEventPlayerEnterAircraft" ><strong>DETECTION_UNITS:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
</div>
<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>
<div id= "#Functions##OnEventPlayerEnterAircraft" 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>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>