MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User 2019-07-01 14:38:35 +00:00
parent 3023d0d421
commit 7f62521d07
16 changed files with 336 additions and 89 deletions

View File

@ -2165,9 +2165,6 @@ 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>
@ -4106,9 +4103,6 @@ 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>
@ -4721,9 +4715,6 @@ 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>
@ -5974,9 +5965,6 @@ 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

@ -2155,9 +2155,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a depoly mission.</p>
</div>
</div>
@ -3695,9 +3692,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a depoly mission.</p>
</div>
</div>
@ -4327,9 +4321,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a depoly mission.</p>
</div>
</div>
@ -5597,9 +5588,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Aircraft is on a depoly 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,6 +1427,20 @@ 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>
@ -2759,6 +2773,20 @@ 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>

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>
@ -6147,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>

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

@ -2164,7 +2164,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">
#boolean
<a id="#(SETTINGS).Metric" ><strong>SETTINGS.Metric</strong></a>
@ -4049,7 +4049,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">
#boolean
<a id="#(SETTINGS).Metric" ><strong>SETTINGS.Metric</strong></a>

View File

@ -2744,6 +2744,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>
@ -2937,20 +2940,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>
@ -2973,6 +2962,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">
#string
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
</div>
</div>
@ -3153,6 +3153,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>
@ -7334,6 +7345,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>
@ -7527,20 +7541,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>
@ -7563,6 +7563,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">
#string
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
</div>
</div>
@ -7743,6 +7754,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>

View File

@ -1734,6 +1734,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">
<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>
</div>
</div>
@ -2252,6 +2274,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">
<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>
</div>
</div>

View File

@ -16311,6 +16311,17 @@ BASE:TraceOnOff( false )</code></pre>
</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>
@ -20621,6 +20632,17 @@ 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).DetectedItemMax" ><strong>DETECTION_BASE.DetectedItemMax</strong></a>
</div>
</div>
@ -22102,6 +22124,17 @@ 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).DetectedItemMax" ><strong>DETECTION_BASE.DetectedItemMax</strong></a>
</div>
</div>

View File

@ -1963,6 +1963,17 @@ 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">
@ -3109,6 +3120,17 @@ 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,11 +2678,22 @@ 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>

View File

@ -2634,7 +2634,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">
#table
<a id="#(TASK_CARGO_DISPATCHER).DefaultDeployZones" ><strong>TASK_CARGO_DISPATCHER.DefaultDeployZones</strong></a>
@ -3746,7 +3746,7 @@ This method can only be used once!</p>
<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>
@ -4637,7 +4637,7 @@ This method can only be used once!</p>
<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>
@ -5909,7 +5909,7 @@ This method can only be used once!</p>
<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>

View File

@ -3602,7 +3602,18 @@ 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="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@ -6944,7 +6955,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@ -12730,7 +12752,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@ -15698,7 +15731,18 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@ -16281,7 +16325,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
@ -16475,7 +16530,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>