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
+150 -108
View File
@@ -2640,24 +2640,6 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).frequency">SPAWN.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="##(SPAWN).livery_id">SPAWN.livery_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="##(SPAWN).modulation">SPAWN.modulation</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="##(SPAWN).skill">SPAWN.skill</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2714,6 +2696,12 @@ and any spaces before and after the resulting name are removed.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).CreateEventDead">SPAWN: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="##(SPAWN).CreateEventPlayerEnterAircraft">SPAWN: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">
@@ -2957,6 +2945,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).OnEventPilotDead">SPAWN: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="##(SPAWN).OnEventPlayerEnterAircraft">SPAWN: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">
@@ -3422,17 +3416,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="#(SPAWN).SpawnInitFreq" ><strong>SPAWN.SpawnInitFreq</strong></a>
</div>
</div>
@@ -3521,6 +3504,28 @@ 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="#(SPAWN).SpawnInitModu" ><strong>SPAWN.SpawnInitModu</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
</div>
</div>
@@ -3712,6 +3717,17 @@ 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">
#boolean
<a id="#(SPAWN).SpawnUnControlled" ><strong>SPAWN.SpawnUnControlled</strong></a>
</div>
</div>
@@ -3724,7 +3740,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</div>
@@ -3787,39 +3803,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="#(SPAWN).livery_id" ><strong>SPAWN.livery_id</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).modulation" ><strong>SPAWN.modulation</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).skill" ><strong>SPAWN.skill</strong></a>
</div>
</div>
@@ -8818,17 +8801,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).SpawnInitFreq" ><strong>SPAWN.SpawnInitFreq</strong></a>
</div>
</div>
@@ -8917,6 +8889,28 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).SpawnInitModu" ><strong>SPAWN.SpawnInitModu</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
</div>
</div>
@@ -9108,6 +9102,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(SPAWN).SpawnUnControlled" ><strong>SPAWN.SpawnUnControlled</strong></a>
</div>
</div>
@@ -9120,7 +9125,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</div>
@@ -9183,39 +9188,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).livery_id" ><strong>SPAWN.livery_id</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).modulation" ><strong>SPAWN.modulation</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).skill" ><strong>SPAWN.skill</strong></a>
</div>
</div>
@@ -9445,6 +9417,39 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SPAWN).CreateEventPlayerEnterAircraft" ><strong>SPAWN: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>
@@ -10998,6 +11003,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="#(SPAWN).OnEventPlayerEnterAircraft" ><strong>SPAWN: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>