From 8525602b01ca909d542257436e788283aa538a0d Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Wed, 14 Jul 2021 06:49:18 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 + Documentation/AI.AI_Air.html | 44 + Documentation/AI.AI_Air_Squadron.html | 22 - Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 12 + Documentation/Cargo.CargoCrate.html | 22 - Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 33 + Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 136 +- Documentation/Functional.Detection.html | 99 - Documentation/Functional.Mantis.html | 1945 +++++++++++++++-- Documentation/Functional.Rat.html | 6 +- Documentation/Ops.Airboss.html | 19 +- Documentation/Ops.CSAR.html | 216 +- Documentation/Ops.CTLD.html | 359 +-- Documentation/Tasking.Task_Cargo.html | 17 +- .../Tasking.Task_Cargo_Dispatcher.html | 184 +- Documentation/Utils.html | 144 ++ Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +- Documentation/Wrapper.Marker.html | 66 - Documentation/Wrapper.Positionable.html | 44 + 23 files changed, 2524 insertions(+), 1018 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index ca8200e0e..4b83d84df 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4645,6 +4645,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -12988,6 +12999,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -14305,6 +14327,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -15928,6 +15961,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index fad2a2766..eef7d7bd6 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2935,6 +2935,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5679,6 +5690,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -6404,6 +6426,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -8021,6 +8054,17 @@ Once the time is finished, the old AI will return to the base.

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 3feb81be6..5a6615cbd 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2438,17 +2438,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3520,17 +3509,6 @@ 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 9a6ee64ea..ccd5a824a 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2634,7 +2634,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4664,7 +4664,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5276,7 +5276,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -6780,7 +6780,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 c3e773592..992ee84bf 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2693,6 +2693,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

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

Aircraft is on a pickup mission.

+
@@ -6639,6 +6648,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.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index fbe56f816..04f9de5a5 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1749,17 +1749,6 @@ Controls a network of short range air/missile defense groups.

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
@@ -2428,17 +2417,6 @@ Controls a network of short range air/missile defense groups.

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index dfd769aeb..14a66da33 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5656,7 +5656,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7259,7 +7259,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index c8fec6ba4..68be40160 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -16157,6 +16157,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
@@ -16955,6 +16966,17 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
@@ -24678,6 +24700,17 @@ Creates a line on the F10 map from one point to another.

the y coordinate in meters.

+
+ +
+
+
+ + +POINT_VEC2.z + + +
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 92a475b44..25b381a70 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2715,7 +2715,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2775,17 +2775,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -4820,7 +4809,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -4880,17 +4869,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 a1991f9b6..dd6d1fa49 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2733,13 +2733,13 @@ and any spaces before and after the resulting name are removed.

-

SPAWN.communication

+

SPAWN.frequency

-

SPAWN.frequency

+

SPAWN.livery_id

@@ -2751,7 +2751,7 @@ and any spaces before and after the resulting name are removed.

-

SPAWN.skill

+

SPAWN.uncontrolled

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

-
@@ -3444,20 +3441,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -3480,6 +3463,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -3640,20 +3634,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

By default, no InitLimit

- - - - -
-
- - -SPAWN.SpawnInitLivery - - -
@@ -3665,6 +3645,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -3696,7 +3687,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3710,7 +3701,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -3879,7 +3870,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.

@@ -3938,7 +3929,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.communication +SPAWN.frequency @@ -3949,7 +3940,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.frequency +SPAWN.livery_id @@ -3971,7 +3962,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.skill +SPAWN.uncontrolled @@ -8794,9 +8785,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.

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

- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

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

+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -9048,20 +9033,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

- -
- -
-
-
- - -SPAWN.SpawnInitLivery - - -
@@ -9073,6 +9044,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- #number + SPAWN.SpawnMaxUnitsAlive @@ -9287,7 +9269,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.

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

-SPAWN.communication +SPAWN.frequency @@ -9357,7 +9339,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.frequency +SPAWN.livery_id @@ -9379,7 +9361,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.skill +SPAWN.uncontrolled diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 680777846..fdfb70aa0 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18775,28 +18775,6 @@ BASE:TraceOnOff( false ) -
- - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -18940,17 +18918,6 @@ BASE:TraceOnOff( false ) - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -23499,28 +23466,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -23664,17 +23609,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -25278,28 +25212,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -25443,17 +25355,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 97b0ca345..6c8ab98c7 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1647,54 +1647,6 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% - - - -
- - - - - -

