MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2018-10-21 11:24:02 +00:00
parent 251d8e38fd
commit 7af7f895d4
17 changed files with 279 additions and 225 deletions
-44
View File
@@ -2391,17 +2391,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="#(AI_A2A).IdleCount" ><strong>AI_A2A.IdleCount</strong></a>
</div>
</div>
@@ -4970,17 +4959,6 @@ Once the time is finished, the old AI will return to the base.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A).IdleCount" ><strong>AI_A2A.IdleCount</strong></a>
</div>
</div>
@@ -5670,17 +5648,6 @@ Once the time is finished, the old AI will return to the base.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A).IdleCount" ><strong>AI_A2A.IdleCount</strong></a>
</div>
</div>
@@ -7008,17 +6975,6 @@ Once the time is finished, the old AI will return to the base.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(AI_A2A).IdleCount" ><strong>AI_A2A.IdleCount</strong></a>
</div>
</div>
+16 -4
View File
@@ -2127,7 +2127,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">
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<a id="#(AI_CARGO).CargoCarrier" ><strong>AI_CARGO.CargoCarrier</strong></a>
@@ -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>
@@ -4065,7 +4068,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">
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<a id="#(AI_CARGO).CargoCarrier" ><strong>AI_CARGO.CargoCarrier</strong></a>
@@ -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>
@@ -4677,7 +4683,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">
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<a id="#(AI_CARGO).CargoCarrier" ><strong>AI_CARGO.CargoCarrier</strong></a>
@@ -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>
@@ -5927,7 +5936,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">
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<a id="#(AI_CARGO).CargoCarrier" ><strong>AI_CARGO.CargoCarrier</strong></a>
@@ -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>
-12
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>
+12
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>
-28
View File
@@ -1456,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>
@@ -2799,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>
-33
View File
@@ -12281,17 +12281,6 @@ 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>
@@ -13090,17 +13079,6 @@ 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>
@@ -18473,17 +18451,6 @@ 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>
-22
View File
@@ -2169,17 +2169,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="#(SETTINGS).PlayerMenu" ><strong>SETTINGS.PlayerMenu</strong></a>
</div>
</div>
@@ -4054,17 +4043,6 @@ 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>
+55 -11
View File
@@ -2223,7 +2223,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).skill">SPAWN.skill</a></p></td>
<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>
@@ -2949,6 +2949,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">
#boolean
<a id="#(SPAWN).SpawnInitKeepUnitNames" ><strong>SPAWN.SpawnInitKeepUnitNames</strong></a>
<p> Overwrite unit names by default with group name.</p>
</div>
</div>
@@ -2960,8 +2974,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">
#string
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
<p> By default, no InitLimit</p>
</div>
@@ -2983,7 +3005,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>
@@ -2997,7 +3019,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>
@@ -3166,7 +3188,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
</div>
@@ -3222,7 +3244,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).skill" ><strong>SPAWN.skill</strong></a>
<a id="#(SPAWN).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
@@ -7550,6 +7572,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">
#boolean
<a id="#(SPAWN).SpawnInitKeepUnitNames" ><strong>SPAWN.SpawnInitKeepUnitNames</strong></a>
<p> Overwrite unit names by default with group name.</p>
</div>
</div>
@@ -7561,8 +7597,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">
#string
<a id="#(SPAWN).SpawnInitSkill" ><strong>SPAWN.SpawnInitSkill</strong></a>
<p> By default, no InitLimit</p>
</div>
@@ -7584,7 +7628,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>
@@ -7598,7 +7642,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>
@@ -7767,7 +7811,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.</p
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
</div>
@@ -7823,7 +7867,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).skill" ><strong>SPAWN.skill</strong></a>
<a id="#(SPAWN).uncontrolled" ><strong>SPAWN.uncontrolled</strong></a>
-55
View File
@@ -2938,17 +2938,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">
#table
<a id="#(DESIGNATE).LaserCodes" ><strong>DESIGNATE.LaserCodes</strong></a>
</div>
</div>
@@ -6073,17 +6062,6 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(DESIGNATE).LaserCodes" ><strong>DESIGNATE.LaserCodes</strong></a>
</div>
</div>
@@ -6894,17 +6872,6 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(DESIGNATE).LaserCodes" ><strong>DESIGNATE.LaserCodes</strong></a>
</div>
</div>
@@ -7685,17 +7652,6 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(DESIGNATE).LaserCodes" ><strong>DESIGNATE.LaserCodes</strong></a>
</div>
</div>
@@ -9114,17 +9070,6 @@ Designate:SetFlashStatusMenu( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(DESIGNATE).LaserCodes" ><strong>DESIGNATE.LaserCodes</strong></a>
</div>
</div>
+33
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).DetectedItemCount" ><strong>DETECTION_BASE.DetectedItemCount</strong></a>
</div>
</div>
@@ -20632,6 +20643,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).DetectedItemCount" ><strong>DETECTION_BASE.DetectedItemCount</strong></a>
</div>
</div>
@@ -22124,6 +22146,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).DetectedItemCount" ><strong>DETECTION_BASE.DetectedItemCount</strong></a>
</div>
</div>
+28
View File
@@ -1653,6 +1653,20 @@ 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">
#number
<a id="#(MOVEMENT).AliveUnits" ><strong>MOVEMENT.AliveUnits</strong></a>
<p> Contains the counter how many units are currently alive</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -1883,6 +1897,20 @@ 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">
#number
<a id="#(MOVEMENT).AliveUnits" ><strong>MOVEMENT.AliveUnits</strong></a>
<p> Contains the counter how many units are currently alive</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
+1 -1
View File
@@ -3792,7 +3792,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="##(RAT).skill">RAT.skill</a></p></td>
<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>
+42
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>
+22
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">
+22
View File
@@ -2380,6 +2380,17 @@ 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>
@@ -6892,6 +6903,17 @@ 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>
+4 -15
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>
+44
View File
@@ -2825,6 +2825,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 href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>
<a id="#(POSITIONABLE).Spot" ><strong>POSITIONABLE.Spot</strong></a>
</div>
</div>
@@ -5749,6 +5760,17 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>
<a id="#(POSITIONABLE).Spot" ><strong>POSITIONABLE.Spot</strong></a>
</div>
</div>
@@ -6288,6 +6310,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>
<a id="#(POSITIONABLE).Spot" ><strong>POSITIONABLE.Spot</strong></a>
</div>
</div>
@@ -6438,6 +6471,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a>
<a id="#(POSITIONABLE).Spot" ><strong>POSITIONABLE.Spot</strong></a>
</div>
</div>