From 31b6da3616fc08658b86e2ce6fc43740bd1e219c Mon Sep 17 00:00:00 2001 From: FlightControl-User Date: Wed, 14 Nov 2018 19:21:50 +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 | 12 ++ Documentation/Cargo.CargoGroup.html | 28 ++++ Documentation/Cargo.CargoUnit.html | 44 +++--- Documentation/Core.Fsm.html | 22 +++ Documentation/Core.Point.html | 33 ----- Documentation/Core.Settings.html | 8 +- Documentation/Core.Spawn.html | 86 +++++++----- Documentation/Core.SpawnStatic.html | 66 --------- Documentation/Core.Spot.html | 132 ++++++++++++++++++ Documentation/Functional.Designate.html | 55 ++++++++ Documentation/Functional.Detection.html | 72 +--------- Documentation/Functional.Rat.html | 39 ------ .../Functional.ZoneCaptureCoalition.html | 39 ++++++ Documentation/Functional.ZoneGoal.html | 42 ++++++ Documentation/Tasking.Task_Cargo.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 44 ++++++ Documentation/Wrapper.Static.html | 100 +++++++++++++ 19 files changed, 604 insertions(+), 283 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 483bca1a5..1e105b17a 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 c3c2603a3..bf4c59bf5 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2191,6 +2191,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

+
@@ -5648,6 +5657,9 @@ 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 dc181768b..d3ca4eade 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1427,6 +1427,20 @@ which are excellent tools to be reused in an OO environment!.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup @@ -2759,6 +2773,20 @@ 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 9053b3d08..b3d466d88 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1305,17 +1305,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -1331,6 +1320,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles +
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2017,17 +2017,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -2043,6 +2032,17 @@ 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 5c2852433..e9678267e 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -4836,6 +4836,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ + +
+
+ + +FSM.current + + +
@@ -6152,6 +6163,17 @@ 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 51b4db22e..f135ce13d 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -12275,17 +12275,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

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

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -18467,17 +18445,6 @@ 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.Settings.html b/Documentation/Core.Settings.html index 3a7a11128..ba13b2a78 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2120,7 +2120,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2ASystem @@ -2131,7 +2131,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -4005,7 +4005,7 @@ It is advised to use this method at the start of the mission.

- #string + SETTINGS.A2ASystem @@ -4016,7 +4016,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 5c66309ce..57e6c7aa5 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2744,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.

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

Overwrite unit names by default with group name.

+
- #string -SPAWN.SpawnInitSkill + #boolean +SPAWN.SpawnInitLimit + + + + +

By default, no InitLimit

+ +
+ +
+
+
+ + +SPAWN.SpawnInitLivery @@ -2979,7 +2999,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -2993,7 +3013,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -3139,17 +3159,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -3162,7 +3171,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.

@@ -7331,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.

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

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

Overwrite unit names by default with group name.

+
- #string -SPAWN.SpawnInitSkill + #boolean +SPAWN.SpawnInitLimit + + + + +

By default, no InitLimit

+ +
+ +
+
+
+ + +SPAWN.SpawnInitLivery @@ -7566,7 +7595,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -7749,7 +7767,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/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index bf51601a5..88821384b 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1734,39 +1734,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWNSTATIC.CoalitionID - - - -
- -
-
-
- - -SPAWNSTATIC.CountryID - - - -
- -
-
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
@@ -2274,39 +2241,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWNSTATIC.CoalitionID - - - -
- -
-
-
- - -SPAWNSTATIC.CountryID - - - -
- -
-
-
- - #number -SPAWNSTATIC.SpawnIndex - - -
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index f5e56447c..e72eb76e2 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2139,6 +2139,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -3070,6 +3114,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + + +
+ +
+
+
+ + +SPOT.Target + + +
@@ -4309,6 +4397,50 @@ 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 aa22a08cf..d00ce2c67 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2944,6 +2944,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6112,6 +6123,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -6922,6 +6944,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -7702,6 +7735,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
@@ -9120,6 +9164,17 @@ Designate:SetFlashStatusMenu( false ) + + + +
+
+ + #table +DESIGNATE.LaserCodes + + +
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 667211c28..dc195281d 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -16311,28 +16311,6 @@ BASE:TraceOnOff( false ) - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -16471,7 +16449,7 @@ BASE:TraceOnOff( false )
- #number + DETECTION_BASE.RefreshTimeInterval @@ -20643,28 +20621,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -20803,7 +20759,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval @@ -22146,28 +22102,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -22306,7 +22240,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index a4cab81af..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

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

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

- - - -
-
- - -RAT.type - - -
@@ -18956,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.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index 6ca4b4f7f..2e9972553 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -1615,6 +1615,12 @@ We start the monitoring after 5 seconds, and will repeat every 30 seconds a chec

ZONE_CAPTURE_COALITION:OnBeforeGuard(From, Event, To)

Guard Handler OnBefore for ZONE_CAPTURE_COALITION

+ + + +

ZONE_CAPTURE_COALITION:OnEventHit(EventData)

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

ZONE_CAPTURE_COALITION:OnEventHit(EventData)

+
+ + + +
+
+

Defined in:

+
+

ZONE_CAPTURE_COALITION

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The event data.

+ +
+
+
+
diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index 5d593eaa5..725deec17 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1956,6 +1956,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +ZONE_GOAL.SmokeTime + + + + +

self.SmokeColor = nil

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

self.SmokeColor = nil

+
@@ -3324,6 +3352,20 @@ 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 9350dc897..d209dd33d 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -2678,22 +2678,11 @@ based on the tasking capabilities defined in
- Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
- - -
-
- - -FSM_PROCESS.DeployZone - - -
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 851da258c..e863c7ca0 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2650,6 +2650,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +TASK_CARGO_DISPATCHER.MaxCSAR + + +
@@ -3773,6 +3784,17 @@ This method can only be used once!

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

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

+ + + +
+
+ + +TASK_CARGO_DISPATCHER.MaxCSAR + + +
diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index 3ace2633e..43574379a 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -1215,6 +1215,18 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur

STATIC:GetUnits()

Returns a list of one Static.

+ + + +

STATIC:IsInZone(Zone)

+ +

Returns true if the unit is within a Zone.

+ + + +

STATIC:IsNotInZone(Zone)

+ +

Returns true if the unit is not within a Zone.

@@ -2530,6 +2542,94 @@ Ship:Destroy( false ) -- Don't generate an event upon destruction. + + + +
+ +
+

STATIC:IsInZone(Zone)

+
+ +

Returns true if the unit is within a Zone.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameter:

+
+
+

+ Core.Zone#ZONE_BASE + Zone +

+
+
+ +

The zone to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Returns true if the unit is within the Core.Zone#ZONE_BASE

+ +
+
+
+ +
+
+ +
+ +
+

STATIC:IsNotInZone(Zone)

+
+ +

Returns true if the unit is not within a Zone.

+ +
+
+

Defined in:

+
+

STATIC

+
+

Parameter:

+
+
+

+ Core.Zone#ZONE_BASE + Zone +

+
+
+ +

The zone to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Returns true if the unit is not within the Core.Zone#ZONE_BASE

+ +
+
+
+