From 12b06fe41aa4530821ed868ac95d9eba451edd01 Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Mon, 27 May 2019 12:40:46 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A.html | 44 ++++ Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 36 ++-- Documentation/AI.AI_Patrol.html | 12 ++ Documentation/Cargo.CargoUnit.html | 44 ++-- Documentation/Core.Fsm.html | 26 +-- Documentation/Core.Point.html | 39 ++++ Documentation/Core.Spawn.html | 190 ++++++------------ Documentation/Core.SpawnStatic.html | 30 +-- Documentation/Core.Spot.html | 132 ------------ Documentation/Functional.Designate.html | 55 +++++ Documentation/Functional.Movement.html | 28 +++ Documentation/Functional.Rat.html | 57 ------ Documentation/Functional.ZoneGoal.html | 42 ---- Documentation/Tasking.Task_Cargo.html | 6 +- .../Tasking.Task_Cargo_Dispatcher.html | 156 ++++++++++++-- Documentation/Wrapper.Group.html | 78 +------ Documentation/Wrapper.Positionable.html | 44 ---- 18 files changed, 437 insertions(+), 590 deletions(-) diff --git a/Documentation/AI.AI_A2A.html b/Documentation/AI.AI_A2A.html index 24ed52a30..b4d3ff5b6 100644 --- a/Documentation/AI.AI_A2A.html +++ b/Documentation/AI.AI_A2A.html @@ -2391,6 +2391,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -4959,6 +4970,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -5648,6 +5670,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
@@ -6975,6 +7008,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_A2A.IdleCount + + +
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 2a05dd101..11237e681 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2122,6 +2122,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

- @@ -5669,9 +5660,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/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index ad6e190c2..c476f71b6 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2636,6 +2636,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

This table contains the targets detected during patrol.

+ @@ -5883,6 +5886,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ @@ -6627,6 +6633,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ @@ -8009,6 +8018,9 @@ Note that this method is required, as triggers the next route when patrolling fo + +

This table contains the targets detected during patrol.

+ diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index b3d466d88..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 @@ -1320,17 +1331,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
@@ -2017,6 +2017,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ + +
+
+ + CARGO_UNIT.CargoInAir @@ -2032,17 +2043,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles -
- -
-
-
- - #number -CARGO_UNIT.RunCount - - -
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.Point.html b/Documentation/Core.Point.html index f135ce13d..15b9dce66 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -4154,6 +4154,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Coordinates.

+ @@ -9592,6 +9595,9 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t + +

Coordinates.

+ @@ -12275,6 +12281,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
@@ -13073,6 +13090,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
@@ -18445,6 +18473,17 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t

the y coordinate in meters.

+ + + +
+
+ + +POINT_VEC2.z + + +
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index c326b4557..9f367e132 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2214,24 +2214,6 @@ and any spaces before and after the resulting name are removed.

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

- - - -

SPAWN.livery_id

- - - - - -

SPAWN.skill

- - - - - -

SPAWN.uncontrolled

- - @@ -2762,6 +2744,9 @@ 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.

+ @@ -2955,6 +2940,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -2966,27 +2965,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
- - -
-
-
- - #string -SPAWN.SpawnInitSkill - - +

By default, no InitLimit

@@ -3008,7 +2988,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -3022,7 +3002,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3168,6 +3148,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -3218,39 +3209,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

-
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
@@ -7382,6 +7340,9 @@ 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.

+
@@ -7575,6 +7536,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -7586,27 +7561,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
- - -
-
-
- - #string -SPAWN.SpawnInitSkill - - +

By default, no InitLimit

@@ -7628,7 +7584,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- + #number SPAWN.SpawnMaxGroups @@ -7642,7 +7598,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- + #number SPAWN.SpawnMaxUnitsAlive @@ -7788,6 +7744,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + #boolean +SPAWN.SpawnUnControlled + + +
@@ -7838,39 +7805,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

-
- -
-
-
- - -SPAWN.livery_id - - - -
- -
-
-
- - -SPAWN.skill - - - -
- -
-
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 117f504cc..121a0b483 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1740,19 +1740,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -
-
-
- - -SPAWNSTATIC.CountryID + #number +SPAWNSTATIC.SpawnIndex @@ -2269,19 +2258,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -
-
-
- - -SPAWNSTATIC.CountryID + #number +SPAWNSTATIC.SpawnIndex 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 35d02144e..aa22a08cf 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2922,6 +2922,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
@@ -6079,6 +6090,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -6878,6 +6900,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -7647,6 +7680,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
@@ -9054,6 +9098,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index 98ff88773..7aef91696 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1653,6 +1653,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

+ +
+ +
@@ -1883,6 +1897,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 a31aae459..df099abd9 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -2939,12 +2939,6 @@ manager:Stop(7200)

RAT.termtype

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

- - - -

RAT.type

- - @@ -3783,24 +3777,6 @@ and any spaces before and after the resulting name are removed.

RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

- - - -

RAT.livery_id

- - - - - -

RAT.skill

- - - - - -

RAT.uncontrolled

- - @@ -5946,17 +5922,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 - - -
@@ -13738,17 +13703,6 @@ Initializes the ratcraft array and group menu.

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

-
- -
-
-
- - -RAT.type - - -
@@ -18974,17 +18928,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/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 725deec17..5d593eaa5 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1956,20 +1956,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -ZONE_GOAL.SmokeTime - - - - -

self.SmokeColor = nil

-
@@ -2099,20 +2085,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -ZONE_GOAL.SmokeTime - - - - -

self.SmokeColor = nil

-
@@ -3352,20 +3324,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -ZONE_GOAL.SmokeTime - - - - -

self.SmokeColor = nil

-
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index 14c06cd7c..9350dc897 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2726,7 +2726,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4102,7 +4102,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -8521,7 +8521,7 @@ If the Unit is part of the Task, true is returned.

- #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index b31c25d4a..09693ebc3 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,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -3669,8 +3702,8 @@ This method can only be used once!

+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4527,8 +4593,8 @@ This method can only be used once!

+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #table +TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5766,8 +5865,8 @@ This method can only be used once!

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

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

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

- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone 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.

-
- -
-