Global _MANTISAwacs

 - -
-
-
-
- - -_MANTISAwacs - - - - -

[internal] Grouping detected objects to 5000m zones

- -
- -
-
- - - - - -

Global _MANTISdetection

 - -
-
-
-
- - -_MANTISdetection - - - - -

[internal] Grouping detected objects to 5000m zones

-
@@ -1732,12 +1684,18 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS.Adv_EWR_Group

The EWR #SET_GROUP used for advanced mode

+ + + +

MANTIS.AdvancedState

+ +

MANTIS:CheckObjectInZone(dectset, samcoordinate)

-

(Internal) Function to check if any object is in the given SAM zone

+

[Internal] Function to check if any object is in the given SAM zone

@@ -1792,36 +1750,42 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS.HQ_Template_CC

The ME name of the HQ object

- - - -

MANTIS.MantisATimer

- - - - - -

MANTIS.MantisAdvTimer

- - - - - -

MANTIS.MantisReloTimer

- - - - - -

MANTIS.MantisTimer

- -

MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic, awacs, EmOnOff)

Function to instantiate a new object of class MANTIS

+ + + +

MANTIS:OnAfterAdvStateChange(From, Event, To, Oldstate, Newstate, Interval)

+ +

On After "AdvStateChange" event.

+ + + +

MANTIS:OnAfterGreenState(From, Event, To, Group)

+ +

On After "GreenState" event.

+ + + +

MANTIS:OnAfterRedState(From, Event, To, Group)

+ +

On After "RedState" event.

+ + + +

MANTIS:OnAfterRelocating(From, Event, To)

+ +

On After "Relocating" event.

+ + + +

MANTIS:OnAfterShoradActivated(From, Event, To, Name, Radius, Ontime)

+ +

On After "ShoradActivated" event.

@@ -1917,7 +1881,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:SetSAMStartState()

-

(Internal) Function to set the SAM start state

+

[Internal] Function to set the SAM start state

@@ -1953,25 +1917,31 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:Start()

-

Function to set the SAM start state

+

Triggers the FSM event "Start".

MANTIS:StartAwacsDetection()

-

(Internal) Function to start the detection via AWACS if defined as separate

+

[Internal] Function to start the detection via AWACS if defined as separate

MANTIS:StartDetection()

-

(Internal) Function to start the detection via EWR groups

+

[Internal] Function to start the detection via EWR groups

-

MANTIS:Stop()

+

MANTIS:Status()

-

Function to stop MANTIS

+

Triggers the FSM event "Status".

+ + + +

MANTIS.TimeStamp

+ + @@ -1981,9 +1951,21 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% -

MANTIS:_CheckAdvState()

+

MANTIS:_CalcAdvState()

[Internal] Function to determine state of the advanced mode

+ + + +

MANTIS:_Check(detection)

+ +

[Internal] Check detection function

+ + + +

MANTIS:_CheckAdvState()

+ +

[Internal] Check advanced state

@@ -2001,13 +1983,19 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:_GetSAMTable()

-

[internal] Function to get the self.SAM_Table

+

[Internal] Function to get the self.SAM_Table

MANTIS:_RefreshSAMTable()

-

(Internal) Function to update SAM table and SEAD state

+

[Internal] Function to update SAM table and SEAD state

+ + + +

MANTIS:_Relocate()

+ +

[Internal] Relocation relay function

@@ -2019,7 +2007,25 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:_SetSAMTable(table)

-

[internal] Function to set the self.SAM_Table

+

[Internal] Function to set the self.SAM_Table

+ + + +

MANTIS:__Start(delay)

+ +

Triggers the FSM event "Start" after a delay.

+ + + +

MANTIS:__Status(delay)

+ +

Triggers the FSM event "Status" after a delay.

+ + + +

MANTIS:__Stop(delay)

+ +

Triggers the FSM event "Stop" after a delay.

@@ -2122,6 +2128,72 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS.name

Name of this Mantis

+ + + +

MANTIS:onafterAdvStateChange(From, Event, To, Oldstate, Newstate, Interval)

+ +

[Internal] Function triggered by Event AdvStateChange

+ + + +

MANTIS:onafterGreenState(From, Event, To, Group)

+ +

[Internal] Function triggered by Event GreenState

+ + + +

MANTIS:onafterRedState(From, Event, To, Group)

+ +

