MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User 2019-01-13 15:33:37 +00:00
parent ae826e088d
commit 0ad02adcbe
16 changed files with 229 additions and 422 deletions

View File

@ -2197,9 +2197,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>
@ -3751,9 +3748,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>
@ -4397,9 +4391,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>
@ -5681,9 +5672,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,9 +2636,6 @@ 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>
@ -5886,9 +5883,6 @@ 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>
@ -6633,9 +6627,6 @@ 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>
@ -8018,9 +8009,6 @@ 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

@ -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>
@ -2759,13 +2770,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>

View File

@ -1305,17 +1305,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_UNIT).CargoCarrier" ><strong>CARGO_UNIT.CargoCarrier</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_UNIT).CargoInAir" ><strong>CARGO_UNIT.CargoInAir</strong></a>
@ -1331,17 +1320,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CARGO_UNIT).RunCount" ><strong>CARGO_UNIT.RunCount</strong></a>
</div>
</div>
@ -2028,17 +2006,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_UNIT).CargoCarrier" ><strong>CARGO_UNIT.CargoCarrier</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CARGO_UNIT).CargoInAir" ><strong>CARGO_UNIT.CargoInAir</strong></a>
@ -2054,17 +2021,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CARGO_UNIT).RunCount" ><strong>CARGO_UNIT.RunCount</strong></a>
</div>
</div>

View File

@ -4154,9 +4154,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Coordinates.</p>
</div>
</div>
@ -9595,9 +9592,6 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t
<p> Coordinates.</p>
</div>
</div>
@ -12281,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>
@ -13079,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>
@ -18451,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>
@ -2169,6 +2169,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="#(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>
@ -4043,6 +4054,17 @@ It is advised to use this method at the start of the mission.</p>
</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,6 +2214,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)._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).uncontrolled">SPAWN.uncontrolled</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@ -3150,6 +3162,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>
@ -3200,6 +3223,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).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>
@ -7737,6 +7782,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>
@ -7787,6 +7843,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).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>

View File

@ -1740,19 +1740,8 @@ 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">
<a id="#(SPAWNSTATIC).CoalitionID" ><strong>SPAWNSTATIC.CoalitionID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).CountryID" ><strong>SPAWNSTATIC.CountryID</strong></a>
#number
<a id="#(SPAWNSTATIC).SpawnIndex" ><strong>SPAWNSTATIC.SpawnIndex</strong></a>
@ -2269,19 +2258,8 @@ 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">
<a id="#(SPAWNSTATIC).CoalitionID" ><strong>SPAWNSTATIC.CoalitionID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SPAWNSTATIC).CountryID" ><strong>SPAWNSTATIC.CountryID</strong></a>
#number
<a id="#(SPAWNSTATIC).SpawnIndex" ><strong>SPAWNSTATIC.SpawnIndex</strong></a>

View File

@ -2139,50 +2139,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="#(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>
@ -3114,50 +3070,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="#(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>
@ -4397,50 +4309,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="#(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,17 +2922,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="#(DESIGNATE).LaseDuration" ><strong>DESIGNATE.LaseDuration</strong></a>
</div>
</div>
@ -6090,17 +6079,6 @@ 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,17 +6878,6 @@ 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,17 +7647,6 @@ 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,17 +9054,6 @@ 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

@ -16311,28 +16311,6 @@ BASE:TraceOnOff( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(DETECTION_BASE).DetectedItemCount" ><strong>DETECTION_BASE.DetectedItemCount</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(DETECTION_BASE).DetectedItemMax" ><strong>DETECTION_BASE.DetectedItemMax</strong></a>
</div>
</div>
@ -20643,28 +20621,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(DETECTION_BASE).DetectedItemCount" ><strong>DETECTION_BASE.DetectedItemCount</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(DETECTION_BASE).DetectedItemMax" ><strong>DETECTION_BASE.DetectedItemMax</strong></a>
</div>
</div>
@ -22146,28 +22102,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(DETECTION_BASE).DetectedItemCount" ><strong>DETECTION_BASE.DetectedItemCount</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(DETECTION_BASE).DetectedItemMax" ><strong>DETECTION_BASE.DetectedItemMax</strong></a>
</div>
</div>

View File

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

View File

@ -1963,17 +1963,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<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">
#boolean
<a id="#(COMMANDCENTER).AutoAssignTasks" ><strong>COMMANDCENTER.AutoAssignTasks</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@ -3120,17 +3109,6 @@ CC:SetReferenceZones( "Station" )
<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">
#boolean
<a id="#(COMMANDCENTER).AutoAssignTasks" ><strong>COMMANDCENTER.AutoAssignTasks</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">

View File

@ -2380,17 +2380,6 @@ but can separately be modified later in your mission using the
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK).TaskControlMenu" ><strong>TASK.TaskControlMenu</strong></a>
</div>
</div>
@ -6903,17 +6892,6 @@ If the Unit is part of the Task, true is returned.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(TASK).TaskControlMenu" ><strong>TASK.TaskControlMenu</strong></a>
</div>
</div>

View File

@ -2678,22 +2678,11 @@ 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>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(FSM_PROCESS).DeployZone" ><strong>FSM_PROCESS.DeployZone</strong></a>
</div>
</div>
@ -2726,7 +2715,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">
#number
<a id="#(TASK_CARGO).CargoLimit" ><strong>TASK_CARGO.CargoLimit</strong></a>
@ -4102,7 +4091,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">
#number
<a id="#(TASK_CARGO).CargoLimit" ><strong>TASK_CARGO.CargoLimit</strong></a>
@ -8521,7 +8510,7 @@ If the Unit is part of the Task, true is returned.</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO).CargoLimit" ><strong>TASK_CARGO.CargoLimit</strong></a>

View File

@ -2634,7 +2634,18 @@ 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="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@ -3757,7 +3768,18 @@ This method can only be used once!</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@ -4659,7 +4681,18 @@ This method can only be used once!</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@ -5942,7 +5975,18 @@ This method can only be used once!</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(TASK_CARGO_DISPATCHER).CountCSAR" ><strong>TASK_CARGO_DISPATCHER.CountCSAR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>