From 806818f25bf505f64a9ed4213cf7eb8c150ba1ef Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Fri, 11 Jun 2021 11:43:46 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_Air_Squadron.html | 22 +++++ Documentation/AI.AI_Cargo.html | 8 +- Documentation/Cargo.CargoGroup.html | 6 -- Documentation/Cargo.CargoUnit.html | 44 +++++----- Documentation/Core.Fsm.html | 4 +- Documentation/Core.Settings.html | 26 +----- Documentation/Core.Spawn.html | 76 +++++++++------- Documentation/Functional.Designate.html | 30 +++---- Documentation/Functional.Detection.html | 66 -------------- Documentation/Functional.Movement.html | 28 ++++++ Documentation/Functional.Rat.html | 41 +-------- Documentation/Ops.Airboss.html | 86 ------------------- Documentation/Tasking.Task.html | 22 +++++ Documentation/Tasking.Task_Cargo.html | 2 +- .../Tasking.Task_Cargo_Dispatcher.html | 44 ---------- Documentation/Wrapper.Client.html | 14 +-- Documentation/Wrapper.Positionable.html | 44 ++++++++++ 17 files changed, 217 insertions(+), 346 deletions(-) diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 4f8351e74..c2310f6fa 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2372,6 +2372,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +AI_AIR_SQUADRON.ResourceCount + + +
@@ -3443,6 +3454,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +AI_AIR_SQUADRON.ResourceCount + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index bdc9d6f83..61969b6c9 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2568,7 +2568,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4598,7 +4598,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5210,7 +5210,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -6714,7 +6714,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/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index b212a54df..def570c80 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1772,9 +1772,6 @@ Controls a network of short range air/missile defense groups.

- -

Then we register the new group in the database

-
@@ -3093,9 +3090,6 @@ This works for ground only groups.

- -

Then we register the new group in the database

-
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index b346f9fd0..9ebe2d23b 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1632,6 +1632,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -1650,17 +1661,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

-
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2347,6 +2347,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2365,17 +2376,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

-
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 82c46946d..b745585a4 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5590,7 +5590,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7193,7 +7193,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 644089dea..d7ea24149 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2649,7 +2649,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2709,17 +2709,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -4751,7 +4740,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -4811,17 +4800,6 @@ It is advised to use this method at the start of the mission.

-
- -
-
-
- - -SETTINGS.PlayerMenu - - -
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index a604a533b..80531dd1e 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3302,9 +3302,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.

-
@@ -3396,6 +3393,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3432,17 +3440,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnInitAirbase - - -
@@ -3589,6 +3586,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -3803,7 +3811,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

+

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

@@ -8685,9 +8693,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.

- @@ -8779,6 +8784,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -8815,17 +8831,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.SpawnInitAirbase - - -
@@ -8972,6 +8977,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+

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

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 9482e9886..f2c668f5e 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3364,7 +3364,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -3374,8 +3374,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -6532,7 +6532,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -6542,8 +6542,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -7342,7 +7342,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -7352,8 +7352,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -8122,7 +8122,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -8132,8 +8132,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes @@ -9794,7 +9794,7 @@ Designate:SetFlashStatusMenu( false )
-DESIGNATE.LaseDuration +DESIGNATE.LaseStart @@ -9804,8 +9804,8 @@ Designate:SetFlashStatusMenu( false )
- -DESIGNATE.LaseStart + #table +DESIGNATE.LaserCodes diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 001f68ab1..0e6ca4875 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18709,17 +18709,6 @@ BASE:TraceOnOff( false ) -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - -
@@ -18880,18 +18869,7 @@ BASE:TraceOnOff( false )
- #boolean -DETECTION_BASE.Locking - - -
- -
-
-
- - #number DETECTION_BASE.RefreshTimeInterval @@ -23433,17 +23411,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - -
@@ -23604,18 +23571,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #boolean -DETECTION_BASE.Locking - - -
- -
-
-
- - #number DETECTION_BASE.RefreshTimeInterval @@ -25212,17 +25168,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - -
@@ -25383,18 +25328,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #boolean -DETECTION_BASE.Locking - - -
- -
-
-
- - #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 03dc28cc9..b780bcc21 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -2082,6 +2082,20 @@ 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