[Internal] Function triggered by Event RedState

+ + + +

MANTIS:onafterRelocating(From, Event, To)

+ +

[Internal] Function triggered by Event Relocating

+ + + +

MANTIS:onafterShoradActivated(From, Event, To, Name, Radius, Ontime)

+ +

[Internal] Function triggered by Event ShoradActivated

+ + + +

MANTIS:onafterStart(From, Event, To)

+ +

[Internal] Function to set start state

+ + + +

MANTIS:onafterStatus(From, Event, To)

+ +

[Internal] Status function for MANTIS

+ + + +

MANTIS:onafterStop(From, Event, To)

+ +

[Internal] Function to stop MANTIS

+ + + +

MANTIS:onbeforeStatus(From, Event, To)

+ +

[Internal] Before status function for MANTIS

+ + + +

MANTIS.relointerval

+ + + + + +

MANTIS.state2flag

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

MANTIS:onEvent(event)

+ + + + + +

Type MANTIS.AdvancedState

+
+ MANTIS.AdvancedState +
+
+ + + + + + + + + + + + + + + +
Fields and Methods inherited from MANTIS.AdvancedStateDescription

MANTIS.AdvancedState.AMBER

 + +

MANTIS.AdvancedState.GREEN

 + +

MANTIS.AdvancedState.RED

 +
@@ -2699,10 +2802,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ Core.Set#SET_GROUP +MANTIS.Adv_EWR_Group -MANTIS.AWACS_Prefix - - +

The EWR #SET_GROUP used for advanced mode

@@ -2710,10 +2813,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Core.Set#SET_GROUP -MANTIS.Adv_EWR_Group + #MANTIS.AdvancedState +MANTIS.AdvancedState -

The EWR #SET_GROUP used for advanced mode

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

The ME name of the HQ object

-
- -
-
-
- - -MANTIS.MantisATimer - - - -
- -
-
-
- - -MANTIS.MantisAdvTimer - - - -
- -
-
-
- - -MANTIS.MantisReloTimer - - - -
- -
-
-
- - -MANTIS.MantisTimer - - -
@@ -2902,6 +2961,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Timer in seconds, how long #SHORAD will be active after a detection inside of the defense range

+
+ + +
+
+ + +MANTIS.TimeStamp + + +
@@ -3089,6 +3159,31 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of this Mantis

+ + + +
+
+ + +MANTIS.relointerval + + + + +

random between 30 and 60 mins

+ +
+ +
+
+
+ + #boolean +MANTIS.state2flag + + +
@@ -3172,7 +3267,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

MANTIS:CheckObjectInZone(dectset, samcoordinate)

-

(Internal) Function to check if any object is in the given SAM zone

+

[Internal] Function to check if any object is in the given SAM zone

@@ -3197,12 +3292,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

+ Core.Point#COORDINATE samcoordinate

-

Core.Point#COORDINATE Coordinate object.

+

Coordinate object.

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

MANTIS:OnAfterAdvStateChange(From, Event, To, Oldstate, Newstate, Interval)

+
+ +

On After "AdvStateChange" event.

+ + +

Advanced state changed, influencing detection speed.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ #number + Oldstate +

+
+
+ +

Old state - 0 = green, 1 = amber, 2 = red

+ +
+
+
+
+

+ #number + Newstate +

+
+
+ +

New state - 0 = green, 1 = amber, 2 = red

+ +
+
+
+
+

+ #number + Interval +

+
+
+ +

Calculated detection interval based on state and advanced feature setting

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:OnAfterGreenState(From, Event, To, Group)

+
+ +

On After "GreenState" event.

+ + +

A SAM group was switched to GREEN alert.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ Wrapper.Group#GROUP + Group +

+
+
+ +

The GROUP object whose state was changed

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:OnAfterRedState(From, Event, To, Group)

+
+ +

On After "RedState" event.

+ + +

A SAM group was switched to RED alert.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ Wrapper.Group#GROUP + Group +

+
+
+ +

The GROUP object whose state was changed

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:OnAfterRelocating(From, Event, To)

+
+ +

On After "Relocating" event.

+ + +

HQ and/or EWR moved.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:OnAfterShoradActivated(From, Event, To, Name, Radius, Ontime)

+
+ +

On After "ShoradActivated" event.

+ + +

Mantis has activated a SHORAD.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

Name of the GROUP which SHORAD shall protect

+ +
+
+
+
+

