From eda7bb44d17da6d9959e90d4e7f2800c4f488944 Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Sat, 4 Jan 2025 18:17:49 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_A2A_Dispatcher.html | 20 +- Documentation/AI.AI_A2G_Dispatcher.html | 64 +- Documentation/AI.AI_Air.html | 88 + Documentation/AI.AI_Cargo_Airplane.html | 56 - Documentation/AI.AI_Cargo_Helicopter.html | 40 +- Documentation/Cargo.CargoGroup.html | 3 + Documentation/Cargo.CargoUnit.html | 22 + Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 11 - Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 280 +- Documentation/Core.SpawnStatic.html | 88 +- Documentation/Core.Spot.html | 132 - Documentation/Functional.ATC_Ground.html | 6 + Documentation/Functional.Detection.html | 66 + Documentation/Functional.Mantis.html | 164 +- Documentation/Functional.RAT.html | 63 +- Documentation/Functional.Range.html | 13139 ++++------------ Documentation/Ops.Airboss.html | 80 - Documentation/Ops.CTLD.html | 147 +- Documentation/Tasking.Task.html | 22 - Documentation/Tasking.Task_CARGO.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 148 +- Documentation/Utilities.FiFo.html | 22 + Documentation/Wrapper.Marker.html | 132 +- 25 files changed, 3876 insertions(+), 10966 deletions(-) diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index cfd039859..c9a74577d 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -5034,14 +5034,11 @@

Field(s)

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -11701,14 +11698,11 @@

Field(s)

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -12966,14 +12960,11 @@

Field(s)

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -14533,14 +14524,11 @@

Field(s)

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 0b9bc6829..1a29068e1 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4903,6 +4903,17 @@

Field(s)

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -5020,11 +5031,14 @@

Field(s)

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -13454,6 +13468,17 @@

Field(s)

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -13571,11 +13596,14 @@

Field(s)

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -14780,6 +14808,17 @@

Field(s)

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -14897,11 +14936,14 @@

Field(s)

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -16408,6 +16450,17 @@

Field(s)

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -16525,11 +16578,14 @@

Field(s)

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 0f528e50c..a735aee0b 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3347,6 +3347,28 @@

Field(s)

+ + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -6200,6 +6222,28 @@

Field(s)

+ + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -6936,6 +6980,28 @@

Field(s)

+ + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
@@ -8560,6 +8626,28 @@

Field(s)

+ + + +
+
+ + #number +AI_AIR.RTBSpeedMaxFactor + + + +
+ +
+
+
+ + #number +AI_AIR.RTBSpeedMinFactor + + +
diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index a60f38278..35ad6a8fb 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2905,20 +2905,6 @@

Developer Note

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -4698,20 +4684,6 @@

Parameters:

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -5333,20 +5305,6 @@

Parameters:

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
@@ -6856,20 +6814,6 @@

Return value:

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - - -

Set destination airbase for next :Route() command.

- -
- -
diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index d7129b0d6..7181ab477 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -3070,22 +3070,28 @@

Field(s)

- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -4988,22 +4994,28 @@

Field(s)

- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -5658,22 +5670,28 @@

Field(s)

- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
@@ -7216,22 +7234,28 @@

Field(s)

- + #number AI_CARGO_HELICOPTER.landingheight + +

meter

+
- + #number AI_CARGO_HELICOPTER.landingspeed + +

kph

+
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 0ab2f5ca8..ac3f431f8 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -2034,6 +2034,9 @@

Field(s)

+ +

Then we register the new group in the database

+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index c124af695..4dc712074 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1914,6 +1914,17 @@

Field(s)

+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2618,6 +2629,17 @@

Field(s)

+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 8f96d0b77..9610f3e4d 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -6117,7 +6117,7 @@

Field(s)

- #string + FSM._StartState @@ -7716,7 +7716,7 @@

Field(s)

- #string + FSM._StartState diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 4067b0b4d..bdab01e8f 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -17403,17 +17403,6 @@

Field(s)

-
- -
-
-
- - -POINT_VEC2.z - - -
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 9230c357a..9d30aad47 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -3061,17 +3061,6 @@

Field(s)

-
- -
-
-
- - #boolean -SETTINGS.Metric - - -
@@ -3079,7 +3068,7 @@

Field(s)

-SETTINGS.PlayerMenu +SETTINGS.Metric @@ -5229,17 +5218,6 @@

Field(s)

-
- -
-
-
- - #boolean -SETTINGS.Metric - - -
@@ -5247,7 +5225,7 @@

Field(s)

-SETTINGS.PlayerMenu +SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 74dfe9d60..2a29314cc 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3224,6 +3224,30 @@

Delay the initial spawning

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

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.hidden

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.skill

+ + @@ -3965,9 +3989,6 @@

Field(s)

- -

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

-
@@ -4067,17 +4088,6 @@

Field(s)

-
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -4142,8 +4152,8 @@

Field(s)

- -SPAWN.SpawnInitAirbase + #boolean +SPAWN.SpawnInitCallSign @@ -4153,8 +4163,8 @@

Field(s)

- #boolean -SPAWN.SpawnInitCallSign + +SPAWN.SpawnInitCallSignName @@ -4165,7 +4175,7 @@

Field(s)

-SPAWN.SpawnInitCallSignName +SPAWN.SpawnInitCategory @@ -4176,7 +4186,7 @@

Field(s)

-SPAWN.SpawnInitCategory +SPAWN.SpawnInitCoalition @@ -4187,7 +4197,7 @@

Field(s)

-SPAWN.SpawnInitCoalition +SPAWN.SpawnInitCountry @@ -4198,7 +4208,7 @@

Field(s)

-SPAWN.SpawnInitCountry +SPAWN.SpawnInitFreq @@ -4268,9 +4278,6 @@

Field(s)

- -

Overwrite unit names by default with group name.

-
@@ -4282,8 +4289,38 @@

Field(s)

+
+ +
+
+
+ + +SPAWN.SpawnInitModex + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPostfix + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPrefix -

By default, no InitLimit

+
@@ -4292,7 +4329,7 @@

Field(s)

-SPAWN.SpawnInitLivery +SPAWN.SpawnInitModu @@ -4310,6 +4347,17 @@

Field(s)

self:T2( { self.SpawnTemplatePrefix, Vec2} )

+
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -4341,7 +4389,7 @@

Field(s)

- #number + SPAWN.SpawnMaxGroups @@ -4355,7 +4403,7 @@

Field(s)

- #number + SPAWN.SpawnMaxUnitsAlive @@ -4568,7 +4616,7 @@

Field(s)

-

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.

@@ -4642,6 +4690,50 @@

Field(s)

+
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.hidden + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.skill + + +
@@ -10379,9 +10471,6 @@

Field(s)

- -

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

-
@@ -10481,17 +10570,6 @@

Field(s)

-
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -10556,8 +10634,8 @@

Field(s)

- -SPAWN.SpawnInitAirbase + #boolean +SPAWN.SpawnInitCallSign @@ -10567,8 +10645,8 @@

Field(s)

- #boolean -SPAWN.SpawnInitCallSign + +SPAWN.SpawnInitCallSignName @@ -10579,7 +10657,7 @@

Field(s)

-SPAWN.SpawnInitCallSignName +SPAWN.SpawnInitCategory @@ -10590,7 +10668,7 @@

Field(s)

-SPAWN.SpawnInitCategory +SPAWN.SpawnInitCoalition @@ -10601,7 +10679,7 @@

Field(s)

-SPAWN.SpawnInitCoalition +SPAWN.SpawnInitCountry @@ -10612,7 +10690,7 @@

Field(s)

-SPAWN.SpawnInitCountry +SPAWN.SpawnInitFreq @@ -10682,9 +10760,6 @@

Field(s)

- -

Overwrite unit names by default with group name.

-
@@ -10696,8 +10771,38 @@

Field(s)

+
+ +
+
+
+ + +SPAWN.SpawnInitModex + + + +
+ +
+
+
+ + +SPAWN.SpawnInitModexPostfix + + + +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitModexPrefix + +
@@ -10706,7 +10811,7 @@

Field(s)

-SPAWN.SpawnInitLivery +SPAWN.SpawnInitModu @@ -10724,6 +10829,17 @@

Field(s)

self:T2( { self.SpawnTemplatePrefix, Vec2} )

+
+ +
+
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -10755,7 +10871,7 @@

Field(s)

- #number + SPAWN.SpawnMaxGroups @@ -10769,7 +10885,7 @@

Field(s)

- #number + SPAWN.SpawnMaxUnitsAlive @@ -10982,7 +11098,7 @@

Field(s)

-

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.

@@ -11056,6 +11172,50 @@

Field(s)

+
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.hidden + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 0665e3a69..c4325e6d6 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -2138,24 +2138,6 @@

Spawning the Statics

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

- - - -

SPAWNSTATIC.heliport_callsign_id

- - - - - -

SPAWNSTATIC.heliport_frequency

- - - - - -

SPAWNSTATIC.heliport_modulation

- - @@ -3141,44 +3123,11 @@

Field(s)

- -
-
- - -SPAWNSTATIC.heliport_frequency - - - -
- -
- @@ -4786,44 +4735,11 @@

Field(s)

- -
-
- - -SPAWNSTATIC.heliport_frequency - - - -
- -
- diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 725fa9556..51c1c0fc2 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2974,50 +2974,6 @@

Field(s)

-
- -
-
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -4301,50 +4257,6 @@

Field(s)

-
- -
-
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -5867,50 +5779,6 @@

Field(s)

-
- -
-
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index e6902f6bc..2c20e80ca 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -4105,6 +4105,9 @@

Field(s)

+ +

Kickspeed

+
@@ -4690,6 +4693,9 @@

Field(s)

+ +

Kickspeed

+
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 18c3048d3..e8f1acac7 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -20000,6 +20000,17 @@

Field(s)

+ + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -20132,6 +20143,17 @@

Field(s)

+ + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -24754,6 +24776,17 @@

Field(s)

+ + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -24886,6 +24919,17 @@

Field(s)

+ + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -26496,6 +26540,17 @@

Field(s)

+ + + +
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -26628,6 +26683,17 @@

Field(s)

+ + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 06e18ca80..7faef2c2d 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2132,6 +2132,12 @@

6. Integrated SEAD

MANTIS:GetCommandCenter()

Function to get the HQ object for further use

+ + + +

MANTIS.Groupset

+ + @@ -4264,6 +4270,17 @@

Field(s)

The #DETECTION_AREAS object for AWACS

+ + + +
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -4385,6 +4402,17 @@

Field(s)

Table of Core.Zone#ZONE Zones Consider SAM groups in this zone(s) only for this MANTIS instance, must be handed as #table of Zone objects.

+ + + +
+
+ + +MANTIS.Groupset + + +
@@ -4446,7 +4474,7 @@

Field(s)

- #table + MANTIS.SAM_Table_Long @@ -4457,7 +4485,7 @@

Field(s)

- #table + MANTIS.SAM_Table_Medium @@ -4468,7 +4496,7 @@

Field(s)

- #table + MANTIS.SAM_Table_Short @@ -4625,8 +4653,8 @@

Field(s)

- #number -MANTIS.SkateNumber + +MANTIS.SkateZones @@ -4886,50 +4914,6 @@

Field(s)

Prefix for logging

-
- -
-
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -4999,6 +4983,9 @@

Field(s)

+ +

switch alarm state RED

+
@@ -8975,6 +8962,17 @@

Field(s)

The #DETECTION_AREAS object for AWACS

+
+ +
+
+
+ + +MANTIS.AWACS_Prefix + + +
@@ -9096,6 +9094,17 @@

Field(s)

Table of Core.Zone#ZONE Zones Consider SAM groups in this zone(s) only for this MANTIS instance, must be handed as #table of Zone objects.

+
+ +
+
+
+ + +MANTIS.Groupset + + +
@@ -9157,7 +9166,7 @@

Field(s)

- #table + MANTIS.SAM_Table_Long @@ -9168,7 +9177,7 @@

Field(s)

- #table + MANTIS.SAM_Table_Medium @@ -9179,7 +9188,7 @@

Field(s)

- #table + MANTIS.SAM_Table_Short @@ -9336,8 +9345,8 @@

Field(s)

- #number -MANTIS.SkateNumber + +MANTIS.SkateZones @@ -9597,50 +9606,6 @@

Field(s)

Prefix for logging

-
- -
-
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -9710,6 +9675,9 @@

Field(s)

+ +

switch alarm state RED

+
diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index d79a84abe..4a06452bb 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -3573,12 +3573,6 @@

Example

RAT.termtype

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

- - - -

RAT.type

- - @@ -4780,6 +4774,30 @@

Example

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

+ + + +

RAT.communication

+ + + + + +

RAT.hidden

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.skill

+ + @@ -7285,17 +7303,6 @@

Field(s)

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

-
- -
-
-
- - -RAT.type - - -
@@ -15176,17 +15183,6 @@

Field(s)

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

-
- -
-
-
- - -RAT.type - - -
@@ -22024,17 +22020,6 @@

Field(s)

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

- - - -
-
- - -RAT.type - - -
diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index ccd5e6f3a..21c46a808 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -1971,6 +1971,10 @@

Goldwater Range

-- Create a range object. GoldwaterRange=RANGE:New("Goldwater Range") + -- Set and enable the range ceiling altitude in feet MSL. If aircraft are above this altitude they are not considered to be in the range. + GoldwaterRange:SetRangeCeiling(20000) + GoldwaterRange:EnableRangeCeiling(true) + -- Distance between strafe target and foul line. You have to specify the names of the unit or static objects. -- Note that this could also be done manually by simply measuring the distance between the target and the foul line in the ME. GoldwaterRange:GetFoullineDistance("GWR Strafe Pit Left 1", "GWR Foul Line Left") @@ -2018,8 +2022,6 @@

Debugging

Type RANGE

RANGE -, extends Core.Fsm#FSM -, extends Core.Base#BASE
@@ -2115,6 +2117,12 @@

Debugging

+ + + + @@ -2319,6 +2327,12 @@

Debugging

+ + + + @@ -2763,6 +2777,18 @@

Debugging

+ + + + + + + + @@ -3091,8160 +3117,916 @@

Debugging

RANGE.Defaults

 +

RANGE:EnableRangeCeiling(enabled)

 +

Enable range ceiling.

RANGE:SetMessagesON()

Enable messages to players.

+

RANGE:SetRangeCeiling(ceiling, alt)

 +

Set range ceiling altitude in feet MSL.

RANGE.bombingTargets

Table of targets to bomb.

+

RANGE.ceilingaltitude

 +

Range ceiling altitude in ft MSL. Aircraft above this altitude are not considered to be in the range. Default is 20000 ft.

+

RANGE.ceilingenabled

 +

Range has a ceiling and is not unlimited. Default is false.
+ +

Type RANGE.BombResult

+
+ RANGE.BombResult +
- + - + + + + + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + - + - + - + - + - + - + +
Fields and Methods inherited from FSMFields and Methods inherited from RANGE.BombResult Description

RANGE:AddEndState(State)

RANGE.BombResult.airframe

 +

Aircraft type of player.

+

RANGE.BombResult.attackAlt

 -

Adds an End state.

+

Attack altitude in feet.

RANGE:AddProcess(From, Event, Process, ReturnEvents)

RANGE.BombResult.attackHdg

 -

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

+

Attack heading in degrees.

RANGE:AddScore(State, ScoreText, Score)

RANGE.BombResult.attackVel

 -

Adds a score for the FSM to be achieved.

+

Attack velocity in knots.

RANGE:AddScoreProcess(From, Event, State, ScoreText, Score)

RANGE.BombResult.clock

 -

Adds a score for the FSM_PROCESS to be achieved.

+

Time of the run.

RANGE:AddTransition(From, Event, To)

RANGE.BombResult.command

 -

Add a new transition rule to the FSM.

+

RANGE.CallScheduler

RANGE.BombResult.date

 -

Call scheduler.

+

OS date.

RANGE.ClassName

RANGE.BombResult.distance

 -

Name of the class.

+

Distance in meters.

RANGE.Events

RANGE.BombResult.midate

RANGE:GetCurrentState()

RANGE.BombResult.name

 +

Name of closest target.

+

RANGE.BombResult.player

 +

Player name.

+

RANGE.BombResult.quality

 +

Hit quality.

+

RANGE.BombResult.radial

 +

Radial in degrees.

+

RANGE.BombResult.rangename

 -

Get current state.

+

Name of the range.

RANGE:GetEndStates()

RANGE.BombResult.roundsFired

 -

Returns the End states.

+

RANGE:GetProcess(From, Event)

RANGE.BombResult.roundsHit

RANGE:GetProcesses()

RANGE.BombResult.roundsQuality

 -

Returns a table of the SubFSM rules defined within the FSM.

+

RANGE:GetScores()

RANGE.BombResult.theatre

 -

Returns a table with the scores defined.

+

RANGE:GetStartState()

RANGE.BombResult.time

 -

Returns the start state of the FSM.

+

Time via timer.getAbsTime() in seconds of impact.

RANGE:GetState()

RANGE.BombResult.weapon

 -

Get current state.

+

Name of the weapon.
+
+ +

Type RANGE.BombTarget

+
+ RANGE.BombTarget +
+
+ + + + + - + - + - + - + - + - + - + +
Fields and Methods inherited from RANGE.BombTargetDescription

RANGE:GetSubs()

RANGE.BombTarget.coordinate

 -

Returns a table with the Subs defined.

+

Coordinate of the target.

RANGE:GetTransitions()

RANGE.BombTarget.goodhitrange

 -

Returns a table of the transition rules defined within the FSM.

+

Range in meters for a good hit.

RANGE:Is(State)

RANGE.BombTarget.move

 -

Check if FSM is in state.

+

If true, unit move randomly.

RANGE:LoadCallBacks(CallBackTable)

RANGE.BombTarget.name

 -

Load call backs.

+

Name of unit.

RANGE:New()

RANGE.BombTarget.speed

 -

Creates a new FSM object.

+

Speed of unit.

RANGE.Scores

RANGE.BombTarget.target

 -

Scores.

+

Target unit.

RANGE:SetProcess(From, Event, Fsm)

RANGE.BombTarget.type

 - +

Type of target.
+
+ +

Type RANGE.Defaults

+
+ RANGE.Defaults +
+
+ + + + + - + - + - + - + - + - + - + - + - + - + - + +
Fields and Methods inherited from RANGE.DefaultsDescription

RANGE:SetStartState(State)

RANGE.Defaults.TdelaySmoke

 -

Sets the start state of the FSM.

+

RANGE._EndStates

RANGE.Defaults.Tmsg

RANGE._EventSchedules

RANGE.Defaults.boxlength

RANGE._Processes

RANGE.Defaults.boxwidth

RANGE._Scores

RANGE.Defaults.dtBombtrack

RANGE._StartState

RANGE.Defaults.foulline

RANGE._Transitions

RANGE.Defaults.goodhitrange

