From 6b93da0935089ad0613ceae463becc7c9098d9ab Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 14 Nov 2018 19:06:48 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 68 +++--- Documentation/Cargo.CargoGroup.html | 28 --- Documentation/Cargo.CargoUnit.html | 22 ++ Documentation/Core.Fsm.html | 26 +-- Documentation/Core.Settings.html | 30 ++- Documentation/Core.Spawn.html | 28 +-- Documentation/Core.Spot.html | 132 ------------ Documentation/Functional.Designate.html | 59 +++++- Documentation/Functional.Detection.html | 72 ++++++- Documentation/Functional.Movement.html | 28 --- Documentation/Tasking.Task_Cargo.html | 11 + .../Tasking.Task_Cargo_Dispatcher.html | 200 ++++++++++++++++-- Documentation/Wrapper.Group.html | 78 ++++++- Documentation/Wrapper.Positionable.html | 44 ---- 15 files changed, 503 insertions(+), 331 deletions(-) diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 1e105b17a..483bca1a5 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2127,7 +2127,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4065,7 +4065,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -4677,7 +4677,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier @@ -5927,7 +5927,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index dac20058e..c3c2603a3 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2114,6 +2114,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -2155,9 +2166,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

-
@@ -2183,9 +2191,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

-
@@ -3654,6 +3659,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -3695,9 +3711,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

-
@@ -3723,9 +3736,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

-
@@ -4286,6 +4296,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -4327,9 +4348,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

-
@@ -4355,9 +4373,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

-
@@ -5556,6 +5571,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -5597,9 +5623,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a depoly mission.

-
@@ -5625,9 +5648,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Aircraft is on a pickup mission.

-
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index d3ca4eade..dc181768b 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,20 +1427,6 @@ which are excellent tools to be reused in an OO environment!.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup @@ -2773,20 +2759,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index c9d544d0c..9053b3d08 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1305,6 +1305,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2006,6 +2017,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 8fa4351b6..5c2852433 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -4820,7 +4820,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -4836,17 +4836,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -FSM.current - - -
@@ -6147,7 +6136,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -6163,17 +6152,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -FSM.current - - -
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index b432910d2..3a7a11128 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2131,7 +2131,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2GSystem @@ -2164,11 +2164,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -4005,7 +4016,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2GSystem @@ -4038,11 +4049,22 @@ It is advised to use this method at the start of the mission.

- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index f18b8b2ab..5c66309ce 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2744,9 +2744,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

-
@@ -2947,21 +2944,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + #string +SPAWN.SpawnInitSkill @@ -3168,7 +3162,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

@@ -7337,9 +7331,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

-
@@ -7540,21 +7531,18 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

#boolean -SPAWN.SpawnInitKeepUnitNames +SPAWN.SpawnInitLimit - -

Overwrite unit names by default with group name.

-
- #boolean -SPAWN.SpawnInitLimit + #string +SPAWN.SpawnInitSkill @@ -7761,7 +7749,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

+

When the first Spawn executes, all the Groups need to be made visible before start.

diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index e72eb76e2..f5e56447c 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2139,50 +2139,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -3114,50 +3070,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -4397,50 +4309,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index adb16839b..aa22a08cf 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -1431,9 +1431,9 @@ Use the method DESIGNATE.SetMission() to

  • The status report can be automatically flashed by selecting "Status" -> "Flash Status On".

  • The automatic flashing of the status report can be deactivated by selecting "Status" -> "Flash Status Off".

  • The flashing of the status menu is disabled by default.

    • -

  • The method DESIGNATE.FlashStatusMenu() can be used to enable or disable to flashing of the status menu.

    +

  • The method DESIGNATE.SetFlashStatusMenu() can be used to enable or disable to flashing of the status menu.

    -

    Designate:FlashStatusMenu( true )

    • +

    Designate:SetFlashStatusMenu( true )

    The example will activate the flashing of the status menu for this Designate object.

    @@ -2922,6 +2922,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +DESIGNATE.LaseDuration + + +
    @@ -6079,6 +6090,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
    +
    + + +DESIGNATE.LaseDuration + + +
    @@ -6878,6 +6900,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
    +
    + + +DESIGNATE.LaseDuration + + +
    @@ -7647,6 +7680,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
    +
    + + +DESIGNATE.LaseDuration + + +
    @@ -9054,6 +9098,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
    +
    + + +DESIGNATE.LaseDuration + + +
    diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index dc195281d..667211c28 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,6 +16311,28 @@ BASE:TraceOnOff( false ) + + + +
    +
    + + #number +DETECTION_BASE.DetectedItemCount + + + +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemMax + + +
    @@ -16449,7 +16471,7 @@ BASE:TraceOnOff( false )
    - + #number DETECTION_BASE.RefreshTimeInterval @@ -20621,6 +20643,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemCount + + + +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemMax + + +
    @@ -20759,7 +20803,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    - + #number DETECTION_BASE.RefreshTimeInterval @@ -22102,6 +22146,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemCount + + + +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemMax + + +
    @@ -22240,7 +22306,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    - + #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 7aef91696..98ff88773 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1653,20 +1653,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Field(s)

    -
    -
    - - #number -MOVEMENT.AliveUnits - - - - -

    Contains the counter how many units are currently alive

    - -
    - -
    @@ -1897,20 +1883,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Field(s)

    -
    -
    - - #number -MOVEMENT.AliveUnits - - - - -

    Contains the counter how many units are currently alive

    - -
    - -
    diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 54a43fd80..9350dc897 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2683,6 +2683,17 @@ based on the tasking capabilities defined in + +
    + diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index b31c25d4a..851da258c 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2590,8 +2590,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -2602,7 +2602,51 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
    + +
    + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    +
    +
    + + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
    + +
    +
    +
    + + +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3669,8 +3713,8 @@ This method can only be used once!

    - #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -3681,7 +3725,51 @@ This method can only be used once!

    -TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
    + +
    + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    +
    +
    + + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
    + +
    +
    +
    + + +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4527,8 +4615,8 @@ This method can only be used once!

    - #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -4539,7 +4627,51 @@ This method can only be used once!

    -TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
    + +
    + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    +
    +
    + + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
    + +
    +
    +
    + + +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5766,8 +5898,8 @@ This method can only be used once!

    - #table -TASK_CARGO_DISPATCHER.DefaultDeployZones + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -5778,7 +5910,51 @@ This method can only be used once!

    -TASK_CARGO_DISPATCHER.MaxCSAR +TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
    + +
    + +
    +
    + + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
    + +
    +
    +
    + + #number +TASK_CARGO_DISPATCHER.CountCSAR + + + +
    + +
    +
    +
    + + +TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 9515cbf39..3218c622e 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -3602,7 +3602,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -6944,7 +6955,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -12730,7 +12752,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -15698,7 +15731,18 @@ Coordinates are dependent on the position of the maps origin.

    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -16281,7 +16325,18 @@ If the Identifiable is alive, true is returned.

    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter @@ -16475,7 +16530,18 @@ If the Identifiable is alive, true is returned.

    -GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
    + +
    +
    +
    + + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 0a5f6b76b..5cd706425 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -2825,17 +2825,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
    - -
    - @@ -5760,17 +5749,6 @@ Coordinates are dependent on the position of the maps origin.

    -
    - -
    - @@ -6310,17 +6288,6 @@ If the Identifiable is alive, true is returned.

    -
    - -
    - @@ -6471,17 +6438,6 @@ If the Identifiable is alive, true is returned.

    -
    - -
    -