+ #number + Radius +

+
+
+ +

Radius around the named group to find SHORAD groups

+ +
+
+
+
+

+ #number + Ontime +

+
+
+ +

Seconds the SHORAD will stay active

+ +
+
+
+
@@ -3880,7 +4434,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:SetSAMStartState()

-

(Internal) Function to set the SAM start state

+

[Internal] Function to set the SAM start state

@@ -3943,7 +4497,10 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:Start()

-

Function to set the SAM start state

+

Triggers the FSM event "Start".

+ + +

Starts the MANTIS. Initializes parameters and starts event handlers.

@@ -3951,17 +4508,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS

-

Return value:

-
-
-

#MANTIS:

-
-
- -

self

- -
-
@@ -3973,7 +4519,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:StartAwacsDetection()

-

(Internal) Function to start the detection via AWACS if defined as separate

+

[Internal] Function to start the detection via AWACS if defined as separate

@@ -4003,7 +4549,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:StartDetection()

-

(Internal) Function to start the detection via EWR groups

+

[Internal] Function to start the detection via EWR groups

@@ -4030,28 +4576,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-

MANTIS:Stop()

+

MANTIS:Status()

-

Function to stop MANTIS

+

Triggers the FSM event "Status".

-
+

Defined in:

MANTIS

-

Return value:

-
-
-

#MANTIS:

-
-
- -

self

- -
-
@@ -4060,12 +4595,12 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
-

MANTIS:_CheckAdvState()

+

MANTIS:_CalcAdvState()

[Internal] Function to determine state of the advanced mode

-
+

Defined in:

@@ -4092,6 +4627,80 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
+
+
+ +
+ +
+

MANTIS:_Check(detection)

+
+ +

[Internal] Check detection function

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameter:

+
+
+

+ Functional.Detection#DETECTION_AREAS + detection +

+
+
+ +

Detection object

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:_CheckAdvState()

+
+ +

[Internal] Check advanced state

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

+ +
+
+
+
@@ -4161,7 +4770,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:_GetSAMTable()

-

[internal] Function to get the self.SAM_Table

+

[Internal] Function to get the self.SAM_Table

@@ -4191,7 +4800,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:_RefreshSAMTable()

-

(Internal) Function to update SAM table and SEAD state

+

[Internal] Function to update SAM table and SEAD state

@@ -4212,6 +4821,36 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
+
+
+ +
+ +
+

MANTIS:_Relocate()

+
+ +

[Internal] Relocation relay function

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

+ +
+
+
+
@@ -4240,7 +4879,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

MANTIS:_SetSAMTable(table)

-

[internal] Function to set the self.SAM_Table

+

[Internal] Function to set the self.SAM_Table

@@ -4272,6 +4911,834 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
+
+
+ +
+ +
+

MANTIS:__Start(delay)

+
+ +

Triggers the FSM event "Start" after a delay.

+ + +

Starts the MANTIS. Initializes parameters and starts event handlers.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameter:

+
+
+

+ #number + delay +

+
+
+ +

Delay in seconds.

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

MANTIS:__Status(delay)

+
+ +

Triggers the FSM event "Status" after a delay.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameter:

+
+
+

+ #number + delay +

+
+
+ +

Delay in seconds.

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

MANTIS:__Stop(delay)

+
+ +

Triggers the FSM event "Stop" after a delay.

+ + +

Stops the MANTIS and all its event handlers.

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameter:

+
+
+

+ #number + delay +

+
+
+ +

Delay in seconds.

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

MANTIS:onafterAdvStateChange(From, Event, To, Oldstate, Newstate, Interval)

+
+ +

[Internal] Function triggered by Event AdvStateChange

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ #number + Oldstate +

+
+
+ +

Old state - 0 = green, 1 = amber, 2 = red

+ +
+
+
+
+

+ #number + Newstate +

+
+
+ +

New state - 0 = green, 1 = amber, 2 = red

+ +
+
+
+
+

+ #number + Interval +

+
+
+ +

Calculated detection interval based on state and advanced feature setting

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onafterGreenState(From, Event, To, Group)

+
+ +

[Internal] Function triggered by Event GreenState

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ Wrapper.Group#GROUP + Group +

+
+
+ +

The GROUP object whose state was changed

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onafterRedState(From, Event, To, Group)

+
+ +

[Internal] Function triggered by Event RedState

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ Wrapper.Group#GROUP + Group +

