MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User 2019-02-04 22:38:28 +00:00
parent 136de18e45
commit e5070dfaa9
15 changed files with 423 additions and 207 deletions

View File

@ -2165,6 +2165,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> No loading happened, so we need to pickup something else.</p>
</div>
</div>
@ -4103,6 +4106,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> No loading happened, so we need to pickup something else.</p>
</div>
</div>
@ -4715,6 +4721,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> No loading happened, so we need to pickup something else.</p>
</div>
</div>
@ -5965,6 +5974,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> No loading happened, so we need to pickup something else.</p>
</div>
</div>

View File

@ -2122,6 +2122,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set destination airbase for next :Route() command.</p>
</div>
</div>
@ -2191,9 +2194,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a pickup mission.</p>
</div>
</div>
@ -3670,6 +3670,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set destination airbase for next :Route() command.</p>
</div>
</div>
@ -3739,9 +3742,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a pickup mission.</p>
</div>
</div>
@ -4310,6 +4310,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set destination airbase for next :Route() command.</p>
</div>
</div>
@ -4379,9 +4382,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a pickup mission.</p>
</div>
</div>
@ -5588,6 +5588,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Set destination airbase for next :Route() command.</p>
</div>
</div>
@ -5657,9 +5660,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a pickup mission.</p>
</div>
</div>

View File

@ -2636,6 +2636,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> This table contains the targets detected during patrol.</p>
</div>
</div>
@ -5883,6 +5886,9 @@ Note that this method is required, as triggers the next route when patrolling fo
<p> This table contains the targets detected during patrol.</p>
</div>
</div>
@ -6627,6 +6633,9 @@ Note that this method is required, as triggers the next route when patrolling fo
<p> This table contains the targets detected during patrol.</p>
</div>
</div>
@ -8009,6 +8018,9 @@ Note that this method is required, as triggers the next route when patrolling fo
<p> This table contains the targets detected during patrol.</p>
</div>
</div>

View File

@ -1356,6 +1356,17 @@ which are excellent tools to be reused in an OO environment!.</p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_CRATE).CargoCarrier" ><strong>CARGO_CRATE.CargoCarrier</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@ -2024,6 +2035,17 @@ which are excellent tools to be reused in an OO environment!.</p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_CRATE).CargoCarrier" ><strong>CARGO_CRATE.CargoCarrier</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">

View File

@ -1427,13 +1427,24 @@ which are excellent tools to be reused in an OO environment!.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_GROUP).CargoCarrier" ><strong>CARGO_GROUP.CargoCarrier</strong></a>
<p>self.CargoObject:Destroy()</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_GROUP).CargoGroup" ><strong>CARGO_GROUP.CargoGroup</strong></a>
<p> Then we register the new group in the database</p>
</div>
</div>
@ -1445,20 +1456,6 @@ which are excellent tools to be reused in an OO environment!.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_GROUP).CargoObject" ><strong>CARGO_GROUP.CargoObject</strong></a>
<p> Now we spawn the new group based on the template created.</p>
</div>
</div>
@ -2759,13 +2756,24 @@ This works for ground only groups.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_GROUP).CargoCarrier" ><strong>CARGO_GROUP.CargoCarrier</strong></a>
<p>self.CargoObject:Destroy()</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_GROUP).CargoGroup" ><strong>CARGO_GROUP.CargoGroup</strong></a>
<p> Then we register the new group in the database</p>
</div>
</div>
@ -2777,20 +2785,6 @@ This works for ground only groups.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_GROUP).CargoObject" ><strong>CARGO_GROUP.CargoObject</strong></a>
<p> Now we spawn the new group based on the template created.</p>
</div>
</div>

View File

@ -4820,7 +4820,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">
#string
<a id="#(FSM)._StartState" ><strong>FSM._StartState</strong></a>
@ -4836,6 +4836,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="#(FSM).current" ><strong>FSM.current</strong></a>
</div>
</div>
@ -6136,7 +6147,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">
#string
<a id="#(FSM)._StartState" ><strong>FSM._StartState</strong></a>
@ -6152,6 +6163,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="#(FSM).current" ><strong>FSM.current</strong></a>
</div>
</div>

View File

@ -12275,6 +12275,17 @@ BASE:TraceOnOff( false )</code></pre>
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@ -13073,6 +13084,17 @@ BASE:TraceOnOff( false )</code></pre>
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>
@ -18445,6 +18467,17 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
<p>the y coordinate in meters.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(POINT_VEC2).z" ><strong>POINT_VEC2.z</strong></a>
</div>
</div>

View File

