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:
FlightControl-User
@@ -1690,6 +1690,12 @@ Example code snippet:</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).CreateEventNewZoneGoal">EVENT:CreateEventNewZoneGoal(ZoneGoal)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creation of a New ZoneGoal Event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).CreateEventPlayerEnterAircraft">EVENT:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1854,6 +1860,12 @@ Example code snippet:</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).CreateEventDead">EVENT: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="##(EVENT).CreateEventPlayerEnterAircraft">EVENT: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">
|
||||
@@ -2097,6 +2109,12 @@ place: Object that the unit landed on.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).OnEventPilotDead">EVENT: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="##(EVENT).OnEventPlayerEnterAircraft">EVENT: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">
|
||||
@@ -2717,6 +2735,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="##(EVENTHANDLER).CreateEventDead">EVENTHANDLER: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="##(EVENTHANDLER).CreateEventPlayerEnterAircraft">EVENTHANDLER: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">
|
||||
@@ -2960,6 +2984,12 @@ place: Object that the unit landed on.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).OnEventPilotDead">EVENTHANDLER: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="##(EVENTHANDLER).OnEventPlayerEnterAircraft">EVENTHANDLER: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">
|
||||
@@ -3323,6 +3353,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="##(EVENTS).PlayerComment">EVENTS.PlayerComment</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="##(EVENTS).PlayerEnterAircraft">EVENTS.PlayerEnterAircraft</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3632,6 +3668,39 @@ 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="#(EVENT).CreateEventPlayerEnterAircraft" ><strong>EVENT:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT 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>EVENT</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>
|
||||
|
||||
@@ -3821,7 +3890,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -4111,11 +4180,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>EventID</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Event ID.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
@@ -4125,7 +4197,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Optional arguments passed to the event function.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
@@ -4135,7 +4209,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -4223,7 +4297,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -4958,6 +5032,39 @@ 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="#(EVENT).CreateEventPlayerEnterAircraft" ><strong>EVENT: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>
|
||||
|
||||
@@ -6511,6 +6618,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="#(EVENT).OnEventPlayerEnterAircraft" ><strong>EVENT: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>
|
||||
|
||||
@@ -8623,6 +8767,39 @@ Note that at the beginning of each field description, there is an indication whi
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(EVENTHANDLER).CreateEventPlayerEnterAircraft" ><strong>EVENTHANDLER: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>
|
||||
|
||||
@@ -10176,6 +10353,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="#(EVENTHANDLER).OnEventPlayerEnterAircraft" ><strong>EVENTHANDLER: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>
|
||||
|
||||
@@ -11674,6 +11888,17 @@ BASE:TraceOnOff( false )</code></pre>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(EVENTS).PlayerEnterAircraft" ><strong>EVENTS.PlayerEnterAircraft</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user