+
+
+ +

The GROUP object whose state was changed

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onafterRelocating(From, Event, To)

+
+ +

[Internal] Function triggered by Event Relocating

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onafterShoradActivated(From, Event, To, Name, Radius, Ontime)

+
+ +

[Internal] Function triggered by Event ShoradActivated

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

Name of the GROUP which SHORAD shall protect

+ +
+
+
+
+

+ #number + Radius +

+
+
+ +

Radius around the named group to find SHORAD groups

+ +
+
+
+
+

+ #number + Ontime +

+
+
+ +

Seconds the SHORAD will stay active

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

MANTIS:onafterStart(From, Event, To)

+
+ +

[Internal] Function to set start state

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onafterStatus(From, Event, To)

+
+ +

[Internal] Status function for MANTIS

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onafterStop(From, Event, To)

+
+ +

[Internal] Function to stop MANTIS

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

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

MANTIS:onbeforeStatus(From, Event, To)

+
+ +

[Internal] Before status function for MANTIS

+ +
+
+

Defined in:

+
+

MANTIS

+
+

Parameters:

+
+
+

+ #string + From +

+
+
+ +

The From State

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

The Event

+ +
+
+
+
+

+ #string + To +

+
+
+ +

The To State

+ +
+
+

Return value:

+
+
+

#MANTIS:

+
+
+ +

self

+ +
+
+
+
@@ -4292,10 +5759,10 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
+ Core.Set#SET_GROUP +MANTIS.Adv_EWR_Group -MANTIS.AWACS_Prefix - - +

The EWR #SET_GROUP used for advanced mode

@@ -4303,10 +5770,10 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- Core.Set#SET_GROUP -MANTIS.Adv_EWR_Group + #MANTIS.AdvancedState +MANTIS.AdvancedState -

The EWR #SET_GROUP used for advanced mode

+
@@ -4374,50 +5841,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The ME name of the HQ object

-
- -
-
-
- - -MANTIS.MantisATimer - - - -
- -
-
-
- - -MANTIS.MantisAdvTimer - - - -
- -
-
-
- - -MANTIS.MantisReloTimer - - - -
- -
-
-
- - -MANTIS.MantisTimer - - -
@@ -4495,6 +5918,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Timer in seconds, how long #SHORAD will be active after a detection inside of the defense range

+
+ + +
+
+ + +MANTIS.TimeStamp + + +
@@ -4682,6 +6116,31 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Name of this Mantis

+ + + +
+
+ + +MANTIS.relointerval + + + + +

random between 30 and 60 mins

+ +
+ +
+
+
+ + #boolean +MANTIS.state2flag + + +
@@ -7943,6 +9402,54 @@ BASE:TraceOnOff( false ) + + + +

Type MANTIS.AdvancedState

+
+
+ +

Advanced state enumerator

+ +
+

Field(s)

+
+
+
+ + #number +MANTIS.AdvancedState.AMBER + + + +
+ +
+
+
+ + #number +MANTIS.AdvancedState.GREEN + + + +
+ +
+
+
+ + #number +MANTIS.AdvancedState.RED + + + +
+ +
+
+

Function(s)

+
diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 5b76045bc..047092741 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -4321,13 +4321,13 @@ and any spaces before and after the resulting name are removed.

-

RAT.communication

+

RAT.frequency

-

RAT.frequency

+

RAT.livery_id

@@ -4339,7 +4339,7 @@ and any spaces before and after the resulting name are removed.

-

RAT.skill

+

RAT.uncontrolled

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 305a62d20..d61de57f9 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -38142,7 +38142,7 @@ BASE:TraceOnOff( false ) -

Set current case.

+

Set case to that of lead.

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

Decrease stack/flag. Human player needs to take care himself.

+ +
+
@@ -38381,6 +38395,9 @@ BASE:TraceOnOff( false ) + +

Set time stamp.

+
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 67f8e34bb..630cd99a2 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -1789,7 +1789,7 @@ Create a late-activated single infantry unit as template in the mission editor a -

CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage)

+

CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage, Unitname, Typename, Forcedesc)

Function to add a CSAR object into the scene at a zone coordinate.

@@ -1819,7 +1819,7 @@ Create a late-activated single infantry unit as template in the mission editor a -

CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description)

+

CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description, forcedesc)

(Internal) Function to spawn a CSAR object into the scene.