@ -2120,7 +2120,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">
#string
<a id="#(SETTINGS).A2ASystem" ><strong>SETTINGS.A2ASystem</strong></a>
@ -2131,7 +2131,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">
#string
<a id="#(SETTINGS).A2GSystem" ><strong>SETTINGS.A2GSystem</strong></a>
@ -2164,11 +2164,22 @@ 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">
#boolean
<a id="#(SETTINGS).Metric" ><strong>SETTINGS.Metric</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SETTINGS).PlayerMenu" ><strong>SETTINGS.PlayerMenu</strong></a>
</div>
</div>
@ -3994,7 +4005,7 @@ It is advised to use this method at the start of the mission.</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(SETTINGS).A2ASystem" ><strong>SETTINGS.A2ASystem</strong></a>
@ -4005,7 +4016,7 @@ It is advised to use this method at the start of the mission.</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(SETTINGS).A2GSystem" ><strong>SETTINGS.A2GSystem</strong></a>
@ -4038,11 +4049,22 @@ It is advised to use this method at the start of the mission.</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(SETTINGS).Metric" ><strong>SETTINGS.Metric</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SETTINGS).PlayerMenu" ><strong>SETTINGS.PlayerMenu</strong></a>
</div>
</div>

View File

@ -2214,24 +2214,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).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).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>
@ -2966,8 +2948,16 @@ 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">
<p> By default, no InitLimit</p>
<a id="#(SPAWN).SpawnInitLivery" ><strong>SPAWN.SpawnInitLivery</strong></a>
</div>
@ -3000,7 +2990,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>
@ -3014,7 +3004,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>
@ -3160,17 +3150,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>
@ -3221,39 +3200,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).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).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>
@ -7589,8 +7535,16 @@ 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">
<p> By default, no InitLimit</p>
<a id="#(SPAWN).SpawnInitLivery" ><strong>SPAWN.SpawnInitLivery</strong></a>
</div>
@ -7623,7 +7577,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>
@ -7637,7 +7591,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>
@ -7783,17 +7737,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>
@ -7844,39 +7787,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).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).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>

View File

@ -1756,17 +1756,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">
#number
<a id="#(SPAWNSTATIC).SpawnIndex" ><strong>SPAWNSTATIC.SpawnIndex</strong></a>
</div>
</div>
@ -2296,17 +2285,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">
#number
<a id="#(SPAWNSTATIC).SpawnIndex" ><strong>SPAWNSTATIC.SpawnIndex</strong></a>
</div>
</div>

View File

@ -2139,6 +2139,50 @@ 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="#(SPOT).ScheduleID" ><strong>SPOT.ScheduleID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).SpotIR" ><strong>SPOT.SpotIR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).SpotLaser" ><strong>SPOT.SpotLaser</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).Target" ><strong>SPOT.Target</strong></a>
</div>
</div>
@ -3070,6 +3114,50 @@ 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="#(SPOT).ScheduleID" ><strong>SPOT.ScheduleID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).SpotIR" ><strong>SPOT.SpotIR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).SpotLaser" ><strong>SPOT.SpotLaser</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).Target" ><strong>SPOT.Target</strong></a>
</div>
</div>
@ -4309,6 +4397,50 @@ 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="#(SPOT).ScheduleID" ><strong>SPOT.ScheduleID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).SpotIR" ><strong>SPOT.SpotIR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).SpotLaser" ><strong>SPOT.SpotLaser</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPOT).Target" ><strong>SPOT.Target</strong></a>
</div>
</div>

View File

@ -2922,6 +2922,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="#(DESIGNATE).LaseDuration" ><strong>DESIGNATE.LaseDuration</strong></a>
</div>
</div>
@ -6090,6 +6101,17 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(DESIGNATE).LaseDuration" ><strong>DESIGNATE.LaseDuration</strong></a>
</div>
</div>
@ -6900,6 +6922,17 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(DESIGNATE).LaseDuration" ><strong>DESIGNATE.LaseDuration</strong></a>
</div>
</div>
@ -7680,6 +7713,17 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(DESIGNATE).LaseDuration" ><strong>DESIGNATE.LaseDuration</strong></a>
</div>
</div>
@ -9098,6 +9142,17 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(DESIGNATE).LaseDuration" ><strong>DESIGNATE.LaseDuration</strong></a>
</div>
</div>

View File

@ -3777,24 +3777,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="##(RAT)._TranslateRotate">RAT:_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="##(RAT).livery_id">RAT.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="##(RAT).skill">RAT.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="##(RAT).uncontrolled">RAT.uncontrolled</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>

View File

@ -1956,6 +1956,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">
<a id="#(ZONE_GOAL).SmokeTime" ><strong>ZONE_GOAL.SmokeTime</strong></a>
<p>self.SmokeColor = nil</p>
</div>
</div>
@ -2085,6 +2099,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">
<a id="#(ZONE_GOAL).SmokeTime" ><strong>ZONE_GOAL.SmokeTime</strong></a>
<p>self.SmokeColor = nil</p>
</div>
</div>
@ -3324,6 +3352,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">
<a id="#(ZONE_GOAL).SmokeTime" ><strong>ZONE_GOAL.SmokeTime</strong></a>
<p>self.SmokeColor = nil</p>
</div>
</div>

View File

@ -2678,7 +2678,7 @@ based on the tasking capabilities defined in <a href="Tasking.Task.html##(TASK)"
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a>
<a id="#(FSM_PROCESS).Cargo" ><strong>FSM_PROCESS.Cargo</strong></a>