RANGE:_add_to_map(Map, Event)

RANGE.Defaults.goodpass

 -

Add to map.

+

RANGE:_call_handler(step, trigger, params, EventName)

RANGE.Defaults.ndisplayresult

 -

Call handler.

+

RANGE:_create_transition(EventName)

RANGE.Defaults.rangeradius

 -

Create transition.

+

RANGE:_delayed_transition(EventName)

RANGE.Defaults.strafemaxalt

 -

Delayed transition.

+
+
+ +

Type RANGE.PlayerData

+
+ RANGE.PlayerData +
+
+ + + + + - + - + - + - + - + - + - + - + - + - + - + - +
Fields and Methods inherited from RANGE.PlayerDataDescription

RANGE:_eventmap(Events, EventStructure)

RANGE.PlayerData.airframe

 -

Event map.

+

Aircraft type name.

RANGE:_gosub(ParentFrom, ParentEvent)

RANGE.PlayerData.client

 -

Go sub.

+

Client object of player.

RANGE:_handler(EventName, ...)

RANGE.PlayerData.flarecolor

 -

Handler.

+

Color of flares.

RANGE:_isendstate(Current)

RANGE.PlayerData.flaredirecthits

 -

Is end state.

+

Flare when player directly hits a target.

RANGE:_submap(subs, sub, name)

RANGE.PlayerData.inzone

 -

Sub maps.

+

If true, player is inside the range zone.

RANGE:can(e)

RANGE.PlayerData.messages

 -

Check if can do an event.

+

Display info messages.

RANGE:cannot(e)

RANGE.PlayerData.playername

 -

Check if cannot do an event.

+

Name of player.

RANGE.current

RANGE.PlayerData.smokebombimpact

 -

Current state name.

+

Smoke bomb impact points.

RANGE.endstates

RANGE.PlayerData.smokecolor

 - +

Color of smoke.

RANGE:is(State, state)

RANGE.PlayerData.targeton

 -

Check if FSM is in state.

+

Target on.

RANGE.options

RANGE.PlayerData.unit

 -

Options.

+

Player unit.

RANGE.subs

RANGE.PlayerData.unitname

 -

Subs.

+

Name of player aircraft unit.
+ +

Type RANGE.Sound

+
+ RANGE.Sound +
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - + - + - + - + - + - - - +
Fields and Methods inherited from BASEFields and Methods inherited from RANGE.Sound Description

RANGE.ClassID

RANGE.Sound.IR0

 -

The ID number of the class.

+

RANGE.ClassName

RANGE.Sound.IR1

 -

The name of the class.

+

RANGE.ClassNameAndID

RANGE.Sound.IR2

 -

The name of the class concatenated with the ID number of the class.

+

RANGE:ClearState(Object, StateName)

RANGE.Sound.IR3

 -

Clear the state of an object.

+

RANGE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

RANGE.Sound.IR4

 -

Creation of a Birth Event.

+

RANGE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

RANGE.Sound.IR5

 -

Creation of a Crash Event.

+

RANGE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

RANGE.Sound.IR6

 -

Creation of a Dead Event.

+

RANGE:CreateEventDynamicCargoLoaded(DynamicCargo)

RANGE.Sound.IR7

 -

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

+

RANGE:CreateEventDynamicCargoRemoved(DynamicCargo)

RANGE.Sound.IR8

 -

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

+

RANGE:CreateEventDynamicCargoUnloaded(DynamicCargo)

RANGE.Sound.IR9

 -

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

+

RANGE:CreateEventNewDynamicCargo(DynamicCargo)

RANGE.Sound.IRDecimal

 -

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

+

RANGE:CreateEventPlayerEnterAircraft(PlayerUnit)

RANGE.Sound.IREnterRange

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

RANGE:CreateEventRemoveUnit(EventTime, Initiator)

RANGE.Sound.IRExitRange

 -

Creation of a Remove Unit Event.

+

RANGE:CreateEventTakeoff(EventTime, Initiator)

RANGE.Sound.IRMegaHertz

 -

Creation of a Takeoff Event.

+

RANGE:CreateEventUnitLost(EventTime, Initiator)

RANGE.Sound.RC0

 -

Creation of a Crash Event.

+

RANGE:E(Arguments)

RANGE.Sound.RC1

 -

Log an exception which will be traced always.

+

RANGE:EventDispatcher()

RANGE.Sound.RC2

 -

Returns the event dispatcher

+

RANGE:EventRemoveAll()

RANGE.Sound.RC3

 -

Remove all subscribed events

+

RANGE:F(Arguments)

RANGE.Sound.RC4

 -

Trace a function call.

+

RANGE:F2(Arguments)

RANGE.Sound.RC5

 -

Trace a function call level 2.

+

RANGE:F3(Arguments)

RANGE.Sound.RC6

 -

Trace a function call level 3.

+

RANGE:GetClassID()

RANGE.Sound.RC7

 -

Get the ClassID of the class instance.

+

RANGE:GetClassName()

RANGE.Sound.RC8

 -

Get the ClassName of the class instance.

+

RANGE:GetClassNameAndID()

RANGE.Sound.RC9

 -

Get the ClassName + ClassID of the class instance.

+

RANGE:GetEventPriority()

RANGE.Sound.RCAccuracy

 -

Get the Class Core.Event processing Priority.

+

RANGE:GetParent(Child, FromClass)

RANGE.Sound.RCDegrees

 -

This is the worker method to retrieve the Parent class.

+

RANGE:GetState(Object, Key)

RANGE.Sound.RCExcellentHit

 -

Get a Value given a Key from the Object.

+

RANGE:HandleEvent(EventID, EventFunction)

RANGE.Sound.RCExcellentPass

 -

Subscribe to a DCS Event.

+

RANGE:I(Arguments)

RANGE.Sound.RCFeet

 -

Log an information which will be traced always.

+

RANGE:Inherit(Child, Parent)

RANGE.Sound.RCFor

 -

This is the worker method to inherit from a parent class.

+

RANGE:IsInstanceOf(ClassName)

RANGE.Sound.RCGoodHit

 -

This is the worker method to check if an object is an (sub)instance of a class.

+

RANGE:IsTrace()

RANGE.Sound.RCGoodPass

 -

Enquires if tracing is on (for the class).

+

RANGE:New()

RANGE.Sound.RCHitsOnTarget

 -

BASE constructor.

+

RANGE:OnEvent(EventData)

RANGE.Sound.RCImpact

 -

Occurs when an Event for an object is triggered.

+

RANGE:OnEventBDA(EventData)

RANGE.Sound.RCIneffectiveHit

 -

BDA.

+

RANGE:OnEventBaseCaptured(EventData)

RANGE.Sound.RCIneffectivePass

 -

Occurs when a ground unit captures either an airbase or a farp.

+

RANGE:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

RANGE:OnEventCrash(EventData)

 -

Occurs when any aircraft crashes into the ground and is completely destroyed.

-

RANGE:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

RANGE:OnEventDetailedFailure(EventData)

 -

Unknown precisely what creates this event, likely tied into newer damage model.

-

RANGE:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

RANGE:OnEventDynamicCargoLoaded(EventData)

 -

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

-

RANGE:OnEventDynamicCargoRemoved(EventData)

 -

Occurs when a dynamic cargo crate is removed.

-

RANGE:OnEventDynamicCargoUnloaded(EventData)

 -

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

-

RANGE:OnEventEjection(EventData)

 -

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

RANGE:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

RANGE:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

RANGE:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

RANGE:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

RANGE:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

RANGE:OnEventLand(EventData)

 -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

-

RANGE:OnEventLandingAfterEjection(EventData)

 -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

-

RANGE:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

RANGE:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

RANGE:OnEventMarkChange(EventData)

RANGE.Sound.RCInvalidHit

 -

Occurs when a mark text was changed.

+

RANGE:OnEventMarkRemoved(EventData)

RANGE.Sound.RCLeftStrafePitTooQuickly

 -

Occurs when a mark was removed.

+

RANGE:OnEventMissionEnd(EventData)

RANGE.Sound.RCPercent

 -

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

RANGE:OnEventMissionStart(EventData)

RANGE.Sound.RCPoorHit

 -

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

RANGE:OnEventNewDynamicCargo(EventData)

RANGE.Sound.RCPoorPass

 -

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

+

RANGE:OnEventParatrooperLanding(EventData)

RANGE.Sound.RCRollingInOnStrafeTarget

 -

Weapon add.

+

RANGE:OnEventPilotDead(EventData)

RANGE.Sound.RCTotalRoundsFired

 -

Occurs when the pilot of an aircraft is killed.

+

RANGE:OnEventPlayerEnterAircraft(EventData)

RANGE.Sound.RCWeaponImpactedTooFar

 -

Occurs when a player enters a slot and takes control of an aircraft.

+

RANGE:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-
+
+ +

Type RANGE.Soundfile

+
+ RANGE.Soundfile +
+
+ + + + - + - + - - - +
Fields and Methods inherited from RANGE.SoundfileDescription

RANGE:OnEventPlayerLeaveUnit(EventData)

RANGE.Soundfile.duration

 -

Occurs when any player relieves control of a unit to the AI.

+

Duration in seconds.

RANGE:OnEventRefueling(EventData)

RANGE.Soundfile.filename

 -

Occurs when an aircraft connects with a tanker and begins taking on fuel.

+

Name of the file

RANGE:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-
+
+ +

Type RANGE.StrafeResult

+
+ RANGE.StrafeResult +
+
+ + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - +
Fields and Methods inherited from RANGE.StrafeResultDescription

RANGE:OnEventScore(EventData)

RANGE.StrafeResult.airframe

 -

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

+

Aircraft type of player.

RANGE:OnEventShootingEnd(EventData)

RANGE.StrafeResult.clock

 -

Occurs when any unit stops firing its weapon.

+

Time of the run.

RANGE:OnEventShootingStart(EventData)

RANGE.StrafeResult.command

 -

Occurs when any unit begins firing a weapon that has a high rate of fire.

+

RANGE:OnEventShot(EventData)

RANGE.StrafeResult.date

 -

Occurs whenever any unit in a mission fires a weapon.

+

OS date.

RANGE:OnEventTakeoff(EventData)

RANGE.StrafeResult.invalid

 -

Occurs when an aircraft takes off from an airbase, farp, or ship.

+

Invalid pass.

RANGE:OnEventTriggerZone(EventData)

RANGE.StrafeResult.midate

 -

Trigger zone.

+

RANGE:OnEventUnitLost(EventData)

RANGE.StrafeResult.name

 -

Occurs when the game thinks an object is destroyed.

+

Name of the target pit.

RANGE:ScheduleOnce(Start, SchedulerFunction, ...)

RANGE.StrafeResult.player

 -

Schedule a new time event.

+

Player name.

RANGE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

RANGE.StrafeResult.rangename

 -

Schedule a new time event.

+

Name of the range.

RANGE:ScheduleStop(SchedulerID)

RANGE.StrafeResult.roundsFired

 -

Stops the Schedule.

+

Number of rounds fired.

RANGE.Scheduler

RANGE.StrafeResult.roundsHit

 -

The scheduler object.

+

Number of rounds that hit the target.

RANGE:SetEventPriority(EventPriority)

RANGE.StrafeResult.roundsQuality

 -

Set the Class Core.Event processing Priority.

+

RANGE:SetState(Object, Key, Value)

RANGE.StrafeResult.strafeAccuracy

 -

Set a state or property of the Object given a Key and a Value.

+

Accuracy of the run in percent.

RANGE:T(Arguments)

RANGE.StrafeResult.theatre

 -

Trace a function logic level 1.

+

RANGE:T2(Arguments)

RANGE.StrafeResult.time

 -

Trace a function logic level 2.

+

Time via timer.getAbsTime() in seconds of impact.

RANGE:T3(Arguments)

 -

Trace a function logic level 3.

-
+
+ +

Type RANGE.StrafeStatus

+
+ RANGE.StrafeStatus +
+
+ + + + - + - + - + - + - + - - - +
Fields and Methods inherited from RANGE.StrafeStatusDescription

RANGE:TraceAll(TraceAll)

RANGE.StrafeStatus.ammo

 -

Trace all methods in MOOSE

+

Amount of ammo.

RANGE:TraceClass(Class)

RANGE.StrafeStatus.hits

 -

Set tracing for a class

+

Number of hits on target.

RANGE:TraceClassMethod(Class, Method)

RANGE.StrafeStatus.pastfoulline

 -

Set tracing for a specific method of class

+

If true, player passed foul line. Invalid pass.

RANGE:TraceLevel(Level)

RANGE.StrafeStatus.time

 -

Set trace level

+

Number of times.

RANGE:TraceOff()

RANGE.StrafeStatus.zone

 -

Set trace off.

+

Strafe target.

RANGE:TraceOn()

 -

Set trace on.

-
+
+ +

Type RANGE.StrafeTarget

+
+ RANGE.StrafeTarget +
+
+ + + + - + - + - + - + - + - + - + - +
Fields and Methods inherited from RANGE.StrafeTargetDescription

RANGE:TraceOnOff(TraceOnOff)

RANGE.StrafeTarget.coordinate

 -

Set trace on or off -Note that when trace is off, no BASE.Debug statement is performed, increasing performance! -When Moose is loaded statically, (as one file), tracing is switched off by default.

+

Center coordinate of the pit.

RANGE:UnHandleEvent(EventID)

RANGE.StrafeTarget.foulline

 -

UnSubscribe to a DCS event.

+

Foul line

RANGE._

RANGE.StrafeTarget.goodPass

 - +

Number of hits for a good pass.

RANGE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

RANGE.StrafeTarget.heading

 -

Trace a function call.

+

Heading of pit.

RANGE:_Serialize(Arguments)

RANGE.StrafeTarget.name

 -

(Internal) Serialize arguments

+

Name of the unit.

RANGE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

RANGE.StrafeTarget.polygon

 -

Trace a function logic.

+

Polygon zone.

RANGE.__

RANGE.StrafeTarget.smokepoints

 - +

Number of smoke points.

RANGE:onEvent(event)

RANGE.StrafeTarget.targets

 -

The main event handling function...

+

Table of target units.
-

Type RANGE.BombResult

+

Type RANGE.TargetType

- RANGE.BombResult + RANGE.TargetType
- + - - - - - + - + - + - + - - -
Fields and Methods inherited from RANGE.BombResultFields and Methods inherited from RANGE.TargetType Description

RANGE.BombResult.airframe

 -

Aircraft type of player.

-

RANGE.BombResult.attackAlt

RANGE.TargetType.COORD

 -

Attack altitude in feet.

+

Target is a coordinate.

RANGE.BombResult.attackHdg

RANGE.TargetType.SCENERY

 -

Attack heading in degrees.

+

Target is a scenery object.

RANGE.BombResult.attackVel

RANGE.TargetType.STATIC

 -

Attack velocity in knots.

+

Target is a static object.

RANGE.BombResult.clock

RANGE.TargetType.UNIT

 -

Time of the run.

+

Target is a unitobject.

RANGE.BombResult.command

 +
+
- - - -

RANGE.BombResult.date

- -

OS date.

- - - -

RANGE.BombResult.distance

- -

Distance in meters.

- - - -

RANGE.BombResult.midate

- - - - - -

RANGE.BombResult.name

- -

Name of closest target.

- - - -

RANGE.BombResult.player

- -

Player name.

- - - -

RANGE.BombResult.quality

- -

Hit quality.

- - - -

RANGE.BombResult.radial

- -

Radial in degrees.

- - - -

RANGE.BombResult.rangename

- -

Name of the range.

- - - -

RANGE.BombResult.roundsFired

- - - - - -

RANGE.BombResult.roundsHit

- - - - - -

RANGE.BombResult.roundsQuality

- - - - - -

RANGE.BombResult.theatre

- - - - - -

RANGE.BombResult.time

- -

Time via timer.getAbsTime() in seconds of impact.

- - - -

RANGE.BombResult.weapon

- -

Name of the weapon.

- - - - - -

Type RANGE.BombTarget

-
- RANGE.BombTarget -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.BombTargetDescription

RANGE.BombTarget.coordinate

 -

Coordinate of the target.

-

RANGE.BombTarget.goodhitrange

 -

Range in meters for a good hit.

-

RANGE.BombTarget.move

 -

If true, unit move randomly.

-

RANGE.BombTarget.name

 -

Name of unit.

-

RANGE.BombTarget.speed

 -

Speed of unit.

-

RANGE.BombTarget.target

 -

Target unit.

-

RANGE.BombTarget.type

 -

Type of target.

-
-
- -

Type RANGE.Defaults

-
- RANGE.Defaults -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.DefaultsDescription

RANGE.Defaults.TdelaySmoke

 - -

RANGE.Defaults.Tmsg

 - -

RANGE.Defaults.boxlength

 - -

RANGE.Defaults.boxwidth

 - -

RANGE.Defaults.dtBombtrack

 - -

RANGE.Defaults.foulline

 - -

RANGE.Defaults.goodhitrange

 - -

RANGE.Defaults.goodpass

 - -

RANGE.Defaults.ndisplayresult

 - -

RANGE.Defaults.rangeradius

 - -

RANGE.Defaults.strafemaxalt

 - -
-
- -

Type RANGE.PlayerData

-
- RANGE.PlayerData -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.PlayerDataDescription

RANGE.PlayerData.airframe

 -

Aircraft type name.

-

RANGE.PlayerData.client

 -

Client object of player.

-

RANGE.PlayerData.flarecolor

 -

Color of flares.

-

RANGE.PlayerData.flaredirecthits

 -

Flare when player directly hits a target.

-

RANGE.PlayerData.inzone

 -

If true, player is inside the range zone.

-

RANGE.PlayerData.messages

 -

Display info messages.

-

RANGE.PlayerData.playername

 -

Name of player.

-

RANGE.PlayerData.smokebombimpact

 -

Smoke bomb impact points.

-

RANGE.PlayerData.smokecolor

 -

Color of smoke.

-

RANGE.PlayerData.targeton

 -

Target on.

-

RANGE.PlayerData.unit

 -

Player unit.

-

RANGE.PlayerData.unitname

 -

Name of player aircraft unit.

-
-
- -

Type RANGE.Sound

-
- RANGE.Sound -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.SoundDescription

RANGE.Sound.IR0

 - -

RANGE.Sound.IR1

 - -

RANGE.Sound.IR2

 - -

RANGE.Sound.IR3

 - -

RANGE.Sound.IR4

 - -

RANGE.Sound.IR5

 - -

RANGE.Sound.IR6

 - -

RANGE.Sound.IR7

 - -

RANGE.Sound.IR8

 - -

RANGE.Sound.IR9

 - -

RANGE.Sound.IRDecimal

 - -

RANGE.Sound.IREnterRange

 - -

RANGE.Sound.IRExitRange

 - -

RANGE.Sound.IRMegaHertz

 - -

RANGE.Sound.RC0

 - -

RANGE.Sound.RC1

 - -

RANGE.Sound.RC2

 - -