+ +
+ +
@@ -2312,6 +2326,20 @@ 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/Functional.Rat.html b/Documentation/Functional.Rat.html index a3248e67e..3e68c0dc7 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -1743,6 +1743,8 @@ minimum number of RAT aircraft of that object, which are alive at all time.

If desired, the #RATMANAGER can be stopped by the RATMANAGER.Stop(stoptime) function. The parameter "stoptime" specifies the time delay in seconds after which the manager stops. When this happens, no new aircraft will be spawned and the population will eventually decrease to zero.

+

When you are using a time intervall like RATMANAGER.dTspawn(delay), #RATMANAGER will ignore the amount set with RATMANAGER.New(). RATMANAGER.dTspawn(delay) will spawn infinite groups.

+

Example

In this example, three different #RAT objects are created (but not spawned manually). The #RATMANAGER takes care that at least five aircraft of each type are alive and that the total number of aircraft spawned is 25. The #RATMANAGER is started after 30 seconds and stopped after two hours.

@@ -3290,12 +3292,6 @@ manager:Stop(7200)

RAT.termtype

Type of terminal to be used when spawning at an airbase.

- - - -

RAT.type

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

Type of terminal to be used when spawning at an airbase.

-
- -
-
-
- - -RAT.type - - -
@@ -14524,17 +14509,6 @@ Initializes the ratcraft array and group menu.

Type of terminal to be used when spawning at an airbase.

-
- -
-
-
- - -RAT.type - - -
@@ -20470,17 +20444,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Type of terminal to be used when spawning at an airbase.

-
- -
-
-
- - -RAT.type - - -
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index eb9cca6b5..670a87c82 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -8962,17 +8962,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -8984,17 +8973,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -27946,17 +27924,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -27968,17 +27935,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -30891,17 +30847,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -30913,17 +30858,6 @@ If removed flight is the section lead, we try to find a new leader.

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -38135,20 +38069,6 @@ BASE:TraceOnOff( false )
- -
-
- - -AIRBOSS.PlayerData.flag - - - - -

Also decrease flag for section members of flight.

- -
-
@@ -38282,9 +38202,6 @@ BASE:TraceOnOff( false ) - -

Set section lead of player flight.

-
@@ -38329,9 +38246,6 @@ BASE:TraceOnOff( false ) - -

Set new time stamp.

- diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index b731009ae..5262cb347 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2754,6 +2754,17 @@ but can separately be modified later in your mission using the + + + +
+
+ + +TASK.TaskControlMenu + + +
@@ -7390,6 +7401,17 @@ If the Unit is part of the Task, true is returned.

+ + + +
+
+ + +TASK.TaskControlMenu + + +
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 348173779..7ed94f2b7 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3047,7 +3047,7 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index a6530742e..16836abe0 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3074,17 +3074,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -4197,17 +4186,6 @@ This method can only be used once!

- - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -5099,17 +5077,6 @@ This method can only be used once!

- - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -6636,17 +6603,6 @@ This method can only be used once!

- - - -
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 4dac97630..9ed36eabd 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4148,7 +4148,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

@@ -5262,7 +5262,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

@@ -7452,7 +7452,7 @@ If the Unit is alive but not active, false is returned.

-

Alive2.

+

Alive.

@@ -16000,7 +16000,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of -

Alive2.

+

Alive.

@@ -19484,7 +19484,7 @@ Coordinates are dependent on the position of the maps origin.

-

Alive2.

+

Alive.

@@ -20158,7 +20158,7 @@ If the Identifiable is alive, true is returned.

-

Alive2.

+

Alive.

@@ -20438,7 +20438,7 @@ If the Identifiable is alive, true is returned.

-

Alive2.

+

Alive.

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 90ca3e806..428477e07 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3445,6 +3445,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +
@@ -6832,6 +6843,17 @@ Coordinates are dependent on the position of the maps origin.

+ + + +
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +
@@ -7409,6 +7431,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +
@@ -7592,6 +7625,17 @@ If the Identifiable is alive, true is returned.

+ + + +
+
+ + Core.Spot#SPOT +POSITIONABLE.Spot + + +