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:
Applevangelist
@@ -2190,6 +2190,18 @@ 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).InitRepeatOnLanding">SPAWN:InitRepeatOnLanding()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Respawn group after landing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).InitSetUnitAbsolutePositions">SPAWN:InitSetUnitAbsolutePositions(Positions)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Spawn the UNITs of this group with individual absolute positions and individual headings.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SPAWN).InitSetUnitRelativePositions">SPAWN:InitSetUnitRelativePositions(Positions)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2683,6 +2695,18 @@ 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).SpawnUnControlled">SPAWN.SpawnUnControlled</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).SpawnUnitsWithAbsolutePositions">SPAWN.SpawnUnitsWithAbsolutePositions</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).SpawnUnitsWithRelativePositions">SPAWN.SpawnUnitsWithRelativePositions</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2719,6 +2743,18 @@ 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).UnControlled">SPAWN.UnControlled</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).UnitsAbsolutePositions">SPAWN.UnitsAbsolutePositions</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).UnitsRelativePositions">SPAWN.UnitsRelativePositions</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2851,6 +2887,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).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">
|
||||
@@ -2860,7 +2902,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).uncontrolled">SPAWN.uncontrolled</a></p></td>
|
||||
<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>
|
||||
@@ -3499,6 +3541,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3554,6 +3599,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>
|
||||
@@ -3576,17 +3635,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).SpawnGrouping" ><strong>SPAWN.SpawnGrouping</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3623,17 +3671,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>
|
||||
@@ -3979,6 +4016,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">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnUnitsWithAbsolutePositions" ><strong>SPAWN.SpawnUnitsWithAbsolutePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnUnitsWithRelativePositions" ><strong>SPAWN.SpawnUnitsWithRelativePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3991,7 +4050,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>
|
||||
|
||||
@@ -4043,6 +4102,28 @@ 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).UnitsAbsolutePositions" ><strong>SPAWN.UnitsAbsolutePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).UnitsRelativePositions" ><strong>SPAWN.UnitsRelativePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4054,6 +4135,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).frequency" ><strong>SPAWN.frequency</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4072,7 +4164,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).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
|
||||
<a id="#(SPAWN).skill" ><strong>SPAWN.skill</strong></a>
|
||||
|
||||
|
||||
|
||||
@@ -5951,10 +6043,8 @@ In other words, this method randomizes between a defined set of groups the templ
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>
|
||||
-- NATO helicopters engaging in the battle field.
|
||||
-- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or DP).
|
||||
-- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new spawn of the helicopter.
|
||||
-- The randomization of waypoint 2 and 3 will take place within a radius of 2000 meters.
|
||||
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute( 2, 2, 2000 )
|
||||
-- UNIT positions of this group will be randomized around the base unit #1 in a circle of 50 to 500 meters.
|
||||
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeUnits( true, 500, 50 )
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
@@ -6142,6 +6232,110 @@ So ensure that the routes for groups that respawn, always return to the original
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(SPAWN).InitSetUnitAbsolutePositions" ><strong>SPAWN:InitSetUnitAbsolutePositions(Positions)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Spawn the UNITs of this group with individual absolute positions and individual headings.</p>
|
||||
|
||||
<div id= "#Functions##InitSetUnitAbsolutePositions" 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>
|
||||
#table
|
||||
<strong><strong>Positions</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z
|
||||
absolute positions, and optionally an individual heading.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(SPAWN)">#SPAWN</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>
|
||||
-- NATO helicopter group of three units engaging in the battle field.
|
||||
local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
|
||||
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitAbsolutePositions(Positions)
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(SPAWN).InitSetUnitRelativePositions" ><strong>SPAWN:InitSetUnitRelativePositions(Positions)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.</p>
|
||||
|
||||
<div id= "#Functions##InitSetUnitRelativePositions" 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>
|
||||
#table
|
||||
<strong><strong>Positions</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Table of positions, needs to one entry per unit in the group(!). The table contains one table each for each unit, with x,y, and optionally z
|
||||
relative positions, and optionally an individual heading.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(SPAWN)">#SPAWN</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>
|
||||
-- NATO helicopter group of three units engaging in the battle field.
|
||||
local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
|
||||
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitRelativePositions(Positions)
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -8909,6 +9103,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
|
||||
|
||||
|
||||
|
||||
|
||||
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -8964,6 +9161,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>
|
||||
@@ -8986,17 +9197,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).SpawnGrouping" ><strong>SPAWN.SpawnGrouping</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9033,17 +9233,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>
|
||||
@@ -9389,6 +9578,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">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnUnitsWithAbsolutePositions" ><strong>SPAWN.SpawnUnitsWithAbsolutePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(SPAWN).SpawnUnitsWithRelativePositions" ><strong>SPAWN.SpawnUnitsWithRelativePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9401,7 +9612,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>
|
||||
|
||||
@@ -9453,6 +9664,28 @@ 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).UnitsAbsolutePositions" ><strong>SPAWN.UnitsAbsolutePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(SPAWN).UnitsRelativePositions" ><strong>SPAWN.UnitsRelativePositions</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9464,6 +9697,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).frequency" ><strong>SPAWN.frequency</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -9482,7 +9726,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).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
|
||||
<a id="#(SPAWN).skill" ><strong>SPAWN.skill</strong></a>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user