RANGE.Sound.RC3

 - -

RANGE.Sound.RC4

 - -

RANGE.Sound.RC5

 - -

RANGE.Sound.RC6

 - -

RANGE.Sound.RC7

 - -

RANGE.Sound.RC8

 - -

RANGE.Sound.RC9

 - -

RANGE.Sound.RCAccuracy

 - -

RANGE.Sound.RCDegrees

 - -

RANGE.Sound.RCExcellentHit

 - -

RANGE.Sound.RCExcellentPass

 - -

RANGE.Sound.RCFeet

 - -

RANGE.Sound.RCFor

 - -

RANGE.Sound.RCGoodHit

 - -

RANGE.Sound.RCGoodPass

 - -

RANGE.Sound.RCHitsOnTarget

 - -

RANGE.Sound.RCImpact

 - -

RANGE.Sound.RCIneffectiveHit

 - -

RANGE.Sound.RCIneffectivePass

 - -

RANGE.Sound.RCInvalidHit

 - -

RANGE.Sound.RCLeftStrafePitTooQuickly

 - -

RANGE.Sound.RCPercent

 - -

RANGE.Sound.RCPoorHit

 - -

RANGE.Sound.RCPoorPass

 - -

RANGE.Sound.RCRollingInOnStrafeTarget

 - -

RANGE.Sound.RCTotalRoundsFired

 - -

RANGE.Sound.RCWeaponImpactedTooFar

 - -
-
- -

Type RANGE.Soundfile

-
- RANGE.Soundfile -
-
- - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.SoundfileDescription

RANGE.Soundfile.duration

 -

Duration in seconds.

-

RANGE.Soundfile.filename

 -

Name of the file

-
-
- -

Type RANGE.StrafeResult

-
- RANGE.StrafeResult -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.StrafeResultDescription

RANGE.StrafeResult.airframe

 -

Aircraft type of player.

-

RANGE.StrafeResult.clock

 -

Time of the run.

-

RANGE.StrafeResult.command

 - -

RANGE.StrafeResult.date

 -

OS date.

-

RANGE.StrafeResult.invalid

 -

Invalid pass.

-

RANGE.StrafeResult.midate

 - -

RANGE.StrafeResult.name

 -

Name of the target pit.

-

RANGE.StrafeResult.player

 -

Player name.

-

RANGE.StrafeResult.rangename

 -

Name of the range.

-

RANGE.StrafeResult.roundsFired

 -

Number of rounds fired.

-

RANGE.StrafeResult.roundsHit

 -

Number of rounds that hit the target.

-

RANGE.StrafeResult.roundsQuality

 - -

RANGE.StrafeResult.strafeAccuracy

 -

Accuracy of the run in percent.

-

RANGE.StrafeResult.theatre

 - -

RANGE.StrafeResult.time

 -

Time via timer.getAbsTime() in seconds of impact.

-
-
- -

Type RANGE.StrafeStatus

-
- RANGE.StrafeStatus -
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.StrafeStatusDescription

RANGE.StrafeStatus.ammo

 -

Amount of ammo.

-

RANGE.StrafeStatus.hits

 -

Number of hits on target.

-

RANGE.StrafeStatus.pastfoulline

 -

If true, player passed foul line. Invalid pass.

-

RANGE.StrafeStatus.time

 -

Number of times.

-

RANGE.StrafeStatus.zone

 -

Strafe target.

-
-
- -

Type RANGE.StrafeTarget

-
- RANGE.StrafeTarget -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.StrafeTargetDescription

RANGE.StrafeTarget.coordinate

 -

Center coordinate of the pit.

-

RANGE.StrafeTarget.foulline

 -

Foul line

-

RANGE.StrafeTarget.goodPass

 -

Number of hits for a good pass.

-

RANGE.StrafeTarget.heading

 -

Heading of pit.

-

RANGE.StrafeTarget.name

 -

Name of the unit.

-

RANGE.StrafeTarget.polygon

 -

Polygon zone.

-

RANGE.StrafeTarget.smokepoints

 -

Number of smoke points.

-

RANGE.StrafeTarget.targets

 -

Table of target units.

-
-
- -

Type RANGE.TargetType

-
- RANGE.TargetType -
-
- - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from RANGE.TargetTypeDescription

RANGE.TargetType.COORD

 -

Target is a coordinate.

-

RANGE.TargetType.SCENERY

 -

Target is a scenery object.

-

RANGE.TargetType.STATIC

 -

Target is a static object.

-

RANGE.TargetType.UNIT

 -

Target is a unitobject.

-
-
- -

Type Functional.Range

-
-
-
- -
-

Type RANGE

-
-
- -

RANGE class

- -
-

Field(s)

-
-
-
- - Utilities.Utils#SMOKECOLOR -RANGE.BombSmokeColor - -

Color id used for smoking bomb targets.

- -
- -
-
-
- - #number -RANGE.BombtrackThreshold - -

Bombs/rockets/missiles are only tracked if player-range distance is smaller than this threshold [m]. Default 25000 m.

- -
- -
-
-
- - #string -RANGE.ClassName - -

Name of the Class.

- -
- -
-
-
- - #number -RANGE.Coalition - -

Coalition side for the menu, if any.

- -
- -
-
-
- - #boolean -RANGE.Debug - -

If true, debug info is sent as messages on the screen.

- -
- -
-
-
- - #RANGE.Defaults -RANGE.Defaults - - - -
- -
-
-
- - #table -RANGE.MenuAddedTo - -

Table for monitoring which players already got an F10 menu.

- -
- -
-
-
- - #table -RANGE.MenuF10 - -

Main radio menu on group level.

- -
- -
-
-
- - #table -RANGE.MenuF10Root - -

Main radio menu on mission level.

- -
- -
-
-
- - #table -RANGE.Names - -

Global list of all defined range names.

- -
- -
-
-
- - #table -RANGE.PlayerSettings - -

Individual player settings.

- -
- -
-
-
- - #RANGE.Sound -RANGE.Sound - - - -
- -
-
-
- - Utilities.Utils#SMOKECOLOR -RANGE.StrafePitSmokeColor - -

Color id used to smoke strafe pit approach boxes.

- -
- -
-
-
- - Utilities.Utils#SMOKECOLOR -RANGE.StrafeSmokeColor - -

Color id used to smoke strafe targets.

- -
- -
-
-
- - #RANGE.TargetType -RANGE.TargetType - - - -
- -
-
-
- - #number -RANGE.TdelaySmoke - -

Time delay in seconds between impact of bomb and starting the smoke. Default 3 seconds.

- -
- -
-
-
- - #number -RANGE.Tmsg - -

Time [sec] messages to players are displayed. Default 30 sec.

- -
- -
-
-
- - #boolean -RANGE.autosave - -

If true, automatically save results every X seconds.

- -
- -
-
-
- - #table -RANGE.bombPlayerResults - -

Table containing the bombing results of each player.

- -
- -
-
-
- - #table -RANGE.bombingTargets - -

Table of targets to bomb.

- -
- -
-
-
- - Sound.SRS#MSRS -RANGE.controlmsrs - -

SRS wrapper for range controller.

- -
- -
-
-
- - Sound.SRS#MSRSQUEUE -RANGE.controlsrsQ - -

SRS queue for range controller.

- -
- -
-
-
- - #boolean -RANGE.defaultsmokebomb - -

If true, initialize player settings to smoke bomb.

- -
- -
-
-
- - #number -RANGE.dtBombtrack - -

Time step [sec] used for tracking released bomb/rocket positions. Default 0.005 seconds.

- -
- -
-
-
- - #boolean -RANGE.examinerexclusive - -

If true, only the examiner gets messages. If false, clients and examiner get messages.

- -
- -
-
-
- - #string -RANGE.examinergroupname - -

Name of the examiner group which should get all messages.

- -
- -
-
-
- - -RANGE.funkmanSocket - - - -
- -
-
-
- - #number -RANGE.illuminationmaxalt - -

Maximum altitude in meters AGL at which illumination bombs are fired. Default is 1000 m.

- -
- -
-
-
- - #number -RANGE.illuminationminalt - -

Minimum altitude in meters AGL at which illumination bombs are fired. Default is 500 m.

- -
- -
-
-
- - Sound.SRS#MSRS -RANGE.instructmsrs - -

SRS wrapper for range instructor.

- -
- -
-
-
- - Sound.RadioQueue#RADIOQUEUE -RANGE.instructor - -

Instructor radio queue.

- -
- -
-
-
- - #number -RANGE.instructorfreq - -

Frequency on which the range control transmitts.

- -
- -
-
-
- - #string -RANGE.instructorrelayname - -

Name of relay unit.

- -
- -
-
-
- - Sound.SRS#MSRSQUEUE -RANGE.instructsrsQ - -

SRS queue for range instructor.

- -
- -
-
-
- - #string -RANGE.lid - -

String id of range for output in DCS log.

- -
- -
-
-
- - Core.Point#COORDINATE -RANGE.location - -

Coordinate of the range location.

- -
- -
-
-
- - Core.Menu#MENU_MISSION -RANGE.menuF10root - -

Specific user defined root F10 menu.

- -
- -
-
-
- - #boolean -RANGE.messages - -

Globally enable/disable all messages to players.

- -
- -
-
-
- - #number -RANGE.nbombtargets - -

Number of bombing targets.

- -
- -
-
-
- - #number -RANGE.ndisplayresult - -

Number of (player) results that a displayed. Default is 10.

- -
- -
-
-
- - #number -RANGE.nstrafetargets - -

Number of strafing targets.

- -
- -
-
-
- - #table -RANGE.planes - -

Table for administration.

- -
- -
-
-
- - Sound.RadioQueue#RADIOQUEUE -RANGE.rangecontrol - -

Range control radio queue.

- -
- -
-
-
- - #number -RANGE.rangecontrolfreq - -

Frequency on which the range control transmitts.

- -
- -
-
-
- - #string -RANGE.rangecontrolrelayname - -

Name of relay unit.

- -
- -
-
-
- - #string -RANGE.rangename - -

Name of the range.

- -
- -
-
-
- - #number -RANGE.rangeradius - -

Radius of range defining its total size for e.g. smoking bomb impact points and sending radio messages. Default 5 km.

- -
- -
-
-
- - Core.Zone#ZONE -RANGE.rangezone - -

MOOSE zone object of the range. For example, no bomb impacts are smoked if bombs fall outside of the range zone.

- -
- -
-
-
- - #number -RANGE.scorebombdistance - -

Distance from closest target up to which bomb hits are counted. Default 1000 m.

- -
- -
-
-
- - #string -RANGE.soundpath - -

Path inside miz file where the sound files are located. Default is "Range Soundfiles/".

- -
- -
-
-
- - #table -RANGE.strafePlayerResults - -

Table containing the strafing results of each player.

- -
- -
-
-
- - #table -RANGE.strafeStatus - -

Table containing the current strafing target a player as assigned to.

- -
- -
-
-
- - #table -RANGE.strafeTargets - -

Table of strafing targets.

- -
- -
-
-
- - #number -RANGE.strafemaxalt - -

Maximum altitude in meters AGL for registering for a strafe run. Default is 914 m = 3000 ft.

- -
- -
-
-
- - #string -RANGE.targetpath - -

Path where to save the target sheets.

- -
- -
-
-
- - #string -RANGE.targetprefix - -

File prefix for target sheet files.

- -
- -
-
-
- - #boolean -RANGE.targetsheet - -

If true, players can save their target sheets. Rangeboss will not work if targetsheets do not save.

- -
- -
-
-
- - -RANGE.timerCheckZone - - - -
- -
-
-
- - #boolean -RANGE.trackbombs - -

If true (default), all bomb types are tracked and impact point to closest bombing target is evaluated.

- -
- -
-
-
- - #boolean -RANGE.trackmissiles - -

If true (default), all missile types are tracked and impact point to closest bombing target is evaluated.

- -
- -
-
-
- - #boolean -RANGE.trackrockets - -

If true (default), all rocket types are tracked and impact point to closest bombing target is evaluated.

- -
- -
-
-
- - #boolean -RANGE.useSRS - - - -
- -
-
-
- - #boolean -RANGE.verbose - -

Verbosity level. Higher means more output to DCS log file.

- -
- -
-
-
- - #string -RANGE.version - -

Range script version.

- -
- -
-
-

Function(s)

-
-
- -
-

RANGE:AddBombingTargetCoordinate(coord, name, goodhitrange)

-
- -

Add a coordinate of a bombing target.

- - -

This

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Core.Point#COORDINATE - coord -

-
-
- -

The coordinate.

- -
-
-
-
-

- #string - name -

-
-
- -

Name of target.

- -
-
-
-
-

- #number - goodhitrange -

-
-
- -

Max distance from unit which is considered as a good hit.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:AddBombingTargetGroup(group, goodhitrange, randommove)

-
- -

Add all units of a group as bombing targets.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Wrapper.Group#GROUP - group -

-
-
- -

Group of bombing targets. Can also be given as group name.

- -
-
-
-
-

- #number - goodhitrange -

-
-
- -

Max distance from unit which is considered as a good hit.

- -
-
-
-
-

- #boolean - randommove -

-
-
- -

If true, unit will move randomly within the range. Default is false.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:AddBombingTargetScenery(scenery, goodhitrange)

-
- -

Add a scenery object as bombing target.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Wrapper.Scenery#SCENERY - scenery -

-
-
- -

Scenary object.

- -
-
-
-
-

- #number - goodhitrange -

-
-
- -

Max distance from unit which is considered as a good hit.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:AddBombingTargetUnit(unit, goodhitrange, randommove)

-
- -

Add a unit or static object as bombing target.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Wrapper.Positionable#POSITIONABLE - unit -

-
-
- -

Positionable (unit or static) of the bombing target.

- -
-
-
-
-

- #number - goodhitrange -

-
-
- -

Max distance from unit which is considered as a good hit.

- -
-
-
-
-

- #boolean - randommove -

-
-
- -

If true, unit will move randomly within the range. Default is false.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:AddBombingTargets(targetnames, goodhitrange, randommove)

-
- -

Add bombing target(s) to range.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #table - targetnames -

-
-
- -

Single or multiple (Table) names of unit or static objects serving as bomb targets.

- -
-
-
-
-

- #number - goodhitrange -

-
-
- -

(Optional) Max distance from target unit (in meters) which is considered as a good hit. Default is 25 m.

- -
-
-
-
-

- #boolean - randommove -

-
-
- -

If true, unit will move randomly within the range. Default is false.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:AddStrafePit(targetnames, boxlength, boxwidth, heading, inverseheading, goodpass, foulline)

-
- -

Add new strafe pit.

- - -

For a strafe pit, hits from guns are counted. One pit can consist of several units. -A strafe run approach is only valid if the player enters via a zone in front of the pit, which is defined by boxlength, boxwidth, and heading. -Furthermore, the player must not be too high and fly in the direction of the pit to make a valid target apporoach.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #table - targetnames -

-
-
- -

Single or multiple (Table) unit or static names defining the strafe targets. The first target in the list determines the approach box origin (heading and box).

- -
-
-
-
-

- #number - boxlength -

-
-
- -

(Optional) Length of the approach box in meters. Default is 3000 m.

- -
-
-
-
-

- #number - boxwidth -

-
-
- -

(Optional) Width of the approach box in meters. Default is 300 m.

- -
-
-
-
-

- #number - heading -

-
-
- -

(Optional) Approach box heading in degrees (originating FROM the target). Default is the heading set in the ME for the first target unit

- -
-
-
-
-

- #boolean - inverseheading -

-
-
- -

(Optional) Use inverse heading (heading --> heading - 180 Degrees). Default is false.

- -
-
-
-
-

- #number - goodpass -

-
-
- -

(Optional) Number of hits for a "good" strafing pass. Default is 20.

- -
-
-
-
-

- #number - foulline -

-
-
- -

(Optional) Foul line distance. Hits from closer than this distance are not counted. Default is 610 m = 2000 ft. Set to 0 for no foul line.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:AddStrafePitGroup(group, boxlength, boxwidth, heading, inverseheading, goodpass, foulline)

-
- -

Add all units of a group as one new strafe target pit.

- - -

For a strafe pit, hits from guns are counted. One pit can consist of several units. -Note, an approach is only valid, if the player enters via a zone in front of the pit, which defined by boxlength and boxheading. -Furthermore, the player must not be too high and fly in the direction of the pit to make a valid target apporoach.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Wrapper.Group#GROUP - group -

-
-
- -

MOOSE group of unit names defining the strafe target pit. The first unit in the group determines the approach zone (heading and box).

- -
-
-
-
-

- #number - boxlength -

-
-
- -

(Optional) Length of the approach box in meters. Default is 3000 m.

- -
-
-
-
-

- #number - boxwidth -

-
-
- -

(Optional) Width of the approach box in meters. Default is 300 m.

- -
-
-
-
-

- #number - heading -

-
-
- -

(Optional) Approach heading in Degrees. Default is heading of the unit as defined in the mission editor.

- -
-
-
-
-

- #boolean - inverseheading -

-
-
- -

(Optional) Take inverse heading (heading --> heading - 180 Degrees). Default is false.

- -
-
-
-
-

- #number - goodpass -

-
-
- -

(Optional) Number of hits for a "good" strafing pass. Default is 20.

- -
-
-
-
-

- #number - foulline -

-
-
- -

(Optional) Foul line distance. Hits from closer than this distance are not counted. Default 610 m = 2000 ft. Set to 0 for no foul line.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:DebugOFF()

-
- -

Disable debug modus.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:DebugON()

-
- -

Enable debug modus.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:EnterRange(player)

-
- -

Triggers the FSM event "EnterRange".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:ExitRange(player)

-
- -

Triggers the FSM event "ExitRange".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:GetFoullineDistance(namepit, namefoulline)

-
- -

Measures the foule line distance between two unit or static objects.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - namepit -

-
-
- -

Name of the strafe pit target object.

- -
-
-
-
-

- #string - namefoulline -

-
-
- -

Name of the fould line distance marker object.

- -
-
-

Return value:

-
-
-

#number:

-
-
- -

Foul line distance in meters.

- -
-
-
- -
-
- -
- -
-

RANGE:Impact(result, player)

-
- -

Triggers the FSM event "Impact".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #RANGE.BombResult - result -

-
-
- -

Data of bombing run.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:New(RangeName, Coalition)

-
- -

RANGE contructor.

- - -

Creates a new RANGE object.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - RangeName -

-
-
- -

Name of the range. Has to be unique. Will we used to create F10 menu items etc.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

(optional) Coalition of the range, if any, e.g. coalition.side.BLUE.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

RANGE object.

- -
-
-
- -
-
- -
- -
-

RANGE:OnAfterEnterRange(From, Event, To, player)

-
- -

On after "EnterRange" event user function.

- - -

Called when a player enters the range zone.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:OnAfterExitRange(From, Event, To, player)

-
- -

On after "ExitRange" event user function.

- - -

