MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-05-04 08:32:28 +00:00
parent b69a795711
commit cbea8561f1
106 changed files with 2211 additions and 1206 deletions

View File

@@ -2647,9 +2647,15 @@ and any spaces before and after the resulting name are removed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN)._GetPrefixFromGroup">SPAWN:_GetPrefixFromGroup(DCSUnit, SpawnGroup)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN)._GetPrefixFromGroup">SPAWN:_GetPrefixFromGroup(SpawnGroup)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the prefix of a SpawnUnit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN)._GetPrefixFromGroupName">SPAWN:_GetPrefixFromGroupName(SpawnGroupName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the prefix of a spawned group.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2740,30 +2746,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)._TranslateRotate">SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</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).communication">SPAWN.communication</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).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).uncontrolled">SPAWN.uncontrolled</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -2805,7 +2787,7 @@ and any spaces before and after the resulting name are removed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).CreateEventCrash">SPAWN:CreateEventCrash(EventTime, Initiator)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).CreateEventCrash">SPAWN:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Crash Event.</p>
</td>
@@ -3453,6 +3435,20 @@ 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">
#number
<a id="#(SPAWN).SpawnCount" ><strong>SPAWN.SpawnCount</strong></a>
<p> The internal counter of the amount of spawning the has happened since SpawnStart.</p>
</div>
</div>
@@ -3475,6 +3471,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">
<a id="#(SPAWN).SpawnGrouping" ><strong>SPAWN.SpawnGrouping</strong></a>
</div>
</div>
@@ -3511,17 +3518,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).SpawnInitAirbase" ><strong>SPAWN.SpawnInitAirbase</strong></a>
</div>
</div>
@@ -3635,6 +3631,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> By default, no InitLimit</p>
</div>
</div>
@@ -3657,28 +3656,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).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>
@@ -3710,7 +3687,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(SPAWN).SpawnMaxGroups" ><strong>SPAWN.SpawnMaxGroups</strong></a>
@@ -3724,7 +3701,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(SPAWN).SpawnMaxUnitsAlive" ><strong>SPAWN.SpawnMaxUnitsAlive</strong></a>
@@ -3870,6 +3847,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>
@@ -3934,50 +3922,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).communication" ><strong>SPAWN.communication</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).frequency" ><strong>SPAWN.frequency</strong></a>
</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).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
</div>
</div>
@@ -8073,7 +8017,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):SpawnScheduled( 600,
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SPAWN)._GetPrefixFromGroup" ><strong>SPAWN:_GetPrefixFromGroup(DCSUnit, SpawnGroup)</strong></a></h2>
<h2><a id="#(SPAWN)._GetPrefixFromGroup" ><strong>SPAWN:_GetPrefixFromGroup(SpawnGroup)</strong></a></h2>
</div>
<p>Return the prefix of a SpawnUnit.</p>
@@ -8088,48 +8032,77 @@ It will return nil of no prefix was found.</p>
<div class="w3-margin-left">
<p>SPAWN</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(UNIT)">DCS#UNIT</a>
<strong><strong>DCSUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The <a href="DCSUnit.html">DCSUnit</a> to be searched.</p>
</div>
</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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>SpawnGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The GROUP object.</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The prefix</p>
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The prefix or #nil if nothing was found.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>Nothing found</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SPAWN)._GetPrefixFromGroupName" ><strong>SPAWN:_GetPrefixFromGroupName(SpawnGroupName)</strong></a></h2>
</div>
<p>Return the prefix of a spawned group.</p>
<p>The method will search for a <code>#</code>-mark, and will return the text before the <code>#</code>-mark. It will return nil of no prefix was found.</p>
<div id= "#Functions##_GetPrefixFromGroupName" 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>SPAWN</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>
#string
<strong><strong>SpawnGroupName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the spawned group.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The prefix or #nil if nothing was found.</p>
</div>
</div>
</div>
@@ -8881,6 +8854,20 @@ 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">
#number
<a id="#(SPAWN).SpawnCount" ><strong>SPAWN.SpawnCount</strong></a>
<p> The internal counter of the amount of spawning the has happened since SpawnStart.</p>
</div>
</div>
@@ -8903,6 +8890,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">
<a id="#(SPAWN).SpawnGrouping" ><strong>SPAWN.SpawnGrouping</strong></a>
</div>
</div>
@@ -8939,17 +8937,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).SpawnInitAirbase" ><strong>SPAWN.SpawnInitAirbase</strong></a>
</div>
</div>
@@ -9063,6 +9050,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<p> By default, no InitLimit</p>
</div>
</div>
@@ -9085,28 +9075,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).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>
@@ -9138,7 +9106,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(SPAWN).SpawnMaxGroups" ><strong>SPAWN.SpawnMaxGroups</strong></a>
@@ -9152,7 +9120,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(SPAWN).SpawnMaxUnitsAlive" ><strong>SPAWN.SpawnMaxUnitsAlive</strong></a>
@@ -9298,6 +9266,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>
@@ -9362,50 +9341,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<p> When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).communication" ><strong>SPAWN.communication</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).frequency" ><strong>SPAWN.frequency</strong></a>
</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).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
</div>
</div>
@@ -9538,7 +9473,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SPAWN).CreateEventCrash" ><strong>SPAWN:CreateEventCrash(EventTime, Initiator)</strong></a></h2>
<h2><a id="#(SPAWN).CreateEventCrash" ><strong>SPAWN:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
</div>
<p>Creation of a Crash Event.</p>
@@ -9576,6 +9511,16 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>IniObjectCategory</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>