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

@@ -2630,6 +2630,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).CreateEventDead">COORDINATE: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="##(COORDINATE).CreateEventPlayerEnterAircraft">COORDINATE: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">
@@ -2873,6 +2879,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(COORDINATE).OnEventPilotDead">COORDINATE: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="##(COORDINATE).OnEventPlayerEnterAircraft">COORDINATE: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">
@@ -4081,6 +4093,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).CreateEventDead">POINT_VEC2: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="##(POINT_VEC2).CreateEventPlayerEnterAircraft">POINT_VEC2: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">
@@ -4324,6 +4342,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(POINT_VEC2).OnEventPilotDead">POINT_VEC2: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="##(POINT_VEC2).OnEventPlayerEnterAircraft">POINT_VEC2: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">
@@ -11786,6 +11810,39 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(COORDINATE).CreateEventPlayerEnterAircraft" ><strong>COORDINATE: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>
@@ -13339,6 +13396,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="#(COORDINATE).OnEventPlayerEnterAircraft" ><strong>COORDINATE: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>
@@ -14594,6 +14688,17 @@ BASE:TraceOnOff( false )</code></pre>
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -15392,6 +15497,17 @@ BASE:TraceOnOff( false )</code></pre>
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -22065,6 +22181,17 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@@ -22283,6 +22410,39 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(POINT_VEC2).CreateEventPlayerEnterAircraft" ><strong>POINT_VEC2: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>
@@ -23836,6 +23996,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="#(POINT_VEC2).OnEventPlayerEnterAircraft" ><strong>POINT_VEC2: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>