Called when a player leaves the range zone.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:OnAfterImpact(From, Event, To, result, player)

-
- -

On after "Impact" event user function.

- - -

Called when a bomb/rocket/missile impacted.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.BombResult - result -

-
-
- -

Data of the bombing run.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:OnAfterRollingIn(From, Event, To, player, target)

-
- -

On after "RollingIn" event user function.

- - -

Called when a player rolls in to a strafe taret.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
-
-

- #RANGE.StrafeTarget - target -

-
-
- -

Strafe target.

- -
-
-
- -
-
- -
- -
-

RANGE:OnAfterStrafeResult(From, Event, To, player, result)

-
- -

On after "StrafeResult" event user function.

- - -

Called when a player finished a strafing run.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
-
-

- #RANGE.StrafeResult - result -

-
-
- -

Data of the strafing run.

- -
-
-
- -
-
- -
- -
-

RANGE:OnEventBirth(EventData)

-
- -

Range event handler for event birth.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RANGE:OnEventHit(EventData)

-
- -

Range event handler for event hit.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RANGE:OnEventShot(EventData)

-
- -

Range event handler for event shot (when a unit releases a rocket or bomb (but not a fast firing gun).

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
-

-
-
-
- -
-
- -
- -
-

RANGE:RollingIn(player, target)

-
- -

Triggers the FSM event "RollingIn".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
-
-

- #RANGE.StrafeTarget - target -

-
-
- -

Strafe target.

- -
-
-
- -
-
- -
- -
-

RANGE:SetAutosaveOff()

-
- -

Switch off auto save player results.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetAutosaveOn()

-
- -

Automatically save player results to disc.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetBombTargetSmokeColor(colorid)

-
- -

Set smoke color for marking bomb targets.

- - -

By default bomb targets are marked by red smoke.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Utilities.Utils#SMOKECOLOR - colorid -

-
-
- -

Color id. Default SMOKECOLOR.Red.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetBombtrackThreshold(distance)

-
- -

Set bomb track threshold distance.

- - -

Bombs/rockets/missiles are only tracked if player-range distance is less than this distance. Default 25 km.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - distance -

-
-
- -

Threshold distance in km. Default 25 km.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetBombtrackTimestep(dt)

-
- -

Set time interval for tracking bombs.

- - -

A smaller time step increases accuracy but needs more CPU time.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - dt -

-
-
- -

Time interval in seconds. Default is 0.005 s.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetDefaultPlayerSmokeBomb(switch)

-
- -

Set player setting whether bomb impact points are smoked or not.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #boolean - switch -

-
-
- -

If true nor nil default is to smoke impact points of bombs.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetDisplayedMaxPlayerResults(nmax)

-
- -

Set max number of player results that are displayed.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - nmax -

-
-
- -

Number of results. Default is 10.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetFunkManOn(Port, Host)

-
- -

Set FunkMan socket.

- - -

Bombing and strafing results will be send to your Discord bot. -Requires running FunkMan program.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - Port -

-
-
- -

Port. Default 10042.

- -
-
-
-
-

- #string - Host -

-
-
- -

Host. Default "127.0.0.1".

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetInstructorRadio(frequency, relayunitname)

-
- -

Enable instructor radio and set frequency (non-SRS).

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - frequency -

-
-
- -

Frequency in MHz. Default 305 MHz.

- -
-
-
-
-

- #string - relayunitname -

-
-
- -

Name of the unit used for transmission.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetMaxStrafeAlt(maxalt)

-
- -

Set maximal strafing altitude.

- - -

Player entering a strafe pit above that altitude are not registered for a valid pass.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - maxalt -

-
-
- -

Maximum altitude in meters AGL. Default is 914 m = 3000 ft.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetMenuRoot(menu)

-
- -

Set the root F10 menu under which the range F10 menu is created.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Core.Menu#MENU_MISSION - menu -

-
-
- -

The root F10 menu.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetMessageTimeDuration(time)

-
- -

Set time how long (most) messages are displayed.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - time -

-
-
- -

Time in seconds. Default is 30 s.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetMessageToExaminer(examinergroupname, exclusively)

-
- -

Set messages to examiner.

- - -

The examiner will receive messages from all clients.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - examinergroupname -

-
-
- -

Name of the group of the examiner.

- -
-
-
-
-

- #boolean - exclusively -

-
-
- -

If true, messages are send exclusively to the examiner, i.e. not to the clients.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetMessagesOFF()

-
- -

Disable ALL messages to players.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetMessagesON()

-
- -

Enable messages to players.

- - -

This is the default

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetRangeControl(frequency, relayunitname)

-
- -

Enable range control and set frequency (non-SRS).

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - frequency -

-
-
- -

Frequency in MHz. Default 256 MHz.

- -
-
-
-
-

- #string - relayunitname -

-
-
- -

Name of the unit used for transmission.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetRangeLocation(coordinate)

-
- -

Set range location.

- - -

If this is not done, one (random) unit position of the range is used to determine the location of the range. -The range location determines the position at which the weather data is evaluated.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Core.Point#COORDINATE - coordinate -

-
-
- -

Coordinate of the range.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetRangeRadius(radius)

-
- -

Set range radius.

- - -

Defines the area in which e.g. bomb impacts are smoked.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - radius -

-
-
- -

Radius in km. Default 5 km.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetRangeZone(zone)

-
- -

Set range zone.

- - -

For example, no bomb impact points are smoked if a bomb falls outside of this zone. -If a zone is not explicitly specified, the range zone is determined by its location and radius.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Core.Zone#ZONE - zone -

-
-
- -

MOOSE zone defining the range perimeters.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume, PathToGoogleKey)

-
- -

Use SRS Simple-Text-To-Speech for transmissions.

- - -

No sound files necessary.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - PathToSRS -

-
-
- -

Path to SRS directory.

- -
-
-
-
-

- #number - Port -

-
-
- -

SRS port. Default 5002.

- -
-
-
-
-

- #number - Coalition -

-
-
- -

Coalition side, e.g. coalition.side.BLUE or coalition.side.RED. Default coalition.side.BLUE.

- -
-
-
-
-

- #number - Frequency -

-
-
- -

Frequency to use. Default is 256 MHz for range control and 305 MHz for instructor. If given, both control and instructor get this frequency.

- -
-
-
-
-

- #number - Modulation -

-
-
- -

Modulation to use, defaults to radio.modulation.AM

- -
-
-
-
-

- #number - Volume -

-
-
- -

Volume, between 0.0 and 1.0. Defaults to 1.0

- -
-
-
-
-

- #string - PathToGoogleKey -

-
-
- -

Path to Google TTS credentials.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetSRSRangeControl(frequency, modulation, voice, culture, gender, relayunitname)

-
- -

(SRS) Set range control frequency and voice.

- - -

Use RANGE:SetSRS() once first before using this function.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - frequency -

-
-
- -

Frequency in MHz. Default 256 MHz.

- -
-
-
-
-

- #number - modulation -

-
-
- -

Modulation, defaults to radio.modulation.AM.

- -
-
-
-
-

- #string - voice -

-
-
- -

Voice.

- -
-
-
-
-

- #string - culture -

-
-
- -

Culture, defaults to "en-US".

- -
-
-
-
-

- #string - gender -

-
-
- -

Gender, defaults to "female".

- -
-
-
-
-

- #string - relayunitname -

-
-
- -

Name of the unit used for transmission location.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetSRSRangeInstructor(frequency, modulation, voice, culture, gender, relayunitname)

-
- -

(SRS) Set range instructor frequency and voice.

- - -

Use RANGE:SetSRS() once first before using this function.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - frequency -

-
-
- -

Frequency in MHz. Default 305 MHz.

- -
-
-
-
-

- #number - modulation -

-
-
- -

Modulation, defaults to radio.modulation.AM.

- -
-
-
-
-

- #string - voice -

-
-
- -

Voice.

- -
-
-
-
-

- #string - culture -

-
-
- -

Culture, defaults to "en-US".

- -
-
-
-
-

- #string - gender -

-
-
- -

Gender, defaults to "male".

- -
-
-
-
-

- #string - relayunitname -

-
-
- -

Name of the unit used for transmission location.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetScoreBombDistance(distance)

-
- -

Set score bomb distance.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - distance -

-
-
- -

Distance in meters. Default 1000 m.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetSmokeTimeDelay(delay)

-
- -

Set time delay between bomb impact and starting to smoke the impact point.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - delay -

-
-
- -

Time delay in seconds. Default is 3 seconds.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetSoundfilesInfo(csvfile)

-
- -

Set the path to the csv file that contains information about the used sound files.

- - -

The parameter file has to be located on your local disk (not inside the miz file).

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - csvfile -

-
-
- -

Full path to the csv file on your local disk.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetSoundfilesPath(path)

-
- -

Set sound files folder within miz file.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - path -

-
-
- -

Path for sound files. Default "Range Soundfiles/". Mind the slash "/" at the end!

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetStrafePitSmokeColor(colorid)

-
- -

Set smoke color for marking strafe pit approach boxes.

- - -

By default strafe pit boxes are marked by white smoke.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Utilities.Utils#SMOKECOLOR - colorid -

-
-
- -

Color id. Default SMOKECOLOR.White.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetStrafeTargetSmokeColor(colorid)

-
- -

Set smoke color for marking strafe targets.

- - -

By default strafe targets are marked by green smoke.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Utilities.Utils#SMOKECOLOR - colorid -

-
-
- -

Color id. Default SMOKECOLOR.Green.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetTargetSheet(path, prefix)

-
- -

Enable saving of player's target sheets and specify an optional directory path.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - path -

-
-
- -

(Optional) Path where to save the target sheets.

- -
-
-
-
-

- #string - prefix -

-
-
- -

(Optional) Prefix for target sheet files. File name will be saved as *prefix_aircrafttype-0001.csv*, *prefix_aircrafttype-0002.csv*, etc.

- -
-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:Start()

-
- -

Triggers the FSM event "Start".

- - -

Starts the RANGE. Initializes parameters and starts event handlers.

- -
-
-

Defined in:

-
-

RANGE

-
-
- -
-
- -
- -
-

RANGE:Status()

-
- -

Triggers the FSM event "Status".

- -
-
-

Defined in:

-
-

RANGE

-
-
- -
-
- -
- -
-

RANGE:StrafeResult(player, result)

-
- -

Triggers the FSM event "StrafeResult".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
-
-

- #RANGE.StrafeResult - result -

-
-
- -

Data of the strafing run.

- -
-
-
- -
-
- -
- -
-

RANGE:TrackBombsOFF()

-
- -

Disables tracking of all bomb types.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:TrackBombsON()

-
- -

Enables tracking of all bomb types.

- - -

Note that this is the default setting.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:TrackMissilesOFF()

-
- -

Disables tracking of all missile types.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:TrackMissilesON()

-
- -

Enables tracking of all missile types.

- - -

Note that this is the default setting.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:TrackRocketsOFF()

-
- -

Disables tracking of all rocket types.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:TrackRocketsON()

-
- -

Enables tracking of all rocket types.

- - -

Note that this is the default setting.

- -
-
-

Defined in:

-
-

RANGE

-
-

Return value:

-
-
-

#RANGE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:_AddF10Commands(_unitName)

-
- -

Add menu commands for player.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_CheckInZone(_unitName)

-
- -

Check if player is inside a strafing zone.

- - -

If he is, we start looking for hits. If he was and left the zone again, the result is stored.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_CheckPlayers(_unitName)

-
- -

Check status of players.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_CheckStatic(name)

-
- -

Checks if a static object with a certain name exists.

- - -

It also added it to the MOOSE data base, if it is not already in there.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - name -

-
-
- -

Name of the potential static object.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

Returns true if a static with this name exists. Retruns false if a unit with this name exists. Returns nil if neither unit or static exist.

- -
-
-
- -
-
- -
- -
-

RANGE._DelayedSmoke(_args)

-
- -

Start smoking a coordinate with a delay.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #table - _args -

-
-
- -

Argements passed.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayBombTargets(_unitname)

-
- -

Display bombing target locations to player.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayBombingResults(_unitName)

-
- -

Display best bombing results of top 10 players.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayMessageToGroup(_unit, _text, _time, _clear, display, _togroup)

-
- -

Display message to group.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Wrapper.Unit#UNIT - _unit -

-
-
- -

Player unit.

- -
-
-
-
-

- #string - _text -

-
-
- -

Message text.

- -
-
-
-
-

- #number - _time -

-
-
- -

Duration how long the message is displayed.

- -
-
-
-
-

- #boolean - _clear -

-
-
- -

Clear up old messages.

- -
-
-
-
-

- #boolean - display -

-
-
- -

If true, display message regardless of player setting "Messages Off".

- -
-
-
-
-

- #boolean - _togroup -

-
-
- -

If true, display the message to the group in any case

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayMyBombingResults(_unitName)

-
- -

Display top 10 bombing run results of specific player.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayMyStrafePitResults(_unitName)

-
- -

Display top 10 stafing results of a specific player.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayRangeInfo(_unitname)

-
- -

Report information like bearing and range from player unit to range.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayRangeWeather(_unitname)

-
- -

Report weather conditions at range.

- - -

Temperature, QFE pressure and wind data.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayStrafePitResults(_unitName)

-
- -

Display top 10 strafing results of all players.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name fo the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_DisplayStrafePits(_unitname)

-
- -

Display pit location and heading to player.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_FlareDirectHitsOnOff(unitname)

-
- -

Toggle status of flaring direct hits of range targets.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_GetAmmo(unitname)

-
- -

Get the number of shells a unit currently has.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-

Return value:

-
-
-
-
- -

Number of shells left

- -
-
-
- -
-
- -
- -
-

RANGE:_GetBombTargetCoordinate(target)

-
- -

Get the number of shells a unit currently has.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #RANGE.BombTarget - target -

-
-
- -

Bomb target data.

- -
-
-

Return value:

-
-
-

Core.Point#COORDINATE:

-
-
- -

Target coordinate.

- -
-
-
- -
-
- -
- -
-

RANGE:_GetPlayerUnitAndName(_unitName, PlayerName)

-
- -

Returns the unit of a player and the player name.

- - -

If the unit does not belong to a player, nil is returned.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
-
-

- PlayerName -

-
-
-

-
-
-

Return values:

-
-
-

Wrapper.Unit#UNIT:

-
-
- -

Unit of player.

- -
-
-

#string:

-
-
- -

Name of the player.

- -
-
-

#boolean:

-
-
- -

If true, group has > 1 player in it

- -
-
-
- -
-
- -
- -
-

RANGE:_GetSpeed(controllable)

-
- -

Get max speed of controllable.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - controllable -

-
-
-

-
-
-

Return value:

-
-
-
-
- -

Maximum speed in km/h.

- -
-
-
- -
-
- -
- -
-

RANGE:_IlluminateBombTargets(_unitName)

-
- -

Illuminate targets.

- - -

Fires illumination bombs at one random bomb and one random strafe target at a random altitude between 400 and 800 m.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

(Optional) Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_MarkTargetsOnMap(_unitName)

-
- -

Mark targets on F10 map.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_MessagesToPlayerOnOff(unitname)

-
- -

Toggle display messages to player.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE._OnImpact(weapon, self, playerData, attackHdg, attackAlt, attackVel)

-
- -

Function called on impact of a tracked weapon.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- Wrapper.Weapon#WEAPON - weapon -

-
-
- -

The weapon object.

- -
-
-
-
-

- #RANGE - self -

-
-
- -

RANGE object.

- -
-
-
-
-

- #RANGE.PlayerData - playerData -

-
-
- -

Player data table.

- -
-
-
-
-

- #number - attackHdg -

-
-
- -

Attack heading.

- -
-
-
-
-

- #number - attackAlt -

-
-
- -

Attack altitude.

- -
-
-
-
-

- #number - attackVel -

-
-
- -

Attack velocity.

- -
-
-
- -
-
- -
- -
-

RANGE:_ResetRangeStats(_unitName)

-
- -

Reset player statistics.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_SaveTargetSheet(_playername, result)

-
- -

Save target sheet.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - _playername -

-
-
- -

Player name.

- -
-
-
-
-

- #RANGE.StrafeResult - result -

-
-
- -

Results table.

- -
-
-
- -
-
- -
- -
-

RANGE:_SmokeBombDelayOnOff(unitname)

-
- -

Toggle status of time delay for smoking bomb impact points

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_SmokeBombImpactOnOff(unitname)

-
- -

Toggle status of smoking bomb impact points.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_SmokeBombTargets(unitname)

-
- -

Mark bombing targets with smoke.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_SmokeStrafeTargetBoxes(unitname)

-
- -

Mark approach boxes of strafe targets with smoke.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_SmokeStrafeTargets(unitname)

-
- -

Mark strafing targets with smoke.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_TargetsheetOnOff(_unitname)

-
- -

Targetsheet saves if player on or off.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - _unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:__EnterRange(delay, player)

-
- -

Triggers the FSM delayed event "EnterRange".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - delay -

-
-
- -

Delay in seconds before the function is called.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:__ExitRange(delay, player)

-
- -

Triggers the FSM delayed event "ExitRange".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - delay -

-
-
- -

Delay in seconds before the function is called.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:__Impact(delay, result, player)

-
- -

Triggers the FSM delayed event "Impact".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #number - delay -

-
-
- -

Delay in seconds before the function is called.

- -
-
-
-
-

- #RANGE.BombResult - result -

-
-
- -

Data of the bombing run.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Data of player settings etc.

- -
-
-
- -
-
- -
- -
-

RANGE:__Start(delay)

-
- -

Triggers the FSM event "Start" after a delay.

- - -

Starts the RANGE. Initializes parameters and starts event handlers.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - delay -

-
-
- -

Delay in seconds.

- -
-
-
- -
-
- -
- -
-

RANGE:__Status(delay)

-
- -

Triggers the FSM event "Status" after a delay.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - delay -

-
-
- -

Delay in seconds.

- -
-
-
- -
-
- -
- -
-

RANGE:__Stop(delay)

-
- -

Triggers the FSM event "Stop" after a delay.

- - -

Stops the RANGE and all its event handlers.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #number - delay -

-
-
- -

Delay in seconds.

- -
-
-
- -
-
- -
- -
-

RANGE:_flarecolor2text(color)

-
- -

Sets the flare color used to flare players direct target hits.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Utilities.Utils#FLARECOLOR - color -

-
-
- -

Color Id.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Color text.

- -
-
-
- -
-
- -
- -
-

RANGE:_myname(unitname)

-
- -

Returns a string which consists of the player name.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- #string - unitname -

-
-
- -

Name of the player unit.

- -
-
-
- -
-
- -
- -
-

RANGE:_playerflarecolor(_unitName, color)

-
- -

Sets the flare color used when player makes a direct hit on target.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
-
-

- Utilities.Utils#FLARECOLOR - color -

-
-
- -

ID of flare color.

- -
-
-
- -
-
- -
- -
-

RANGE:_playersmokecolor(_unitName, color)

-
- -