@@ -2035,7 +2035,7 @@ Create a late-activated single infantry unit as template in the mission editor a -

CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage)

+

CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage, unitname, typename, forcedesc)

(Internal) Function to add a CSAR object into the scene at a zone coordinate.

@@ -3416,7 +3416,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.FreeVHFFrequencies @@ -3516,14 +3516,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -4004,34 +4001,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
- - #number -CSAR.rescuedpilots - - - - -

counter for saved pilots

- -
- -
-
-
- - #number -CSAR.rescues - - - - -

counter for successful rescue landings at FARP/AFB/MASH

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

CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage)

+

CSAR:SpawnCSARAtZone(Zone, Coalition, Description, RandomPoint, Nomessage, Unitname, Typename, Forcedesc)

Function to add a CSAR object into the scene at a zone coordinate.

@@ -4769,13 +4738,52 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

(optional) If true, don't send a message to SAR.

+
+
+
+
+

+ #string + Unitname +

+
+
+ +

(optional) Name of the lost unit.

+ +
+
+
+
+

+ #string + Typename +

+
+
+ +

(optional) Type of plane.

+ +
+
+
+
+

+ #boolean + Forcedesc +

+
+
+ +

(optional) Force to use the description passed only for the pilot track entry. Use to have fully custom names.

+

Usage:

- 
If missions designers want to spawn downed pilots into the field, e.g. at mission begin, to give the helicopter guys works, they can do this like so:
+    
If missions designers want to spawn downed pilots into the field, e.g. at mission begin, to give the helicopter guys work, they can do this like so:
      
        -- Create downed "Pilot Wagner" in #ZONE "CSAR_Start_1" at a random point for the blue coalition
-       my_csar:SpawnCSARAtZone( "CSAR_Start_1", coalition.side.BLUE, "Pilot Wagner", true )

+       my_csar:SpawnCSARAtZone( "CSAR_Start_1", coalition.side.BLUE, "Wagner", true, false, "Charly-1-1", "F5E" )
@@ -4872,7 +4880,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description)

+

CSAR:_AddCsar(_coalition, _country, _point, _typeName, _unitName, _playerName, _freq, noMessage, _description, forcedesc)

(Internal) Function to spawn a CSAR object into the scene.

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

Description

+
+ +
+
+

+ #boolean + forcedesc +

+
+
+ +

Use the description only for the pilot track entry

+
@@ -6094,11 +6115,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Return value:

-

#UNIT:

+

Wrapper.Unit#UNIT:

-

or nil

+

The unit or nil

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

CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage)

+

CSAR:_SpawnCsarAtZone(_zone, _coalition, _description, _randomPoint, _nomessage, unitname, typename, forcedesc)

(Internal) Function to add a CSAR object into the scene at a zone coordinate.

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

(optional) If true, don't send a message to SAR.

+
+ +
+
+

+ #string + unitname +

+
+
+ +

(optional) Name of the lost unit.

+ +
+
+
+
+

+ #string + typename +

+
+
+ +

(optional) Type of plane.

+ +
+
+
+
+

+ #boolean + forcedesc +

+
+
+ +

(optional) Force to use the description passed only for the pilot track entry. Use to have fully custom names.

+
@@ -7690,7 +7750,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.FreeVHFFrequencies @@ -7790,14 +7850,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -8278,34 +8335,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
- - #number -CSAR.rescuedpilots - - - - -

counter for saved pilots

- -
- -
-
-
- - #number -CSAR.rescues - - - - -

counter for successful rescue landings at FARP/AFB/MASH

- -
-
@@ -9884,7 +9913,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.FreeVHFFrequencies @@ -9984,14 +10013,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.allheligroupset - -

GROUP_SET of all helis

-
@@ -10472,34 +10498,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-
-
-
- - #number -CSAR.rescuedpilots - - - - -

counter for saved pilots

- -
- -
-
-
- - #number -CSAR.rescues - - - - -

counter for successful rescue landings at FARP/AFB/MASH

- -
-
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 4412ed56c..1aef08e1c 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -1787,6 +1787,7 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but 
         my_ctld.enableHercules = true
          my_ctld.HercMinAngels = 155 -- for troop/cargo drop via chute in meters, ca 470 ft
          my_ctld.HercMaxAngels = 2000 -- for troop/cargo drop via chute in meters, ca 6000 ft
+         my_ctld.HercMaxSpeed = 77 -- 77mps or 270 kph or 150 kn

