MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-22 09:15:30 +00:00
parent 16abde2bbb
commit ffeb91ddff
140 changed files with 1051 additions and 1233 deletions

View File

@@ -405,7 +405,7 @@
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Account.html">Actions.Act_Account</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count &amp; report) various DCS events occuring on <a href="Wrapper.Unit.html">Wrapper.Unit</a>s.</p>
<p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count &amp; report) various DCS events occurring on <a href="Wrapper.Unit.html">Wrapper.Unit</a>s.</p>
</p></div>
</div>
</div>
@@ -1805,7 +1805,7 @@ So in principle, the group list will contain all parameters and configurations a
<ul>
<li><a href="##(SPAWN).InitRandomizePosition">SPAWN.InitRandomizePosition</a>(): Randomizes the position of <a href="Wrapper.Group.html">Wrapper.Group</a>s that are spawned within a <strong>radius band</strong>, given an Outer and Inner radius, from the point that the spawn happens.</li>
<li><a href="##(SPAWN).InitRandomizeUnits">SPAWN.InitRandomizeUnits</a>(): Randomizes the <a href="Wrapper.Unit.html">Wrapper.Unit</a>s in the <a href="Wrapper.Group.html">Wrapper.Group</a> that is spawned within a <strong>radius band</strong>, given an Outer and Inner radius.</li>
<li><a href="##(SPAWN).InitRandomizeZones">SPAWN.InitRandomizeZones</a>(): Randomizes the spawning between a predefined list of <a href="Zone.html">Zone</a>s that are declared using this function. Each zone can be given a probability factor.</li>
<li><a href="##(SPAWN).InitRandomizeZones">SPAWN.InitRandomizeZones</a>(): Randomizes the spawning between a predefined list of <a href="Core.Zone.html">Core.Zone</a>s that are declared using this function. Each zone can be given a probability factor.</li>
</ul>
<h3>Enable / Disable AI when spawning a new <a href="Wrapper.Group.html">Wrapper.Group</a></h3>
@@ -1850,7 +1850,7 @@ So in principle, the group list will contain all parameters and configurations a
<li><a href="##(SPAWN).SpawnFromVec2">SPAWN.SpawnFromVec2</a>(): Spawn a new group from a Vec2 coordinate. (The group will be spawned at land height ).</li>
<li><a href="##(SPAWN).SpawnFromStatic">SPAWN.SpawnFromStatic</a>(): Spawn a new group from a structure, taking the position of a <a href="Wrapper.Static.html">Wrapper.Static</a>.</li>
<li><a href="##(SPAWN).SpawnFromUnit">SPAWN.SpawnFromUnit</a>(): Spawn a new group taking the position of a <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</li>
<li><a href="##(SPAWN).SpawnInZone">SPAWN.SpawnInZone</a>(): Spawn a new group in a <a href="Zone.html">Zone</a>.</li>
<li><a href="##(SPAWN).SpawnInZone">SPAWN.SpawnInZone</a>(): Spawn a new group in a <a href="Core.Zone.html">Core.Zone</a>.</li>
<li><a href="##(SPAWN).SpawnAtAirbase">SPAWN.SpawnAtAirbase</a>(): Spawn a new group at an <a href="Wrapper.Airbase.html">Wrapper.Airbase</a>, which can be an airdrome, ship or helipad.</li>
</ul>
@@ -2416,7 +2416,7 @@ and any spaces before and after the resulting name are removed.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).SpawnInZone">SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Will spawn a Group within a given <a href="Zone.html">Zone</a>.</p>
<p>Will spawn a Group within a given <a href="Core.Zone.html">Core.Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2830,7 +2830,7 @@ and any spaces before and after the resulting name are removed.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN)._RandomizeZones">SPAWN:_RandomizeZones(SpawnIndex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Private method that randomizes the <a href="Zone.html">Zone</a>s where the Group will be spawned.</p>
<p>Private method that randomizes the <a href="Core.Zone.html">Core.Zone</a>s where the Group will be spawned.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2849,42 +2849,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).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">
<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>
@@ -3579,6 +3543,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>
@@ -3648,17 +3626,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>
@@ -3747,20 +3714,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">
#boolean
<a id="#(SPAWN).SpawnInitKeepUnitNames" ><strong>SPAWN.SpawnInitKeepUnitNames</strong></a>
<p> Overwrite unit names by default with group name.</p>
</div>
</div>
@@ -3779,18 +3732,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).SpawnInitModex" ><strong>SPAWN.SpawnInitModex</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).SpawnInitModu" ><strong>SPAWN.SpawnInitModu</strong></a>
<a id="#(SPAWN).SpawnInitLivery" ><strong>SPAWN.SpawnInitLivery</strong></a>
@@ -3996,17 +3938,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">
#boolean
<a id="#(SPAWN).SpawnUnControlled" ><strong>SPAWN.SpawnUnControlled</strong></a>
</div>
</div>
@@ -4071,72 +4002,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).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>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
</div>
</div>
@@ -6043,7 +5908,7 @@ In other words, this method randomizes between a defined set of groups the templ
</div>
<div class="w3-half">
<p>A table with <a href="Zone.html">Zone</a> objects. If this table is given, then each spawn will be executed within the given list of <a href="Zone.html">Zone</a>s objects.</p>
<p>A table with <a href="Core.Zone.html">Core.Zone</a> objects. If this table is given, then each spawn will be executed within the given list of <a href="Core.Zone.html">Core.Zone</a>s objects.</p>
</div>
</div>
@@ -7758,10 +7623,10 @@ You can use the returned group to further define the route to be followed.</p>
<h2><a id="#(SPAWN).SpawnInZone" ><strong>SPAWN:SpawnInZone(Zone, RandomizeGroup, MinHeight, MaxHeight, SpawnIndex)</strong></a></h2>
</div>
<p>Will spawn a Group within a given <a href="Zone.html">Zone</a>.</p>
<p>Will spawn a Group within a given <a href="Core.Zone.html">Core.Zone</a>.</p>
<p>The <a href="Zone.html">Zone</a> can be of any type derived from <a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>.
<p>The <a href="Core.Zone.html">Core.Zone</a> can be of any type derived from <a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>.
Once the <a href="Wrapper.Group.html">Wrapper.Group</a> is spawned within the zone, the <a href="Wrapper.Group.html">Wrapper.Group</a> will continue on its route.
The <strong>first waypoint</strong> (where the group is spawned) is replaced with the zone location coordinates.</p>
@@ -8701,7 +8566,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<h2><a id="#(SPAWN)._RandomizeZones" ><strong>SPAWN:_RandomizeZones(SpawnIndex)</strong></a></h2>
</div>
<p>Private method that randomizes the <a href="Zone.html">Zone</a>s where the Group will be spawned.</p>
<p>Private method that randomizes the <a href="Core.Zone.html">Core.Zone</a>s where the Group will be spawned.</p>
<div id= "#Functions##_RandomizeZones" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -9010,6 +8875,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>
@@ -9079,17 +8958,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>
@@ -9178,20 +9046,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">
#boolean
<a id="#(SPAWN).SpawnInitKeepUnitNames" ><strong>SPAWN.SpawnInitKeepUnitNames</strong></a>
<p> Overwrite unit names by default with group name.</p>
</div>
</div>
@@ -9210,18 +9064,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">
<a id="#(SPAWN).SpawnInitModex" ><strong>SPAWN.SpawnInitModex</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).SpawnInitModu" ><strong>SPAWN.SpawnInitModu</strong></a>
<a id="#(SPAWN).SpawnInitLivery" ><strong>SPAWN.SpawnInitLivery</strong></a>
@@ -9427,17 +9270,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">
#boolean
<a id="#(SPAWN).SpawnUnControlled" ><strong>SPAWN.SpawnUnControlled</strong></a>
</div>
</div>
@@ -9502,72 +9334,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).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>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWN).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
</div>
</div>