Sets the smoke color used to smoke players bomb impact points.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - _unitName -

-
-
- -

Name of the player unit.

- -
-
-
-
-

- Utilities.Utils#SMOKECOLOR - color -

-
-
- -

ID of the smoke color.

- -
-
-
- -
-
- -
- -
-

RANGE:_smokecolor2text(color)

-
- -

Converts a smoke color id to text.

- - -

E.g. SMOKECOLOR.Blue --> "blue".

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameter:

-
-
-

- Utilities.Utils#SMOKECOLOR - color -

-
-
- -

Color Id.

- -
-
-

Return value:

-
-
-

#string:

-
-
- -

Color text.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterEnterRange(From, Event, To, player)

-
- -

Function called after player enters the range zone.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Player data.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterExitRange(From, Event, To, player)

-
- -

Function called after player leaves the range zone.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Player data.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterImpact(From, Event, To, result, player)

-
- -

Function called after bomb impact on range.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.BombResult - result -

-
-
- -

Result of bomb impact.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Player data table.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterLoad(From, Event, To)

-
- -

On after "Load" event.

- - -

Loads results of all players from file.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterSave(From, Event, To)

-
- -

Function called after save.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterStart(From, Event, To)

-
- -

Initializes number of targets and location of the range.

- - -

Starts the event handlers.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterStatus(From, Event, To)

-
- -

Check spawn queue and spawn aircraft if necessary.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
- -
-
- -
- -
-

RANGE:onafterStrafeResult(From, Event, To, player, result)

-
- -

Function called after strafing run.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
-
-

- #RANGE.PlayerData - player -

-
-
- -

Player data table.

- -
-
-
-
-

- #RANGE.StrafeResult - result -

-
-
- -

Result of run.

- -
-
-
- -
-
- -
- -
-

RANGE:onbeforeLoad(From, Event, To)

-
- -

Function called before save event.

- - -

Checks that io and lfs are desanitized.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
-
- -
-
- -
- -
-

RANGE:onbeforeSave(From, Event, To)

-
- -

Function called before save event.

- - -

Checks that io and lfs are desanitized.

- -
-
-

Defined in:

-
-

RANGE

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

From state.

- -
-
-
-
-

- #string - Event -

-
-
- -

Event.

- -
-
-
-
-

- #string - To -

-
-
- -

To state.

- -
-
+

Type Functional.Range

+
+
-
-
+
+

Type RANGE

+
+
+ +

RANGE class

Field(s)

@@ -11468,6 +4250,28 @@

Field(s)

+
+
+
+ + #number +RANGE.ceilingaltitude + +

Range ceiling altitude in ft MSL. Aircraft above this altitude are not considered to be in the range. Default is 20000 ft.

+ +
+ +
+
+
+ + #boolean +RANGE.ceilingenabled + +

Range has a ceiling and is not unlimited. Default is false.

+ +
+
@@ -11959,111 +4763,68 @@

Function(s)

-

RANGE:AddEndState(State)

+

RANGE:AddBombingTargetCoordinate(coord, name, goodhitrange)

-

Adds an End state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - State -

-
-
- -

The FSM state.

- -
-
-
- -
-
- -
+

Add a coordinate of a bombing target.

-
-

RANGE:AddProcess(From, Event, Process, ReturnEvents)

-
-

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

+

This

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

-

- #table - From -

-
-
- -

Can contain a string indicating the From state or a table of strings containing multiple From states.

- -
-
-
-
-

- #string - Event +

+ Core.Point#COORDINATE + coord

-

The Event name.

+

The coordinate.

- Core.Fsm#FSM_PROCESS - Process + #string + name

-

An sub-process FSM.

+

Name of target.

- #table - ReturnEvents + #number + goodhitrange

-

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

+

Max distance from unit which is considered as a good hit.

Return value:

-

Core.Fsm#FSM_PROCESS:

+

#RANGE:

-

The SubFSM.

+

self

@@ -12075,61 +4836,61 @@

Return value:

-

RANGE:AddScore(State, ScoreText, Score)

+

RANGE:AddBombingTargetGroup(group, goodhitrange, randommove)

-

Adds a score for the FSM to be achieved.

+

Add all units of a group as bombing targets.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

- #string - State + Wrapper.Group#GROUP + group

-

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

+

Group of bombing targets. Can also be given as group name.

- #string - ScoreText + #number + goodhitrange

-

is a text describing the score that is given according the status.

+

Max distance from unit which is considered as a good hit.

- #number - Score + #boolean + randommove

-

is a number providing the score of the status.

+

If true, unit will move randomly within the range. Default is false.

Return value:

-

#FSM:

+

#RANGE:

@@ -12145,87 +4906,118 @@

Return value:

-

RANGE:AddScoreProcess(From, Event, State, ScoreText, Score)

+

RANGE:AddBombingTargetScenery(scenery, goodhitrange)

-

Adds a score for the FSM_PROCESS to be achieved.

+

Add a scenery object as bombing target.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

- #string - From + Wrapper.Scenery#SCENERY + scenery

-

is the From State of the main process.

+

Scenary object.

- #string - Event + #number + goodhitrange

-

is the Event of the main process.

+

Max distance from unit which is considered as a good hit.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

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

RANGE:AddBombingTargetUnit(unit, goodhitrange, randommove)

+
+ +

Add a unit or static object as bombing target.

+ +
+
+

Defined in:

+
+

RANGE

+
+

Parameters:

- #string - State + Wrapper.Positionable#POSITIONABLE + unit

-

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

+

Positionable (unit or static) of the bombing target.

- #string - ScoreText + #number + goodhitrange

-

is a text describing the score that is given according the status.

+

Max distance from unit which is considered as a good hit.

- #number - Score + #boolean + randommove

-

is a number providing the score of the status.

+

If true, unit will move randomly within the range. Default is false.

Return value:

-

#FSM:

+

#RANGE:

@@ -12241,87 +5033,65 @@

Return value:

-

RANGE:AddTransition(From, Event, To)

+

RANGE:AddBombingTargets(targetnames, goodhitrange, randommove)

-

Add a new transition rule to the FSM.

- - -

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

+

Add bombing target(s) to range.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

#table - From + targetnames

-

Can contain a string indicating the From state or a table of strings containing multiple From states.

+

Single or multiple (Table) names of unit or static objects serving as bomb targets.

- #string - Event + #number + goodhitrange

-

The Event name.

+

(Optional) Max distance from target unit (in meters) which is considered as a good hit. Default is 25 m.

- #string - To + #boolean + randommove

-

The To state.

+

If true, unit will move randomly within the range. Default is false.

-
- -
-
- -
- -
-

RANGE:GetCurrentState()

-
- -

Get current state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-

Return value:

-

#string:

+

#RANGE:

-

Current FSM state.

+

self

@@ -12333,25 +5103,122 @@

Return value:

-

RANGE:GetEndStates()

+

RANGE:AddStrafePit(targetnames, boxlength, boxwidth, heading, inverseheading, goodpass, foulline)

-

Returns the End states.

+

Add new strafe pit.

+ + +

For a strafe pit, hits from guns are counted. One pit can consist of several units. +A strafe run approach is only valid if the player enters via a zone in front of the pit, which is defined by boxlength, boxwidth, and heading. +Furthermore, the player must not be too high and fly in the direction of the pit to make a valid target apporoach.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

+

Parameters:

+
+
+

+ #table + targetnames +

+
+
+ +

Single or multiple (Table) unit or static names defining the strafe targets. The first target in the list determines the approach box origin (heading and box).

+ +
+
+
+
+

+ #number + boxlength +

+
+
+ +

(Optional) Length of the approach box in meters. Default is 3000 m.

+ +
+
+
+
+

+ #number + boxwidth +

+
+
+ +

(Optional) Width of the approach box in meters. Default is 300 m.

+ +
+
+
+
+

+ #number + heading +

+
+
+ +

(Optional) Approach box heading in degrees (originating FROM the target). Default is the heading set in the ME for the first target unit

+ +
+
+
+
+

+ #boolean + inverseheading +

+
+
+ +

(Optional) Use inverse heading (heading --> heading - 180 Degrees). Default is false.

+ +
+
+
+
+

+ #number + goodpass +

+
+
+ +

(Optional) Number of hits for a "good" strafing pass. Default is 20.

+ +
+
+
+
+

+ #number + foulline +

+
+
+ +

(Optional) Foul line distance. Hits from closer than this distance are not counted. Default is 610 m = 2000 ft. Set to 0 for no foul line.

+ +
+

Return value:

-

#table:

+

#RANGE:

-

End states.

+

self

@@ -12363,65 +5230,122 @@

Return value:

-

RANGE:GetProcess(From, Event)

+

RANGE:AddStrafePitGroup(group, boxlength, boxwidth, heading, inverseheading, goodpass, foulline)

+

Add all units of a group as one new strafe target pit.

+ +

For a strafe pit, hits from guns are counted. One pit can consist of several units. +Note, an approach is only valid, if the player enters via a zone in front of the pit, which defined by boxlength and boxheading. +Furthermore, the player must not be too high and fly in the direction of the pit to make a valid target apporoach.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

- From + Wrapper.Group#GROUP + group +

+
+
+ +

MOOSE group of unit names defining the strafe target pit. The first unit in the group determines the approach zone (heading and box).

+ +
+
+
+
+

+ #number + boxlength +

+
+
+ +

(Optional) Length of the approach box in meters. Default is 3000 m.

+ +
+
+
+
+

+ #number + boxwidth

-

+ +

(Optional) Width of the approach box in meters. Default is 300 m.

+

- Event + #number + heading

-

+ +

(Optional) Approach heading in Degrees. Default is heading of the unit as defined in the mission editor.

+
-
- -
-
+
+
+

+ #boolean + inverseheading +

+
+
+ +

(Optional) Take inverse heading (heading --> heading - 180 Degrees). Default is false.

-
+
+
+
+
+

+ #number + goodpass +

+
+
+ +

(Optional) Number of hits for a "good" strafing pass. Default is 20.

-
-

RANGE:GetProcesses()

-
- -

Returns a table of the SubFSM rules defined within the FSM.

+
+
+
+
+

+ #number + foulline +

+
+
+ +

(Optional) Foul line distance. Hits from closer than this distance are not counted. Default 610 m = 2000 ft. Set to 0 for no foul line.

-
-
-

Defined in:

-
-

Core.Fsm#FSM

-
+
+

Return value:

-

#table:

+

#RANGE:

-

Sub processes.

+

self

@@ -12433,25 +5357,25 @@

Return value:

-

RANGE:GetScores()

+

RANGE:DebugOFF()

-

Returns a table with the scores defined.

+

Disable debug modus.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Return value:

-

#table:

+

#RANGE:

-

Scores.

+

self

@@ -12463,25 +5387,25 @@

Return value:

-

RANGE:GetStartState()

+

RANGE:DebugON()

-

Returns the start state of the FSM.

+

Enable debug modus.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Return value:

-

#string:

+

#RANGE:

-

A string containing the start state.

+

self

@@ -12493,25 +5417,42 @@

Return value:

-

RANGE:GetState()

+

RANGE:EnableRangeCeiling(enabled)

-

Get current state.

+

Enable range ceiling.

+ + +

Aircraft must be below the ceiling altitude to be considered in the range zone.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

+

Parameter:

+
+
+

+ #boolean + enabled +

+
+
+ +

True if you would like to enable the ceiling check. If no value give, will Default to false.

+ +
+

Return value:

-

#string:

+

#RANGE:

-

Current FSM state.

+

self

@@ -12523,28 +5464,31 @@

Return value:

-

RANGE:GetSubs()

+

RANGE:EnterRange(player)

-

Returns a table with the Subs defined.

+

Triggers the FSM event "EnterRange".

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Return value:

-
-
-

#table:

-
-
- -

Sub processes.

+

Parameter:

+
+
+

+ #RANGE.PlayerData + player +

+
+
+ +

Data of player settings etc.

-
-
+
+
@@ -12553,28 +5497,31 @@

Return value:

-

RANGE:GetTransitions()

+

RANGE:ExitRange(player)

-

Returns a table of the transition rules defined within the FSM.

+

Triggers the FSM event "ExitRange".

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Return value:

-
-
-

#table:

-
-
- -

Transitions.

+

Parameter:

+
+
+

+ #RANGE.PlayerData + player +

+
+
+ +

Data of player settings etc.

-
-
+
+
@@ -12583,39 +5530,52 @@

Return value:

-

RANGE:Is(State)

+

RANGE:GetFoullineDistance(namepit, namefoulline)

-

Check if FSM is in state.

+

Measures the foule line distance between two unit or static objects.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Parameter:

+

Parameters:

+
+
+

+ #string + namepit +

+
+
+ +

Name of the strafe pit target object.

+ +
+

#string - State + namefoulline

-

State name.

+

Name of the fould line distance marker object.

Return value:

-

#boolean:

+

#number:

-

If true, FSM is in this state.

+

Foul line distance in meters.

@@ -12627,61 +5587,44 @@

Return value:

-

RANGE:LoadCallBacks(CallBackTable)

+

RANGE:Impact(result, player)

-

Load call backs.

+

Triggers the FSM event "Impact".

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Parameter:

+

Parameters:

- #table - CallBackTable + #RANGE.BombResult + result

-

Table of call backs.

+

Data of bombing run.

-
- -
-
- -
- -
-

RANGE:New()

-
- -

Creates a new FSM object.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#FSM:

-
-
- - +
+
+

+ #RANGE.PlayerData + player +

+
+
+ +

Data of player settings etc.

-
-
+
+
@@ -12690,48 +5633,58 @@

Return value:

-

RANGE:SetProcess(From, Event, Fsm)

+

RANGE:New(RangeName, Coalition)

+

RANGE contructor.

+ +

Creates a new RANGE object.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

- From -

-
-
-

-
-
-
-
-

- Event + #string + RangeName

-

+ +

Name of the range. Has to be unique. Will we used to create F10 menu items etc.

+

- Fsm + #number + Coalition

-

+ +

(optional) Coalition of the range, if any, e.g. coalition.side.BLUE.

+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

RANGE object.

+ +
+
@@ -12740,74 +5693,70 @@

Parameters:

-

RANGE:SetStartState(State)

+

RANGE:OnAfterEnterRange(From, Event, To, player)

-

Sets the start state of the FSM.

+

On after "EnterRange" event user function.

+ + +

Called when a player enters the range zone.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Parameter:

+

Parameters:

#string - State + From

-

A string defining the start state.

+

From state.

-
- -
-
- -
- -
-

RANGE:_add_to_map(Map, Event)

-
- -

Add to map.

+
+
+

+ #string + Event +

+
+
+ +

Event.

-
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

+
+

- #table - Map + #string + To

-

Map.

+

To state.

- #table - Event + #RANGE.PlayerData + player

-

Event table.

+

Data of player settings etc.

@@ -12819,28 +5768,31 @@

Parameters:

-

RANGE:_call_handler(step, trigger, params, EventName)

+

RANGE:OnAfterExitRange(From, Event, To, player)

-

Call handler.

+

On after "ExitRange" event user function.

+ + +

Called when a player leaves the range zone.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

#string - step + From

-

Step "onafter", "onbefore", "onenter", "onleave".

+

From state.

@@ -12848,51 +5800,41 @@

Parameters:

#string - trigger + Event

-

Trigger.

+

Event.

- #table - params + #string + To

-

Parameters.

+

To state.

- #string - EventName + #RANGE.PlayerData + player

-

Event name.

+

Data of player settings etc.

-

Return value:

-
-
-
-
- -

Value.

- -
-
@@ -12901,129 +5843,83 @@

Return value:

-

RANGE:_create_transition(EventName)

+

RANGE:OnAfterImpact(From, Event, To, result, player)

-

Create transition.

+

On after "Impact" event user function.

+ + +

Called when a bomb/rocket/missile impacted.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Parameter:

+

Parameters:

#string - EventName + From

-

Event name.

+

From state.

-

Return value:

-
-
-

#function:

-
-
- -

Function.

- -
-
-
- -
-
- -
- -
-

RANGE:_delayed_transition(EventName)

-
- -

Delayed transition.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

#string - EventName + Event

-

Event name.

+

Event.

-

Return value:

-
-
-

#function:

-
-
- -

Function.

- -
-
-
- -
-
- -
- -
-

RANGE:_eventmap(Events, EventStructure)

-
- -

Event map.

+
+
+

+ #string + To +

+
+
+ +

To state.

-
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

+
+

- #table - Events + #RANGE.BombResult + result

-

Events.

+

Data of the bombing run.

- #table - EventStructure + #RANGE.PlayerData + player

-

Event structure.

+

Data of player settings etc.

@@ -13035,28 +5931,31 @@

Parameters:

-

RANGE:_gosub(ParentFrom, ParentEvent)

+

RANGE:OnAfterRollingIn(From, Event, To, player, target)

-

Go sub.

+

On after "RollingIn" event user function.

+ + +

Called when a player rolls in to a strafe taret.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameters:

#string - ParentFrom + From

-

Parent from state.

+

From state.

@@ -13064,68 +5963,51 @@

Parameters:

#string - ParentEvent + Event

-

Parent event name.

+

Event.

-

Return value:

-
-
-

#table:

-
-
- -

Subs.

- -
-
-
- -
-
- -
- -
-

RANGE:_handler(EventName, ...)

-
- -

Handler.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

#string - EventName + To +

+
+
+ +

To state.

+ +
+
+
+
+

+ #RANGE.PlayerData + player

-

Event name.

+

Data of player settings etc.

- ... + #RANGE.StrafeTarget + target

-

Arguments.

+

Strafe target.

@@ -13137,106 +6019,83 @@

Parameters:

-

RANGE:_isendstate(Current)

+

RANGE:OnAfterStrafeResult(From, Event, To, player, result)

-

Is end state.

+

On after "StrafeResult" event user function.

+ + +

Called when a player finished a strafing run.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Parameter:

+

Parameters:

#string - Current + From

-

Current state name.

+

From state.

-

Return values:

-
-
-

#table:

-
-
- -

FSM parent.

- -
-
-

#string:

-
-
- -

Event name.

- -
-
-
- -
-
- -
- -
-

RANGE:_submap(subs, sub, name)

-
- -

Sub maps.

+
+
+

+ #string + Event +

+
+
+ +

Event.

-
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

+
+

- #table - subs + #string + To

-

Subs.

+

To state.

- #table - sub + #RANGE.PlayerData + player

-

Sub.

+

Data of player settings etc.

- #string - name + #RANGE.StrafeResult + result

-

Name.

+

Data of the strafing run.

@@ -13248,50 +6107,29 @@

Parameters:

-

RANGE:can(e)

+

RANGE:OnEventBirth(EventData)

-

Check if can do an event.

+

Range event handler for event birth.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameter:

- #string - e + Core.Event#EVENTDATA + EventData

- -

Event name.

- +

-

Return values:

-
-
-

#boolean:

-
-
- -

If true, FSM can do the event.