Also, the following options need to be set to true:

@@ -1943,12 +1944,6 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but

CTLD.CtldUnits

- - - -

CTLD.DROP

- - @@ -2003,6 +1998,12 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but

CTLD.HercMaxAngels

+ + + +

CTLD.HercMaxSpeed

+ + @@ -2045,12 +2046,6 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but

CTLD:IsUnitInZone(Unit, Zonetype)

(Internal) Function to see if a unit is in a specific zone type.

- - - -

CTLD.LOAD

- - @@ -2063,12 +2058,6 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but

CTLD.Loaded_Cargo

- - - -

CTLD.MOVE

- - @@ -2264,7 +2253,7 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but -

CTLD._GenerateFMFrequencies(sel, self)

+

CTLD:_GenerateFMFrequencies()

(Internal) Function to generate valid FM Frequencies

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

CTLD.CargoZone.vhfbeacon

Beacon info as #CTLD.ZoneBeacon

+ + + +
+ +

Type CTLD.CargoZoneType

+
+ CTLD.CargoZoneType +
+
+ + + + + + + + + + + + + + + +
Fields and Methods inherited from CTLD.CargoZoneTypeDescription

CTLD.CargoZoneType.DROP

 + +

CTLD.CargoZoneType.LOAD

 + +

CTLD.CargoZoneType.MOVE

 +
@@ -4715,11 +4735,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-

Zone Type Info.

+
    +
  • CTLD class, extends Core.Base#BASE, Core.Fsm#FSM
    • +

Field(s)

+
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -4734,7 +4767,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #CTLD + #CTLD.CargoZoneType CTLD.CargoZoneType @@ -4822,17 +4855,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -CTLD.DROP - - -
@@ -4861,7 +4883,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -4872,7 +4894,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -4888,6 +4910,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Beacons

+
@@ -4905,7 +4930,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #booolean + #boolean CTLD.HasBeenMoved @@ -4926,6 +4951,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CTLD.HercMaxSpeed + + + + +

280 kph or 150kn eq 77 mps

+ +
+
@@ -4944,18 +4983,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string -CTLD.LOAD - - - -
- -
-
-
- - #booolean + #boolean CTLD.LoadDirectly @@ -4971,17 +4999,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -CTLD.MOVE - - -
@@ -5010,13 +5027,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups -

self:T("CTLD with prefixes and Hercules")

+

tables

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

CTLD._GenerateFMFrequencies(sel, self)

+

CTLD:_GenerateFMFrequencies()

(Internal) Function to generate valid FM Frequencies

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

CTLD

-

Parameters:

-
-
-

- #CTLD - sel -

-
-
-

-
-
-
-
-

- self -

-
-
-

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

Field(s)

+
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -9433,7 +9439,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #CTLD + #CTLD.CargoZoneType CTLD.CargoZoneType @@ -9521,17 +9527,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -CTLD.DROP - - -
@@ -9560,7 +9555,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -9571,7 +9566,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -9587,6 +9582,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Beacons

+
@@ -9604,7 +9602,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #booolean + #boolean CTLD.HasBeenMoved @@ -9625,6 +9623,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CTLD.HercMaxSpeed + + + + +

280 kph or 150kn eq 77 mps

+ +
+
@@ -9643,18 +9655,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string -CTLD.LOAD - - - -
- -
-
-
- - #booolean + #boolean CTLD.LoadDirectly @@ -9670,17 +9671,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -CTLD.MOVE - - -
@@ -9709,13 +9699,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups -

self:T("CTLD with prefixes and Hercules")

+

tables

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

Field(s)

+
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -11539,7 +11540,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #CTLD + #CTLD.CargoZoneType CTLD.CargoZoneType @@ -11627,17 +11628,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -CTLD.DROP - - -
@@ -11666,7 +11656,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -11677,7 +11667,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -11693,6 +11683,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Beacons

+
@@ -11710,7 +11703,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #booolean + #boolean CTLD.HasBeenMoved @@ -11731,6 +11724,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+
+
+ + #number +CTLD.HercMaxSpeed + + + + +

280 kph or 150kn eq 77 mps

+ +
+
@@ -11749,18 +11756,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string -CTLD.LOAD - - - -
- -
-
-
- - #booolean + #boolean CTLD.LoadDirectly @@ -11776,17 +11772,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -CTLD.MOVE - - -
@@ -11815,13 +11800,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups -

self:T("CTLD with prefixes and Hercules")

+

tables

@@ -15593,6 +15578,54 @@ BASE:TraceOnOff( false )

Beacon info as #CTLD.ZoneBeacon

+
+ +
+
+

Function(s)

+
+
+ +
+

Type CTLD.CargoZoneType

+
+
+ +

Zone Type Info.

+ +
+

Field(s)

+
+
+
+ + #string +CTLD.CargoZoneType.DROP + + + +
+ +
+
+
+ + #string +CTLD.CargoZoneType.LOAD + + + +
+ +
+
+
+ + #string +CTLD.CargoZoneType.MOVE + + +
diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index f78b3250b..625944a68 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3118,17 +3118,6 @@ based on the tasking capabilities defined in - -
- @@ -3161,7 +3150,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -4583,7 +4572,7 @@ based on the tasking capabilities defined in
- #number + TASK_CARGO.CargoLimit @@ -9115,7 +9104,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 6e94eb9ab..f655da799 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3088,50 +3088,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -3146,7 +3102,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4211,50 +4167,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -4269,7 +4181,7 @@ This method can only be used once!

- #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5113,50 +5025,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -5171,7 +5039,7 @@ This method can only be used once!

- #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6650,50 +6518,6 @@ This method can only be used once!

Field(s)

- - - -
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
@@ -6708,7 +6532,7 @@ This method can only be used once!

- #table + TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Utils.html b/Documentation/Utils.html index e253564ae..b73ddbed8 100644 --- a/Documentation/Utils.html +++ b/Documentation/Utils.html @@ -1971,6 +1971,30 @@ Controls a network of short range air/missile defense groups.

UTILS.GMTToLocalTimeDifference()

Get the time difference between GMT and local time.

+ + + +

UTILS.GenerateFMFrequencies()

+ +

Function to generate valid FM frequencies in mHz for radio beacons (FM).

+ + + +

UTILS.GenerateLaserCodes()

+ +

Function to generate valid laser codes for JTAC.

+ + + +

UTILS.GenerateUHFrequencies()

+ +

Function to generate valid UHF Frequencies in mHz (AM).

+ + + +

UTILS.GenerateVHFrequencies()

+ +

Function to generate valid VHF frequencies in kHz for radio beacons (FM).

@@ -3160,6 +3184,126 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
+
+
+ +
+ +
+

UTILS.GenerateFMFrequencies()

+
+ +

Function to generate valid FM frequencies in mHz for radio beacons (FM).

+ +
+
+

Defined in:

+
+

UTILS

+
+

Return value:

+
+
+

#table:

+
+
+ +

Table of frequencies.

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

UTILS.GenerateLaserCodes()

+
+ +

Function to generate valid laser codes for JTAC.

+ +
+
+

Defined in:

+
+

UTILS

+
+

Return value:

+
+
+

#table:

+
+
+ +

Laser Codes.

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

UTILS.GenerateUHFrequencies()

+
+ +

Function to generate valid UHF Frequencies in mHz (AM).

+ +
+
+

Defined in:

+
+

UTILS

+
+

Return value:

+
+
+

#table:

+
+
+ +

UHF Frequencies

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

UTILS.GenerateVHFrequencies()

+
+ +

Function to generate valid VHF frequencies in kHz for radio beacons (FM).

+ +
+
+

Defined in:

+
+

UTILS

+
+

Return value:

+
+
+

#table:

+
+
+ +

VHFrequencies

+ +
+
+
+
diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index a7d5f53e7..78735177f 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4214,7 +4214,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

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

-

Alive2.

+

Alive.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 32fd156a3..4963adf98 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4740,7 +4740,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -8846,7 +8857,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -17374,7 +17396,18 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -20838,7 +20871,18 @@ Coordinates are dependent on the position of the maps origin.

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

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

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 265d0be8c..be875f51d 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2987,28 +2987,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoaliton - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
@@ -5093,28 +5071,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoaliton - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
@@ -6707,28 +6663,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoaliton - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 0f1b6480a..690cd9496 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3511,6 +3511,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+ @@ -6898,6 +6909,17 @@ Coordinates are dependent on the position of the maps origin.

+
+ +
+ @@ -7475,6 +7497,17 @@ If the Identifiable is alive, true is returned.

+
+ +
+ @@ -7658,6 +7691,17 @@ If the Identifiable is alive, true is returned.

+
+ +
+