- -
-
-

#string:

-
-
- -

To state.

- -
-
@@ -13300,42 +6138,29 @@

Return values:

-

RANGE:cannot(e)

+

RANGE:OnEventHit(EventData)

-

Check if cannot do an event.

+

Range event handler for event hit.

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

Parameter:

- #string - e + Core.Event#EVENTDATA + EventData

- -

Event name.

- +

-

Return value:

-
-
-

#boolean:

-
-
- -

If true, FSM cannot do the event.

- -
-
@@ -13344,885 +6169,1119 @@

Return value:

-

RANGE:is(State, state)

+

RANGE:OnEventShot(EventData)

-

Check if FSM is in state.

+

Range event handler for event shot (when a unit releases a rocket or bomb (but not a fast firing gun).

-
+

Defined in:

-

Core.Fsm#FSM

+

RANGE

-

Parameters:

-
-
-

- #string - State -

-
-
- -

State name.

- -
-
+

Parameter:

- state + Core.Event#EVENTDATA + EventData

-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, FSM is in this state.

- -
-
-
- -
-
- -
-

Field(s)

-
-
-
- - Utilities.Utils#SMOKECOLOR -RANGE.BombSmokeColor - -

Color id used for smoking bomb targets.

- -
- -
-
-
- - #number -RANGE.BombtrackThreshold - -

Bombs/rockets/missiles are only tracked if player-range distance is smaller than this threshold [m]. Default 25000 m.

- -
- -
-
-
- - #string -RANGE.ClassName - -

Name of the Class.

- -
- -
-
-
- - #number -RANGE.Coalition - -

Coalition side for the menu, if any.

- -
- -
-
-
- - #boolean -RANGE.Debug - -

If true, debug info is sent as messages on the screen.

- -
- -
-
-
- - #RANGE.Defaults -RANGE.Defaults - - - -
- -
-
-
- - #table -RANGE.MenuAddedTo - -

Table for monitoring which players already got an F10 menu.

- -
- -
-
-
- - #table -RANGE.MenuF10 - -

Main radio menu on group level.

- -
- -
-
-
- - #table -RANGE.MenuF10Root - -

Main radio menu on mission level.

- -
- -
-
-
- - #table -RANGE.Names - -

Global list of all defined range names.

- -
- -
-
-
- - #table -RANGE.PlayerSettings - -

Individual player settings.

- -
- -
-
-
- - #RANGE.Sound -RANGE.Sound - - - -
- -
-
-
- - Utilities.Utils#SMOKECOLOR -RANGE.StrafePitSmokeColor - -

Color id used to smoke strafe pit approach boxes.

- +

+
+
-
-
-
- - Utilities.Utils#SMOKECOLOR -RANGE.StrafeSmokeColor - -

Color id used to smoke strafe targets.

- +
-
-
- #RANGE.TargetType -RANGE.TargetType +
+

RANGE:RollingIn(player, target)

+
+

Triggers the FSM event "RollingIn".

- +
+
+

Defined in:

+
+

RANGE

+

Parameters:

+
+
+

+ #RANGE.PlayerData + player +

+
+
+ +

Data of player settings etc.

-
-
-
+
+
+
+
+

+ #RANGE.StrafeTarget + target +

+
+
+ +

Strafe target.

- #number -RANGE.TdelaySmoke - -

Time delay in seconds between impact of bomb and starting the smoke. Default 3 seconds.

+
+
+
+
-
-
- #number -RANGE.Tmsg +
+

RANGE:SetAutosaveOff()

+
-

Time [sec] messages to players are displayed. Default 30 sec.

+

Switch off auto save player results.

+
+
+

Defined in:

+
+

RANGE

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
-
- - #boolean -RANGE.autosave - -

If true, automatically save results every X seconds.

+
+
+
+
-
-
- #table -RANGE.bombPlayerResults +
+

RANGE:SetAutosaveOn()

+
-

Table containing the bombing results of each player.

+

Automatically save player results to disc.

+
+
+

Defined in:

+
+

RANGE

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
-
- - #table -RANGE.bombingTargets - -

Table of targets to bomb.

+
+
+
+
-
-
- Sound.SRS#MSRS -RANGE.controlmsrs - -

SRS wrapper for range controller.

- +
+

RANGE:SetBombTargetSmokeColor(colorid)

+ +

Set smoke color for marking bomb targets.

-
-
-
- - Sound.SRS#MSRSQUEUE -RANGE.controlsrsQ -

SRS queue for range controller.

+

By default bomb targets are marked by red smoke.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ Utilities.Utils#SMOKECOLOR + colorid +

+
+
+ +

Color id. Default SMOKECOLOR.Red.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #boolean -RANGE.defaultsmokebomb - -

If true, initialize player settings to smoke bomb.

+
+
+
+
-
-
- #number -RANGE.dtBombtrack - -

Time step [sec] used for tracking released bomb/rocket positions. Default 0.005 seconds.

- +
+

RANGE:SetBombtrackThreshold(distance)

+ +

Set bomb track threshold distance.

-
-
-
- - #boolean -RANGE.examinerexclusive -

If true, only the examiner gets messages. If false, clients and examiner get messages.

+

Bombs/rockets/missiles are only tracked if player-range distance is less than this distance. Default 25 km.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #number + distance +

+
+
+ +

Threshold distance in km. Default 25 km.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #string -RANGE.examinergroupname - -

Name of the examiner group which should get all messages.

+
+
+
+
-
-
- -RANGE.funkmanSocket - - - +
+

RANGE:SetBombtrackTimestep(dt)

+ +

Set time interval for tracking bombs.

-
-
-
- - #number -RANGE.illuminationmaxalt -

Maximum altitude in meters AGL at which illumination bombs are fired. Default is 1000 m.

+

A smaller time step increases accuracy but needs more CPU time.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #number + dt +

+
+
+ +

Time interval in seconds. Default is 0.005 s.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #number -RANGE.illuminationminalt - -

Minimum altitude in meters AGL at which illumination bombs are fired. Default is 500 m.

+
+
+
+
-
-
- Sound.SRS#MSRS -RANGE.instructmsrs +
+

RANGE:SetDefaultPlayerSmokeBomb(switch)

+
-

SRS wrapper for range instructor.

+

Set player setting whether bomb impact points are smoked or not.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #boolean + switch +

+
+
+ +

If true nor nil default is to smoke impact points of bombs.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- Sound.RadioQueue#RADIOQUEUE -RANGE.instructor - -

Instructor radio queue.

+
+
+
+
-
-
- #number -RANGE.instructorfreq +
+

RANGE:SetDisplayedMaxPlayerResults(nmax)

+
-

Frequency on which the range control transmitts.

+

Set max number of player results that are displayed.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #number + nmax +

+
+
+ +

Number of results. Default is 10.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #string -RANGE.instructorrelayname - -

Name of relay unit.

+
+
+
+
-
-
- Sound.SRS#MSRSQUEUE -RANGE.instructsrsQ - -

SRS queue for range instructor.

- +
+

RANGE:SetFunkManOn(Port, Host)

+ +

Set FunkMan socket.

-
-
-
- - #string -RANGE.lid -

String id of range for output in DCS log.

+

Bombing and strafing results will be send to your Discord bot. +Requires running FunkMan program.

+
+
+

Defined in:

+
+

RANGE

+

Parameters:

+
+
+

+ #number + Port +

+
+
+ +

Port. Default 10042.

-
-
-
+
+
+
+
+

+ #string + Host +

+
+
+ +

Host. Default "127.0.0.1".

- Core.Point#COORDINATE -RANGE.location - -

Coordinate of the range location.

+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+ +
+
+
+
-
-
- Core.Menu#MENU_MISSION -RANGE.menuF10root +
+

RANGE:SetInstructorRadio(frequency, relayunitname)

+
-

Specific user defined root F10 menu.

+

Enable instructor radio and set frequency (non-SRS).

+
+
+

Defined in:

+
+

RANGE

+

Parameters:

+
+
+

+ #number + frequency +

+
+
+ +

Frequency in MHz. Default 305 MHz.

-
-
-
+
+
+
+
+

+ #string + relayunitname +

+
+
+ +

Name of the unit used for transmission.

- #boolean -RANGE.messages - -

Globally enable/disable all messages to players.

+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+
+
-
-
-
- - #number -RANGE.nbombtargets - -

Number of bombing targets.

- +
-
-
- #number -RANGE.ndisplayresult - -

Number of (player) results that a displayed. Default is 10.

- +
+

RANGE:SetMaxStrafeAlt(maxalt)

+ +

Set maximal strafing altitude.

-
-
-
- - #number -RANGE.nstrafetargets -

Number of strafing targets.

+

Player entering a strafe pit above that altitude are not registered for a valid pass.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #number + maxalt +

+
+
+ +

Maximum altitude in meters AGL. Default is 914 m = 3000 ft.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #table -RANGE.planes - -

Table for administration.

+
+
+
+
-
-
- Sound.RadioQueue#RADIOQUEUE -RANGE.rangecontrol +
+

RANGE:SetMenuRoot(menu)

+
-

Range control radio queue.

+

Set the root F10 menu under which the range F10 menu is created.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ Core.Menu#MENU_MISSION + menu +

+
+
+ +

The root F10 menu.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #number -RANGE.rangecontrolfreq - -

Frequency on which the range control transmitts.

+
+
+
+
-
-
- #string -RANGE.rangecontrolrelayname +
+

RANGE:SetMessageTimeDuration(time)

+
-

Name of relay unit.

+

Set time how long (most) messages are displayed.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #number + time +

+
+
+ +

Time in seconds. Default is 30 s.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #string -RANGE.rangename - -

Name of the range.

+
+
+
+
-
-
- #number -RANGE.rangeradius +
+

RANGE:SetMessageToExaminer(examinergroupname, exclusively)

+
-

Radius of range defining its total size for e.g. smoking bomb impact points and sending radio messages. Default 5 km.

+

Set messages to examiner.

+ + +

The examiner will receive messages from all clients.

+
+
+

Defined in:

+
+

RANGE

+

Parameters:

+
+
+

+ #string + examinergroupname +

+
+
+ +

Name of the group of the examiner.

-
-
-
+
+
+
+
+

+ #boolean + exclusively +

+
+
+ +

If true, messages are send exclusively to the examiner, i.e. not to the clients.

- Core.Zone#ZONE -RANGE.rangezone - -

MOOSE zone object of the range. For example, no bomb impacts are smoked if bombs fall outside of the range zone.

+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+
+
+
+ +
-
-
- #number -RANGE.scorebombdistance +
+

RANGE:SetMessagesOFF()

+
-

Distance from closest target up to which bomb hits are counted. Default 1000 m.

+

Disable ALL messages to players.

+
+
+

Defined in:

+
+

RANGE

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
-
- - #string -RANGE.soundpath - -

Path inside miz file where the sound files are located. Default is "Range Soundfiles/".

+
+
+
+
-
-
- #table -RANGE.strafePlayerResults - -

Table containing the strafing results of each player.

- +
+

RANGE:SetMessagesON()

+ +

Enable messages to players.

-
-
-
- - #table -RANGE.strafeStatus -

Table containing the current strafing target a player as assigned to.

+

This is the default

+
+
+

Defined in:

+
+

RANGE

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
-
- - #table -RANGE.strafeTargets - -

Table of strafing targets.

+
+
+
+
-
-
- #number -RANGE.strafemaxalt +
+

RANGE:SetRangeCeiling(ceiling, alt)

+
-

Maximum altitude in meters AGL for registering for a strafe run. Default is 914 m = 3000 ft.

+

Set range ceiling altitude in feet MSL.

+
+
+

Defined in:

+
+

RANGE

+

Parameters:

+
+
+

+ #number + ceiling +

+
+
+ +

(optional) Ceiling altitude of the range in ft MSL. Default 20000ft MSL

-
-
-
+
+
+
+
+

+ alt +

+
+
+

+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #string -RANGE.targetpath - -

Path where to save the target sheets.

+
+
+
+
-
-
- #string -RANGE.targetprefix +
+

RANGE:SetRangeControl(frequency, relayunitname)

+
-

File prefix for target sheet files.

+

Enable range control and set frequency (non-SRS).

+
+
+

Defined in:

+
+

RANGE

+

Parameters:

+
+
+

+ #number + frequency +

+
+
+ +

Frequency in MHz. Default 256 MHz.

-
-
-
+
+
+
+
+

+ #string + relayunitname +

+
+
+ +

Name of the unit used for transmission.

- #boolean -RANGE.targetsheet - -

If true, players can save their target sheets. Rangeboss will not work if targetsheets do not save.

+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+
+
+
+ +
-
-
+
+

RANGE:SetRangeLocation(coordinate)

+
-RANGE.timerCheckZone - +

Set range location.

+ +

If this is not done, one (random) unit position of the range is used to determine the location of the range. +The range location determines the position at which the weather data is evaluated.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ Core.Point#COORDINATE + coordinate +

+
+
+ +

Coordinate of the range.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #boolean -RANGE.trackbombs - -

If true (default), all bomb types are tracked and impact point to closest bombing target is evaluated.

+
+
+
+
-
-
- #boolean -RANGE.trackmissiles - -

If true (default), all missile types are tracked and impact point to closest bombing target is evaluated.

- +
+

RANGE:SetRangeRadius(radius)

+ +

Set range radius.

-
-
-
- - #boolean -RANGE.trackrockets -

If true (default), all rocket types are tracked and impact point to closest bombing target is evaluated.

+

Defines the area in which e.g. bomb impacts are smoked.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ #number + radius +

+
+
+ +

Radius in km. Default 5 km.

-
-
-
- - #boolean -RANGE.useSRS - +
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+
+
+
+
-
-
- #boolean -RANGE.verbose +
+

RANGE:SetRangeZone(zone)

+
-

Verbosity level. Higher means more output to DCS log file.

+

Set range zone.

+ + +

For example, no bomb impact points are smoked if a bomb falls outside of this zone. +If a zone is not explicitly specified, the range zone is determined by its location and radius.

+
+
+

Defined in:

+
+

RANGE

+

Parameter:

+
+
+

+ Core.Zone#ZONE + zone +

+
+
+ +

MOOSE zone defining the range perimeters.

-
-
-
+
+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

- #string -RANGE.version - -

Range script version.

+
+
+
+
-
-
-

Function(s)

-
-

RANGE:ClearState(Object, StateName)

+

RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume, PathToGoogleKey)

-

Clear the state of an object.

+

Use SRS Simple-Text-To-Speech for transmissions.

+ + +

No sound files necessary.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

- Object + #string + PathToSRS

-

The object that holds the Value set by the Key.

+

Path to SRS directory.

- StateName + #number + Port

-

The key that is should be cleared.

+

SRS port. Default 5002.

-
- -
-
- -
- -
-

RANGE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

-
- -

Creation of a Birth Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

- DCS#Time - EventTime + #number + Coalition

-

The time stamp of the event.

+

Coalition side, e.g. coalition.side.BLUE or coalition.side.RED. Default coalition.side.BLUE.

- DCS#Object - Initiator + #number + Frequency

-

The initiating object of the event.

+

Frequency to use. Default is 256 MHz for range control and 305 MHz for instructor. If given, both control and instructor get this frequency.

- #string - IniUnitName + #number + Modulation

-

The initiating unit name.

+

Modulation to use, defaults to radio.modulation.AM

- place + #number + Volume

-

+ +

Volume, between 0.0 and 1.0. Defaults to 1.0

+

- subplace + #string + PathToGoogleKey

-

+ +

Path to Google TTS credentials.

+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+ +
+
@@ -14231,110 +7290,110 @@

Parameters:

-

RANGE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

+

RANGE:SetSRSRangeControl(frequency, modulation, voice, culture, gender, relayunitname)

-

Creation of a Crash Event.

+

(SRS) Set range control frequency and voice.

+ + +

Use RANGE:SetSRS() once first before using this function.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

- DCS#Time - EventTime + #number + frequency

-

The time stamp of the event.

+

Frequency in MHz. Default 256 MHz.

- DCS#Object - Initiator + #number + modulation

-

The initiating object of the event.

+

Modulation, defaults to radio.modulation.AM.

- IniObjectCategory + #string + voice

-

+ +

Voice.

+
-
- -
-
- -
- -
-

RANGE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

-
- -

Creation of a Dead Event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

- DCS#Time - EventTime + #string + culture

-

The time stamp of the event.

+

Culture, defaults to "en-US".

- DCS#Object - Initiator + #string + gender

-

The initiating object of the event.

+

Gender, defaults to "female".

- IniObjectCategory + #string + relayunitname

-

+ +

Name of the unit used for transmission location.

+
+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+ +
+
@@ -14343,97 +7402,110 @@

Parameters:

-

RANGE:CreateEventDynamicCargoLoaded(DynamicCargo)

+

RANGE:SetSRSRangeInstructor(frequency, modulation, voice, culture, gender, relayunitname)

-

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

+

(SRS) Set range instructor frequency and voice.

+ + +

Use RANGE:SetSRS() once first before using this function.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo + #number + frequency

-

the dynamic cargo object

+

Frequency in MHz. Default 305 MHz.

-
- -
-
- -
- -
-

RANGE:CreateEventDynamicCargoRemoved(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo + #number + modulation

-

the dynamic cargo object

+

Modulation, defaults to radio.modulation.AM.

-
- -
-
+
+
+

+ #string + voice +

+
+
+ +

Voice.

-
+
+
+
+
+

+ #string + culture +

+
+
+ +

Culture, defaults to "en-US".

-
-

RANGE:CreateEventDynamicCargoUnloaded(DynamicCargo)

-
- -

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

+
+
+
+
+

+ #string + gender +

+
+
+ +

Gender, defaults to "male".

-
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

+
+

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo + #string + relayunitname

-

the dynamic cargo object

+

Name of the unit used for transmission location.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+ +
+
@@ -14442,31 +7514,42 @@

Parameter:

-

RANGE:CreateEventNewDynamicCargo(DynamicCargo)

+

RANGE:SetScoreBombDistance(distance)

-

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

+

Set score bomb distance.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Wrapper.DynamicCargo#DYNAMICCARGO - DynamicCargo + #number + distance

-

the dynamic cargo object

+

Distance in meters. Default 1000 m.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+ +
+
@@ -14475,31 +7558,42 @@

Parameter:

-

RANGE:CreateEventPlayerEnterAircraft(PlayerUnit)

+

RANGE:SetSmokeTimeDelay(delay)

-

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

Set time delay between bomb impact and starting to smoke the impact point.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Wrapper.Unit#UNIT - PlayerUnit + #number + delay

-

The aircraft unit the player entered.

+

Time delay in seconds. Default is 3 seconds.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

+ +
+
@@ -14508,44 +7602,45 @@

Parameter:

-

RANGE:CreateEventRemoveUnit(EventTime, Initiator)

+

RANGE:SetSoundfilesInfo(csvfile)

-

Creation of a Remove Unit Event.

+

Set the path to the csv file that contains information about the used sound files.

+ + +

The parameter file has to be located on your local disk (not inside the miz file).

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

+

Parameter:

- DCS#Time - EventTime + #string + csvfile

-

The time stamp of the event.

+

Full path to the csv file on your local disk.

-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
+
+
@@ -14554,44 +7649,42 @@

Parameters:

-

RANGE:CreateEventTakeoff(EventTime, Initiator)

+

RANGE:SetSoundfilesPath(path)

-

Creation of a Takeoff Event.

+

Set sound files folder within miz file.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

+

Parameter:

- DCS#Time - EventTime + #string + path

-

The time stamp of the event.

+

Path for sound files. Default "Range Soundfiles/". Mind the slash "/" at the end!

-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
+
+
@@ -14600,44 +7693,45 @@

Parameters:

-

RANGE:CreateEventUnitLost(EventTime, Initiator)

+

RANGE:SetStrafePitSmokeColor(colorid)

-

Creation of a Crash Event.

+

Set smoke color for marking strafe pit approach boxes.

+ + +

By default strafe pit boxes are marked by white smoke.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

+

Parameter:

- DCS#Time - EventTime + Utilities.Utils#SMOKECOLOR + colorid

-

The time stamp of the event.

+

Color id. Default SMOKECOLOR.White.

-
-
-

- DCS#Object - Initiator -

-
-
- -

The initiating object of the event.

+

Return value:

+
+
+

#RANGE:

+
+
+ +

self

-
-
+
+
@@ -14646,60 +7740,42 @@

Parameters:

-

RANGE:E(Arguments)

+

RANGE:SetStrafeTargetSmokeColor(colorid)

-

Log an exception which will be traced always.

+

Set smoke color for marking strafe targets.

-

Can be anywhere within the function logic.

+

By default strafe targets are marked by green smoke.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Arguments + Utilities.Utils#SMOKECOLOR + colorid

-

A #table or any field.

+

Color id. Default SMOKECOLOR.Green.

-
- -
-
- -
- -
-

RANGE:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-

Return value:

-

Core.Event#EVENT:

+

#RANGE:

- +

self

@@ -14711,25 +7787,52 @@

Return value:

-

RANGE:EventRemoveAll()

+

RANGE:SetTargetSheet(path, prefix)

-

Remove all subscribed events

+

Enable saving of player's target sheets and specify an optional directory path.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

+

Parameters:

+
+
+

+ #string + path +

+
+
+ +

(Optional) Path where to save the target sheets.

+ +
+
+
+
+

+ #string + prefix +

+
+
+ +

(Optional) Prefix for target sheet files. File name will be saved as *prefix_aircrafttype-0001.csv*, *prefix_aircrafttype-0002.csv*, etc.

+ +
+

Return value:

-

#BASE:

+

#RANGE:

- +

self

@@ -14741,33 +7844,20 @@

Return value:

-

RANGE:F(Arguments)

+

RANGE:Start()

-

Trace a function call.

+

Triggers the FSM event "Start".

-

Must be at the beginning of the function logic.

+

Starts the RANGE. Initializes parameters and starts event handlers.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
@@ -14776,33 +7866,17 @@

Parameter:

-

RANGE:F2(Arguments)

+

RANGE:Status()

-

Trace a function call level 2.

- - -

Must be at the beginning of the function logic.

+

Triggers the FSM event "Status".

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
@@ -14811,30 +7885,41 @@

Parameter:

-

RANGE:F3(Arguments)

+

RANGE:StrafeResult(player, result)

-

Trace a function call level 3.

- - -

Must be at the beginning of the function logic.

+

Triggers the FSM event "StrafeResult".

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

+
+
+

+ #RANGE.PlayerData + player +

+
+
+ +

Data of player settings etc.

+ +
+

- Arguments + #RANGE.StrafeResult + result

-

A #table or any field.

+

Data of the strafing run.

@@ -14846,25 +7931,25 @@

Parameter:

-

RANGE:GetClassID()

+

RANGE:TrackBombsOFF()

-

Get the ClassID of the class instance.

+

Disables tracking of all bomb types.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Return value:

-

#string:

+

#RANGE:

-

The ClassID of the class instance.

+

self

@@ -14876,25 +7961,28 @@

Return value:

-

RANGE:GetClassName()

+

RANGE:TrackBombsON()

-

Get the ClassName of the class instance.

+

Enables tracking of all bomb types.

+ + +

Note that this is the default setting.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Return value:

-

#string:

+

#RANGE:

-

The ClassName of the class instance.

+

self

@@ -14906,28 +7994,25 @@

Return value:

-

RANGE:GetClassNameAndID()

+

RANGE:TrackMissilesOFF()

-

Get the ClassName + ClassID of the class instance.

- - -

The ClassName + ClassID is formatted as '%s#%09d'.

+

Disables tracking of all missile types.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Return value:

-

#string:

+

#RANGE:

-

The ClassName + ClassID of the class instance.

+

self

@@ -14939,29 +8024,28 @@

Return value:

-

RANGE:GetEventPriority()

+

RANGE:TrackMissilesON()

-

Get the Class Core.Event processing Priority.

+

Enables tracking of all missile types.

-

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

+

Note that this is the default setting.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Return value:

-

#number:

+

#RANGE:

-

The Core.Event processing Priority.

+

self

@@ -14973,60 +8057,25 @@

Return value:

-

RANGE:GetParent(Child, FromClass)

+

RANGE:TrackRocketsOFF()

-

This is the worker method to retrieve the Parent class.

- - -

Note that the Parent class must be passed to call the parent class method.

- -
self:GetParent(self):ParentMethod()
-
- - +

Disables tracking of all rocket types.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

-
-
-

- #BASE - Child -

-
-
- -

This is the Child class from which the Parent class needs to be retrieved.

- -
-
-
-
-

- #BASE - FromClass -

-
-
- -

(Optional) The class from which to get the parent.

- -
-

Return value:

-

#BASE:

+

#RANGE:

- +

self

@@ -15038,52 +8087,28 @@

Return value:

-

RANGE:GetState(Object, Key)

+

RANGE:TrackRocketsON()

-

Get a Value given a Key from the Object.

+

Enables tracking of all rocket types.

-

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

+

Note that this is the default setting.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

-
-
-

- Object -

-
-
- -

The object that holds the Value set by the Key.

- -
-
-
-
-

- Key -

-
-
- -

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

- -
-

Return value:

+

#RANGE:

-

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

+

self

@@ -15095,55 +8120,31 @@

Return value:

-

RANGE:HandleEvent(EventID, EventFunction)

+

RANGE:_AddF10Commands(_unitName)

-

Subscribe to a DCS Event.

+

Add menu commands for player.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
+

Parameter:

- #function - EventFunction + #string + _unitName

-

(optional) The function to be called when the event occurs for the unit.

+

Name of player unit.

-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
@@ -15152,30 +8153,31 @@

Return value:

-

RANGE:I(Arguments)

+

RANGE:_CheckInZone(_unitName)

-

Log an information which will be traced always.

+

Check if player is inside a strafing zone.

-

Can be anywhere within the function logic.

+

If he is, we start looking for hits. If he was and left the zone again, the result is stored.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Arguments + #string + _unitName

-

A #table or any field.

+

Name of player unit.

@@ -15187,51 +8189,75 @@

Parameter:

-

RANGE:Inherit(Child, Parent)

+

RANGE:_CheckPlayers(_unitName)

-

This is the worker method to inherit from a parent class.

+

Check status of players.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameters:

+

Parameter:

- Child + #string + _unitName

-

is the Child class that inherits.

+

Name of player unit.

+
+ +
+
+ +
+ +
+

RANGE:_CheckStatic(name)

+
+ +

Checks if a static object with a certain name exists.

+ + +

It also added it to the MOOSE data base, if it is not already in there.

+ +
+
+

Defined in:

+
+

RANGE

+
+

Parameter:

- #BASE - Parent + #string + name

-

is the Parent class that the Child inherits from.

+

Name of the potential static object.

Return value:

-

#BASE:

+

#boolean:

-

Child

+

Returns true if a static with this name exists. Retruns false if a unit with this name exists. Returns nil if neither unit or static exist.

@@ -15243,54 +8269,31 @@

Return value:

-

RANGE:IsInstanceOf(ClassName)

+

RANGE._DelayedSmoke(_args)

-

This is the worker method to check if an object is an (sub)instance of a class.

- - - -

Examples:

- -
    -

  • ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

    • -

  • ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

    • -
- +

Start smoking a coordinate with a delay.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- ClassName + #table + _args

-

is the name of the class or the class itself to run the check against

+

Argements passed.

-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
@@ -15299,28 +8302,31 @@

Return value:

-

RANGE:IsTrace()

+

RANGE:_DisplayBombTargets(_unitname)

-

Enquires if tracing is on (for the class).

+

Display bombing target locations to player.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Return value:

-
-
-

#boolean:

-
-
- - +

Parameter:

+
+
+

+ #string + _unitname +

+
+
+ +

Name of the player unit.

-
-
+
+
@@ -15329,39 +8335,31 @@

Return value:

-

RANGE:New()

+

RANGE:_DisplayBombingResults(_unitName)

-

BASE constructor.

- - - -

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

- -
function EVENT:New()
-  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
-  return self
-end
-
- +

Display best bombing results of top 10 players.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
+

Parameter:

+
+
+

+ #string + _unitName +

+
+
+ +

Name of player unit.

+ +
+
@@ -15370,68 +8368,93 @@

Return value:

-

RANGE:OnEvent(EventData)

+

RANGE:_DisplayMessageToGroup(_unit, _text, _time, _clear, display, _togroup)

-

Occurs when an Event for an object is triggered.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that triggered the event.

+

Display message to group.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + Wrapper.Unit#UNIT + _unit

-

The EventData structure.

+

Player unit.

-
- -
-
+
+
+

+ #string + _text +

+
+
+ +

Message text.

-
+
+
+
+
+

+ #number + _time +

+
+
+ +

Duration how long the message is displayed.

-
-

RANGE:OnEventBDA(EventData)

-
- -

BDA.

+
+
+
+
+

+ #boolean + _clear +

+
+
+ +

Clear up old messages.

- -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+
+
+
+
+

+ #boolean + display +

+
+
+ +

If true, display message regardless of player setting "Messages Off".

-
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

+
+

- Core.Event#EVENTDATA - EventData + #boolean + _togroup

-

The EventData structure.

+

If true, display the message to the group in any case

@@ -15443,33 +8466,28 @@

Parameter:

-

RANGE:OnEventBaseCaptured(EventData)

+

RANGE:_DisplayMyBombingResults(_unitName)

-

Occurs when a ground unit captures either an airbase or a farp.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that captured the base -place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

+

Display top 10 bombing run results of specific player.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

Name of the player unit.

@@ -15481,32 +8499,28 @@

Parameter:

-

RANGE:OnEventBirth(EventData)

+

RANGE:_DisplayMyStrafePitResults(_unitName)

-

Occurs when any object is spawned into the mission.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was spawned

+

Display top 10 stafing results of a specific player.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

Name of the player unit.

@@ -15518,32 +8532,28 @@

Parameter:

-

RANGE:OnEventCrash(EventData)

+

RANGE:_DisplayRangeInfo(_unitname)

-

Occurs when any aircraft crashes into the ground and is completely destroyed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that has crashed

+

Report information like bearing and range from player unit to range.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitname

-

The EventData structure.

+

Name of the player unit.

@@ -15555,32 +8565,31 @@

Parameter:

-

RANGE:OnEventDead(EventData)

+

RANGE:_DisplayRangeWeather(_unitname)

-

Occurs when an object is dead.

+

Report weather conditions at range.

-

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is dead.

+

Temperature, QFE pressure and wind data.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitname

-

The EventData structure.

+

Name of the player unit.

@@ -15592,36 +8601,28 @@

Parameter:

-

RANGE:OnEventDetailedFailure(EventData)

+

RANGE:_DisplayStrafePitResults(_unitName)

-

Unknown precisely what creates this event, likely tied into newer damage model.

- - -

Will update this page when new information become available.

- -
    -
  • initiator: The unit that had the failure.
    • -
- +

Display top 10 strafing results of all players.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

Name fo the player unit.

@@ -15633,31 +8634,28 @@

Parameter:

-

RANGE:OnEventDiscardChairAfterEjection(EventData)

+

RANGE:_DisplayStrafePits(_unitname)

-

Discard chair after ejection.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Display pit location and heading to player.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitname

-

The EventData structure.

+

Name of the player unit.

@@ -15669,31 +8667,28 @@

Parameter:

-

RANGE:OnEventDynamicCargoLoaded(EventData)

+

RANGE:_FlareDirectHitsOnOff(unitname)

-

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+

Toggle status of flaring direct hits of range targets.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -15705,34 +8700,41 @@

Parameter:

-

RANGE:OnEventDynamicCargoRemoved(EventData)

+

RANGE:_GetAmmo(unitname)

-

Occurs when a dynamic cargo crate is removed.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+

Get the number of shells a unit currently has.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

+

Return value:

+
+
+
+
+ +

Number of shells left

+ +
+
@@ -15741,34 +8743,42 @@

Parameter:

-

RANGE:OnEventDynamicCargoUnloaded(EventData)

+

RANGE:_GetBombTargetCoordinate(target)

-

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+

Get the number of shells a unit currently has.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #RANGE.BombTarget + target

-

The EventData structure.

+

Bomb target data.

+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

Target coordinate.

+ +
+
@@ -15777,35 +8787,71 @@

Parameter:

-

RANGE:OnEventEjection(EventData)

+

RANGE:_GetPlayerUnitAndName(_unitName, PlayerName)

-

Occurs when a pilot ejects from an aircraft -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Returns the unit of a player and the player name.

-

initiator : The unit that has ejected

+

If the unit does not belong to a player, nil is returned.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

Name of the player unit.

+ +
+
+
+
+

+ PlayerName +

+
+
+

+
+
+

Return values:

+
+
+

Wrapper.Unit#UNIT:

+
+
+ +

Unit of player.

+ +
+
+

#string:

+
+
+ +

Name of the player.

+ +
+
+

#boolean:

+
+
+ +

If true, group has > 1 player in it

-
+
@@ -15814,35 +8860,39 @@

Parameter:

-

RANGE:OnEventEngineShutdown(EventData)

+

RANGE:_GetSpeed(controllable)

-

Occurs when any aircraft shuts down its engines.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is stopping its engines.

+

Get max speed of controllable.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + Wrapper.Controllable#CONTROLLABLE + controllable

- -

The EventData structure.

- +

+

Return value:

+
+
+
+
+ +

Maximum speed in km/h.

+ +
+
@@ -15851,32 +8901,31 @@

Parameter:

-

RANGE:OnEventEngineStartup(EventData)

+

RANGE:_IlluminateBombTargets(_unitName)

-

Occurs when any aircraft starts its engines.

+

Illuminate targets.

-

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is starting its engines.

+

Fires illumination bombs at one random bomb and one random strafe target at a random altitude between 400 and 800 m.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

(Optional) Name of the player unit.

@@ -15888,34 +8937,28 @@

Parameter:

-

RANGE:OnEventHit(EventData)

+

RANGE:_MarkTargetsOnMap(_unitName)

-

Occurs whenever an object is hit by a weapon.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit object the fired the weapon -weapon: Weapon object that hit the target -target: The Object that was hit.

+

Mark targets on F10 map.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

Name of the player unit.

@@ -15927,32 +8970,28 @@

Parameter:

-

RANGE:OnEventHumanFailure(EventData)

+

RANGE:_MessagesToPlayerOnOff(unitname)

-

Occurs when any system fails on a human controlled aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that had the failure

+

Toggle display messages to player.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -15964,157 +9003,93 @@

Parameter:

-

RANGE:OnEventKill(EventData)

+

RANGE._OnImpact(weapon, self, playerData, attackHdg, attackAlt, attackVel)

-

Occurs on the death of a unit.

- - -

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: The unit that killed the target
    • -
  • target: Target Object
    • -
  • weapon: Weapon Object
    • -
- +

Function called on impact of a tracked weapon.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + Wrapper.Weapon#WEAPON + weapon

-

The EventData structure.

+

The weapon object.

-
- -
-
- -
- -
-

RANGE:OnEventLand(EventData)

-
- -

Occurs when an aircraft lands at an airbase, farp or ship -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- - -

initiator : The unit that has landed -place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Core.Event#EVENTDATA - EventData + #RANGE + self

-

The EventData structure.

+

RANGE object.

-
- -
-
- -
- -
-

RANGE:OnEventLandingAfterEjection(EventData)

-
- -

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

- - -

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
    • -
  • place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
    • -
  • subplace: is always 0 for unknown reasons.
    • -
- - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Core.Event#EVENTDATA - EventData + #RANGE.PlayerData + playerData

-

The EventData structure.

+

Player data table.

-
- -
-
- -
- -
-

RANGE:OnEventLandingQualityMark(EventData)

-
- -

Landing quality mark.

+
+
+

+ #number + attackHdg +

+
+
+ +

Attack heading.

- -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+
+
+
+
+

+ #number + attackAlt +

+
+
+ +

Attack altitude.

-
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

+
+

- Core.Event#EVENTDATA - EventData + #number + attackVel

-

The EventData structure.

+

Attack velocity.

@@ -16126,32 +9101,28 @@

Parameter:

-

RANGE:OnEventMarkAdded(EventData)

+

RANGE:_ResetRangeStats(_unitName)

-

Occurs when a new mark was added.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

+

Reset player statistics.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitName

-

The EventData structure.

+

Name of the player unit.

@@ -16163,69 +9134,41 @@

Parameter:

-

RANGE:OnEventMarkChange(EventData)

+

RANGE:_SaveTargetSheet(_playername, result)

-

Occurs when a mark text was changed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

+

Save target sheet.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #string + _playername

-

The EventData structure.

+

Player name.

-
- -
-
- -
- -
-

RANGE:OnEventMarkRemoved(EventData)

-
- -

Occurs when a mark was removed.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -MarkID: ID of the mark.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Core.Event#EVENTDATA - EventData + #RANGE.StrafeResult + result

-

The EventData structure.

+

Results table.

@@ -16237,29 +9180,28 @@

Parameter:

-

RANGE:OnEventMissionEnd(EventData)

+

RANGE:_SmokeBombDelayOnOff(unitname)

-

Occurs when a mission ends -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Toggle status of time delay for smoking bomb impact points

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16271,29 +9213,28 @@

Parameter:

-

RANGE:OnEventMissionStart(EventData)

+

RANGE:_SmokeBombImpactOnOff(unitname)

-

Occurs when a mission starts -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Toggle status of smoking bomb impact points.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16305,31 +9246,28 @@

Parameter:

-

RANGE:OnEventNewDynamicCargo(EventData)

+

RANGE:_SmokeBombTargets(unitname)

-

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

- - -

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

+

Mark bombing targets with smoke.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16341,32 +9279,28 @@

Parameter:

-

RANGE:OnEventParatrooperLanding(EventData)

+

RANGE:_SmokeStrafeTargetBoxes(unitname)

-

Weapon add.

- - -

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Mark approach boxes of strafe targets with smoke.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16378,33 +9312,28 @@

Parameter:

-

RANGE:OnEventPilotDead(EventData)

+

RANGE:_SmokeStrafeTargets(unitname)

-

Occurs when the pilot of an aircraft is killed.

- - -

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the pilot has died in.

+

Mark strafing targets with smoke.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16416,33 +9345,28 @@

Parameter:

-

RANGE:OnEventPlayerEnterAircraft(EventData)

+

RANGE:_TargetsheetOnOff(_unitname)

-

Occurs when a player enters a slot and takes control of an aircraft.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. -initiator : The unit that is being taken control of.

+

Targetsheet saves if player on or off.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + _unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16454,33 +9378,41 @@

Parameter:

-

RANGE:OnEventPlayerEnterUnit(EventData)

+

RANGE:__EnterRange(delay, player)

-

Occurs when any player assumes direct control of a unit.

- - -

Note - not Mulitplayer safe. Use PlayerEnterAircraft. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is being taken control of.

+

Triggers the FSM delayed event "EnterRange".

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #number + delay +

+
+
+ +

Delay in seconds before the function is called.

+ +
+
+
+
+

+ #RANGE.PlayerData + player

-

The EventData structure.

+

Data of player settings etc.

@@ -16492,32 +9424,41 @@

Parameter:

-

RANGE:OnEventPlayerLeaveUnit(EventData)

+

RANGE:__ExitRange(delay, player)

-

Occurs when any player relieves control of a unit to the AI.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that the player left.

+

Triggers the FSM delayed event "ExitRange".

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #number + delay +

+
+
+ +

Delay in seconds before the function is called.

+ +
+
+
+
+

+ #RANGE.PlayerData + player

-

The EventData structure.

+

Data of player settings etc.

@@ -16529,32 +9470,54 @@

Parameter:

-

RANGE:OnEventRefueling(EventData)

+

RANGE:__Impact(delay, result, player)

-

Occurs when an aircraft connects with a tanker and begins taking on fuel.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is receiving fuel.

+

Triggers the FSM delayed event "Impact".

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #number + delay +

+
+
+ +

Delay in seconds before the function is called.

+ +
+
+
+
+

+ #RANGE.BombResult + result +

+
+
+ +

Data of the bombing run.

+ +
+
+
+
+

+ #RANGE.PlayerData + player

-

The EventData structure.

+

Data of player settings etc.

@@ -16566,32 +9529,31 @@

Parameter:

-

RANGE:OnEventRefuelingStop(EventData)

+

RANGE:__Start(delay)

-

Occurs when an aircraft is finished taking fuel.

+

Triggers the FSM event "Start" after a delay.

-

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was receiving fuel.

+

Starts the RANGE. Initializes parameters and starts event handlers.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #number + delay

-

The EventData structure.

+

Delay in seconds.

@@ -16603,32 +9565,28 @@

Parameter:

-

RANGE:OnEventScore(EventData)

+

RANGE:__Status(delay)

-

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

- - -

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Triggers the FSM event "Status" after a delay.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #number + delay

-

The EventData structure.

+

Delay in seconds.

@@ -16640,33 +9598,31 @@

Parameter:

-

RANGE:OnEventShootingEnd(EventData)

+

RANGE:__Stop(delay)

-

Occurs when any unit stops firing its weapon.

+

Triggers the FSM event "Stop" after a delay.

-

Event will always correspond with a shooting start event. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that was doing the shooting.

+

Stops the RANGE and all its event handlers.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #number + delay

-

The EventData structure.

+

Delay in seconds.

@@ -16678,37 +9634,42 @@

Parameter:

-

RANGE:OnEventShootingStart(EventData)

+

RANGE:_flarecolor2text(color)

-

Occurs when any unit begins firing a weapon that has a high rate of fire.

- - -

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. -Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that is doing the shooting. -target: The unit that is being targeted.

+

Sets the flare color used to flare players direct target hits.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + Utilities.Utils#FLARECOLOR + color

-

The EventData structure.

+

Color Id.

+

Return value:

+
+
+

#string:

+
+
+ +

Color text.

+ +
+
@@ -16717,32 +9678,28 @@

Parameter:

-

RANGE:OnEventShot(EventData)

+

RANGE:_myname(unitname)

-

Occurs whenever any unit in a mission fires a weapon.

- - -

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. -Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Returns a string which consists of the player name.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + #string + unitname

-

The EventData structure.

+

Name of the player unit.

@@ -16754,33 +9711,41 @@

Parameter:

-

RANGE:OnEventTakeoff(EventData)

+

RANGE:_playerflarecolor(_unitName, color)

-

Occurs when an aircraft takes off from an airbase, farp, or ship.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes. -initiator : The unit that tookoff -place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

+

Sets the flare color used when player makes a direct hit on target.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #string + _unitName +

+
+
+ +

Name of the player unit.

+ +
+
+
+
+

+ Utilities.Utils#FLARECOLOR + color

-

The EventData structure.

+

ID of flare color.

@@ -16792,31 +9757,41 @@

Parameter:

-

RANGE:OnEventTriggerZone(EventData)

+

RANGE:_playersmokecolor(_unitName, color)

-

Trigger zone.

- - -

Have a look at the class Core.Event#EVENT as these are just the prototypes.

+

Sets the smoke color used to smoke players bomb impact points.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Core.Event#EVENTDATA - EventData + #string + _unitName +

+
+
+ +

Name of the player unit.

+ +
+
+
+
+

+ Utilities.Utils#SMOKECOLOR + color

-

The EventData structure.

+

ID of the smoke color.

@@ -16828,39 +9803,45 @@

Parameter:

-

RANGE:OnEventUnitLost(EventData)

+

RANGE:_smokecolor2text(color)

-

Occurs when the game thinks an object is destroyed.

+

Converts a smoke color id to text.

-

Have a look at the class Core.Event#EVENT as these are just the prototypes.

- -
    -
  • initiator: The unit that is was destroyed.
    • -
- +

E.g. SMOKECOLOR.Blue --> "blue".

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameter:

- Core.Event#EVENTDATA - EventData + Utilities.Utils#SMOKECOLOR + color

-

The EventData structure.

+

Color Id.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

Color text.

-
-
+
+
@@ -16869,71 +9850,70 @@

Parameter:

-

RANGE:ScheduleOnce(Start, SchedulerFunction, ...)

+

RANGE:onafterEnterRange(From, Event, To, player)

-

Schedule a new time event.

- - -

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+

Function called after player enters the range zone.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

- #number - Start + #string + From

-

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+

From state.

- #function - SchedulerFunction + #string + Event

-

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+

Event.

- #table - ... + #string + To

-

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+

To state.

-

Return value:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

+
+
+

+ #RANGE.PlayerData + player +

+
+
+ +

Player data.

-
-
+
+
@@ -16942,110 +9922,70 @@

Return value:

-

RANGE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

+

RANGE:onafterExitRange(From, Event, To, player)

-

Schedule a new time event.

- - -

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

+

Function called after player leaves the range zone.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

- #number - Start -

-
-
- -

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

- -
-
-
-
-

- #number - Repeat -

-
-
- -

Specifies the interval in seconds when the scheduler will call the event function.

- -
-
-
-
-

- #number - RandomizeFactor + #string + From

-

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

+

From state.

- #number - Stop + #string + Event

-

Specifies the amount of seconds when the scheduler will be stopped.

+

Event.

- #function - SchedulerFunction + #string + To

-

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+

To state.

- #table - ... + #RANGE.PlayerData + player

-

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+

Player data.

-

Return value:

-
-
-

#string:

-
-
- -

The Schedule ID of the planned schedule.

- -
-
@@ -17054,148 +9994,83 @@

Return value:

-

RANGE:ScheduleStop(SchedulerID)

+

RANGE:onafterImpact(From, Event, To, result, player)

-

Stops the Schedule.

+

Function called after bomb impact on range.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

#string - SchedulerID + From

-

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

+

From state.

-
- -
-
- -
- -
-

RANGE:SetEventPriority(EventPriority)

-
- -

Set the Class Core.Event processing Priority.

- - -

The Event processing Priority is a number from 1 to 10, -reflecting the order of the classes subscribed to the Event to be processed.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- #number - EventPriority + #string + Event

-

The Core.Event processing Priority.

+

Event.

-

Return value:

-
-
-

#BASE:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

RANGE:SetState(Object, Key, Value)

-
- -

Set a state or property of the Object given a Key and a Value.

- - -

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

- Object + #string + To

-

The object that will hold the Value set by the Key.

+

To state.

- Key + #RANGE.BombResult + result

-

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

+

Result of bomb impact.

- Value + #RANGE.PlayerData + player

-

The value to is stored in the object.

+

Player data table.

-

Return value:

-
-
-
-
- -

The Value set.

- -
-
@@ -17204,100 +10079,57 @@

Return value:

-

RANGE:T(Arguments)

+

RANGE:onafterLoad(From, Event, To)

-

Trace a function logic level 1.

+

On after "Load" event.

-

Can be anywhere within the function logic.

+

Loads results of all players from file.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- Arguments + #string + From

-

A #table or any field.

+

From state.

-
- -
-
- -
- -
-

RANGE:T2(Arguments)

-
- -

Trace a function logic level 2.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Arguments + #string + Event

-

A #table or any field.

+

Event.

-
- -
-
- -
- -
-

RANGE:T3(Arguments)

-
- -

Trace a function logic level 3.

- - -

Can be anywhere within the function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Arguments + #string + To

-

A #table or any field.

+

To state.

@@ -17309,61 +10141,54 @@

Parameter:

-

RANGE:TraceAll(TraceAll)

+

RANGE:onafterSave(From, Event, To)

-

Trace all methods in MOOSE

+

Function called after save.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- #boolean - TraceAll + #string + From

-

true = trace all methods in MOOSE.

+

From state.

-
- -
-
- -
- -
-

RANGE:TraceClass(Class)

-
- -

Set tracing for a class

+
+
+

+ #string + Event +

+
+
+ +

Event.

-
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

+
+

#string - Class + To

-

Class name.

+

To state.

@@ -17375,28 +10200,31 @@

Parameter:

-

RANGE:TraceClassMethod(Class, Method)

+

RANGE:onafterStart(From, Event, To)

-

Set tracing for a specific method of class

+

Initializes number of targets and location of the range.

+ + +

Starts the event handlers.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

#string - Class + From

-

Class name.

+

From state.

@@ -17404,44 +10232,26 @@

Parameters:

#string - Method + Event

-

Method.

+

Event.

-
- -
-
- -
- -
-

RANGE:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- #number - Level + #string + To

-

+ +

To state.

+
@@ -17452,136 +10262,57 @@

Parameter:

-

RANGE:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing Off
-BASE:TraceOff()
- -
- -
-
- -
- -
-

RANGE:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

- 
-- Switch the tracing On
-BASE:TraceOn()
- -
- -
-
- -
- -
-

RANGE:TraceOnOff(TraceOnOff)

+

RANGE:onafterStatus(From, Event, To)

-

Set trace on or off -Note that when trace is off, no BASE.Debug statement is performed, increasing performance! -When Moose is loaded statically, (as one file), tracing is switched off by default.

- - -

So tracing must be switched on manually in your mission if you are using Moose statically. -When moose is loading dynamically (for moose class development), tracing is switched on by default.

+

Check spawn queue and spawn aircraft if necessary.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- #boolean - TraceOnOff + #string + From

-

Switch the tracing on or off.

+

From state.

-

Usage:

- 

-  -- Switch the tracing On
-  BASE:TraceOnOff( true )
-
-  -- Switch the tracing Off
-  BASE:TraceOnOff( false )
-
- -
- -
-
- -
- -
-

RANGE:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- Core.Event#EVENTS - EventID + #string + Event

-

Event ID.

+

Event.

-

Return value:

-
-
-

#BASE:

-
-
- - +
+
+

+ #string + To +

+
+
+ +

To state.

-
-
+
+
@@ -17590,95 +10321,83 @@

Return value:

-

RANGE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+

RANGE:onafterStrafeResult(From, Event, To, player, result)

-

Trace a function call.

- - -

This function is private.

+

Function called after strafing run.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

- Arguments + #string + From

-

A #table or any field.

+

From state.

- DebugInfoCurrentParam + #string + Event

-

+ +

Event.

+

- DebugInfoFromParam + #string + To

-

+ +

To state.

+
-
- -
-
- -
- -
-

RANGE:_Serialize(Arguments)

-
- -

(Internal) Serialize arguments

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

- #table - Arguments + #RANGE.PlayerData + player

-

+ +

Player data table.

+
-

Return value:

-
-
-

#string:

-
-
- -

Text

+
+
+

+ #RANGE.StrafeResult + result +

+
+
+ +

Result of run.

-
-
+
+
@@ -17687,48 +10406,58 @@

Return value:

-

RANGE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+

RANGE:onbeforeLoad(From, Event, To)

-

Trace a function logic.

+

Function called before save event.

+ + +

Checks that io and lfs are desanitized.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

Parameters:

- Arguments + #string + From

-

A #table or any field.

+

From state.

- DebugInfoCurrentParam + #string + Event

-

+ +

Event.

+

- DebugInfoFromParam + #string + To

-

+ +

To state.

+
@@ -17739,30 +10468,58 @@

Parameters:

-

RANGE:onEvent(event)

+

RANGE:onbeforeSave(From, Event, To)

-

The main event handling function...

+

Function called before save event.

-

This function captures all events generated for the class.

+

Checks that io and lfs are desanitized.

-
+

Defined in:

-

Core.Base#BASE

+

RANGE

-

Parameter:

+

Parameters:

- DCS#Event - event + #string + From

-

+ +

From state.

+ +
+
+
+
+

+ #string + Event +

+
+
+ +

Event.

+ +
+
+
+
+

+ #string + To +

+
+
+ +

To state.

+
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 37cb9bbff..17e166701 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9777,17 +9777,6 @@

Field(s)

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -9799,17 +9788,6 @@

Field(s)

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -30147,17 +30125,6 @@

Field(s)

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -30169,17 +30136,6 @@

Field(s)

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -33259,17 +33215,6 @@

Field(s)

Radio queue of LSO.

-
- -
-
-
- - -AIRBOSS.RQLid - - -
@@ -33281,17 +33226,6 @@

Field(s)

Radio queue of marshal.

-
- -
-
-
- - -AIRBOSS.RQMid - - -
@@ -41228,9 +41162,6 @@

Field(s)

- -

Set case of f

-
@@ -41312,17 +41243,6 @@

Field(s)

Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

-
- -
-
-
- - #boolean -AIRBOSS.PlayerData.holding - - -
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 22bdef4bd..192e9da84 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -8192,6 +8192,17 @@

Field(s)

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -8212,7 +8223,7 @@

Field(s)

- + #table CTLD.CtldUnits @@ -8298,7 +8309,7 @@

Field(s)

- + #table CTLD.FreeFMFrequencies @@ -8320,11 +8331,14 @@

Field(s)

- + #table CTLD.FreeVHFFrequencies + +

Beacons

+
@@ -8445,11 +8459,14 @@

Field(s)

- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -8972,7 +8989,7 @@

Field(s)

-

time to repairor build a unit/group

+

noob catch

@@ -18991,6 +19008,17 @@

Field(s)

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -19011,7 +19039,7 @@

Field(s)

- + #table CTLD.CtldUnits @@ -19097,7 +19125,7 @@

Field(s)

- + #table CTLD.FreeFMFrequencies @@ -19119,11 +19147,14 @@

Field(s)

- + #table CTLD.FreeVHFFrequencies + +

Beacons

+
@@ -19244,11 +19275,14 @@

Field(s)

- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -19771,7 +19805,7 @@

Field(s)

-

time to repairor build a unit/group

+

noob catch

@@ -21444,6 +21478,17 @@

Field(s)

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -21464,7 +21509,7 @@

Field(s)

- + #table CTLD.CtldUnits @@ -21550,7 +21595,7 @@

Field(s)

- + #table CTLD.FreeFMFrequencies @@ -21572,11 +21617,14 @@

Field(s)

- + #table CTLD.FreeVHFFrequencies + +

Beacons

+
@@ -21697,11 +21745,14 @@

Field(s)

- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -22224,7 +22275,7 @@

Field(s)

-

time to repairor build a unit/group

+

noob catch

@@ -26907,17 +26958,6 @@

Field(s)

Location (if set) where to get this cargo item.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
@@ -28444,17 +28484,6 @@

Field(s)

Location (if set) where to get this cargo item.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
@@ -32449,6 +32478,17 @@

Field(s)

+
+ +
+ @@ -33102,6 +33142,17 @@

Field(s)

+
+ +
+ @@ -36955,17 +37006,6 @@

Field(s)

template for a group of 10 paratroopers

-
- -
-
-
- - #number -CTLD_HERCULES.j - - -
@@ -38292,17 +38332,6 @@

Field(s)

template for a group of 10 paratroopers

-
- -
-
-
- - #number -CTLD_HERCULES.j - - -
diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 097318923..dd6d68c3a 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -3043,17 +3043,6 @@

Field(s)

-
- -
-
-
- - -TASK.TaskControlMenu - - -
@@ -7690,17 +7679,6 @@

Field(s)

-
- -
-
-
- - -TASK.TaskControlMenu - - -
diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index 4e7617360..dad052db6 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -3335,11 +3335,22 @@

Field(s)

+
+
+ + +FSM_PROCESS.DeployZone + + +
@@ -3372,7 +3383,7 @@

Field(s)

- #number + TASK_CARGO.CargoLimit @@ -4794,7 +4805,7 @@

Field(s)

- #number + TASK_CARGO.CargoLimit @@ -9326,7 +9337,7 @@

Field(s)

- #number + TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 1655bc6db..3f6dca849 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3375,8 +3375,41 @@

Field(s)

+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks @@ -4481,8 +4514,41 @@

Field(s)

+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks @@ -5339,8 +5405,41 @@

Field(s)

+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks @@ -6828,8 +6927,41 @@

Field(s)

+ + +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index a3c0c72cf..58eaee2e8 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -3467,6 +3467,17 @@

Field(s)

Stack by pointer.

+
+ +
+
+
+ + #number +FIFO.uniquecounter + + +
@@ -4316,6 +4327,17 @@

Field(s)

Stack by pointer.

+
+ +
+
+
+ + #number +FIFO.uniquecounter + + +
diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 7d5a02085..2ebf945ec 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -3181,6 +3181,28 @@

Field(s)

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -3258,28 +3280,6 @@

Field(s)

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
@@ -5320,6 +5320,28 @@

Field(s)

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -5397,28 +5419,6 @@

Field(s)

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
@@ -6930,6 +6930,28 @@

Field(s)

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -7007,28 +7029,6 @@

Field(s)

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -