From 0a2a0d28d67a834b9e423b295c8c106443925711 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Sat, 4 Feb 2023 22:45:04 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Cap.html | 11 + Documentation/AI.AI_A2A_Dispatcher.html | 11 + Documentation/AI.AI_A2A_Gci.html | 11 + Documentation/AI.AI_A2A_Patrol.html | 11 + Documentation/AI.AI_A2G_BAI.html | 11 + Documentation/AI.AI_A2G_CAS.html | 11 + Documentation/AI.AI_A2G_Dispatcher.html | 75 +- Documentation/AI.AI_A2G_SEAD.html | 11 + Documentation/AI.AI_Air.html | 99 +- Documentation/AI.AI_Air_Dispatcher.html | 11 + Documentation/AI.AI_Air_Engage.html | 11 + Documentation/AI.AI_Air_Patrol.html | 11 + Documentation/AI.AI_Air_Squadron.html | 33 +- Documentation/AI.AI_BAI.html | 11 + Documentation/AI.AI_Balancer.html | 11 + Documentation/AI.AI_CAP.html | 11 + Documentation/AI.AI_CAS.html | 11 + Documentation/AI.AI_Cargo.html | 23 + Documentation/AI.AI_Cargo_APC.html | 11 + Documentation/AI.AI_Cargo_Airplane.html | 91 +- Documentation/AI.AI_Cargo_Dispatcher.html | 11 + Documentation/AI.AI_Cargo_Dispatcher_APC.html | 11 + .../AI.AI_Cargo_Dispatcher_Airplane.html | 11 + .../AI.AI_Cargo_Dispatcher_Helicopter.html | 11 + .../AI.AI_Cargo_Dispatcher_Ship.html | 11 + Documentation/AI.AI_Cargo_Helicopter.html | 11 + Documentation/AI.AI_Cargo_Ship.html | 11 + Documentation/AI.AI_Escort.html | 11 + Documentation/AI.AI_Escort_Dispatcher.html | 11 + .../AI.AI_Escort_Dispatcher_Request.html | 11 + Documentation/AI.AI_Escort_Request.html | 11 + Documentation/AI.AI_Formation.html | 11 + Documentation/AI.AI_Patrol.html | 11 + Documentation/Actions.Act_Account.html | 11 + Documentation/Actions.Act_Assign.html | 11 + Documentation/Actions.Act_Assist.html | 11 + Documentation/Actions.Act_Route.html | 11 + Documentation/Cargo.Cargo.html | 11 + Documentation/Cargo.CargoCrate.html | 33 +- Documentation/Cargo.CargoGroup.html | 39 +- Documentation/Cargo.CargoSlingload.html | 11 + Documentation/Cargo.CargoUnit.html | 33 +- Documentation/Core.Astar.html | 11 + Documentation/Core.Base.html | 11 + Documentation/Core.Beacon.html | 11 + Documentation/Core.Condition.html | 11 + Documentation/Core.Database.html | 11 + Documentation/Core.Event.html | 11 + Documentation/Core.Fsm.html | 15 +- Documentation/Core.Goal.html | 11 + Documentation/Core.MarkerOps_Base.html | 11 + Documentation/Core.Menu.html | 11 + Documentation/Core.Message.html | 11 + Documentation/Core.Point.html | 44 +- Documentation/Core.Report.html | 11 + Documentation/Core.ScheduleDispatcher.html | 11 + Documentation/Core.Scheduler.html | 11 + Documentation/Core.Set.html | 11 + Documentation/Core.Settings.html | 15 +- Documentation/Core.Spawn.html | 125 +- Documentation/Core.SpawnStatic.html | 95 + Documentation/Core.Spot.html | 143 +- Documentation/Core.TextAndSound.html | 11 + Documentation/Core.Timer.html | 11 + Documentation/Core.UserFlag.html | 11 + Documentation/Core.Velocity.html | 11 + Documentation/Core.Zone.html | 11 + Documentation/Core.Zone_Detection.html | 11 + Documentation/DCS.html | 11 + Documentation/Functional.ATC_Ground.html | 21 +- Documentation/Functional.Artillery.html | 11 + Documentation/Functional.CleanUp.html | 11 + Documentation/Functional.Designate.html | 11 + Documentation/Functional.Detection.html | 50 +- Documentation/Functional.DetectionZones.html | 11 + Documentation/Functional.Escort.html | 11 + Documentation/Functional.Fox.html | 11 + Documentation/Functional.Mantis.html | 133 +- Documentation/Functional.MissileTrainer.html | 11 + Documentation/Functional.Movement.html | 39 + Documentation/Functional.PseudoATC.html | 11 + Documentation/Functional.RAT.html | 11 + Documentation/Functional.Range.html | 11 + Documentation/Functional.Scoring.html | 29 +- Documentation/Functional.Sead.html | 11 + Documentation/Functional.Shorad.html | 11 + Documentation/Functional.Suppression.html | 11 + Documentation/Functional.Warehouse.html | 11 + .../Functional.ZoneCaptureCoalition.html | 11 + Documentation/Functional.ZoneGoal.html | 11 + Documentation/Functional.ZoneGoalCargo.html | 11 + .../Functional.ZoneGoalCoalition.html | 11 + Documentation/Ops.ATIS.html | 11 + Documentation/Ops.Airboss.html | 35 +- Documentation/Ops.CSAR.html | 119 +- Documentation/Ops.CTLD.html | 282 +- Documentation/Ops.RecoveryTanker.html | 11 + Documentation/Ops.RescueHelo.html | 11 + Documentation/Sound.Radio.html | 11 + Documentation/Sound.RadioQueue.html | 11 + Documentation/Sound.RadioSpeech.html | 11 + Documentation/Sound.SRS.html | 11 + Documentation/Sound.SoundOutput.html | 11 + Documentation/Sound.UserSound.html | 11 + Documentation/Tasking.CommandCenter.html | 11 + Documentation/Tasking.DetectionManager.html | 11 + Documentation/Tasking.Mission.html | 11 + Documentation/Tasking.Task.html | 33 + Documentation/Tasking.TaskInfo.html | 11 + Documentation/Tasking.Task_A2A.html | 11 + .../Tasking.Task_A2A_Dispatcher.html | 11 + Documentation/Tasking.Task_A2G.html | 11 + .../Tasking.Task_A2G_Dispatcher.html | 31 +- Documentation/Tasking.Task_CARGO.html | 19 +- .../Tasking.Task_Capture_Dispatcher.html | 11 + Documentation/Tasking.Task_Capture_Zone.html | 11 + Documentation/Tasking.Task_Cargo_CSAR.html | 11 + .../Tasking.Task_Cargo_Dispatcher.html | 63 +- .../Tasking.Task_Cargo_Transport.html | 11 + Documentation/Tasking.Task_Manager.html | 11 + Documentation/Utilities.Enums.html | 11 + Documentation/Utilities.FiFo.html | 33 +- Documentation/Utilities.Profiler.html | 11 + Documentation/Utilities.Routines.html | 11 + Documentation/Utilities.STTS.html | 11 + Documentation/Utilities.Socket.html | 11 + Documentation/Utilities.Templates.html | 11 + Documentation/Utilities.Utils.html | 11 + Documentation/Wrapper.Airbase.html | 11 + Documentation/Wrapper.Client.html | 11 + Documentation/Wrapper.Controllable.html | 11 + Documentation/Wrapper.Group.html | 89 +- Documentation/Wrapper.Identifiable.html | 11 + Documentation/Wrapper.Marker.html | 11 + Documentation/Wrapper.Object.html | 11 + Documentation/Wrapper.Positionable.html | 11 + Documentation/Wrapper.Scenery.html | 11 + Documentation/Wrapper.Static.html | 11 + Documentation/Wrapper.Unit.html | 11 + Documentation/Wrapper.Weapon.html | 14308 ++++++++++++++++ Documentation/index.html | 23 + 141 files changed, 16523 insertions(+), 868 deletions(-) create mode 100644 Documentation/Wrapper.Weapon.html diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 876f65225..85da404c0 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index e7c06fb06..866dee3f1 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_A2A_Gci.html b/Documentation/AI.AI_A2A_Gci.html index 0fd28a053..0ab218d1f 100644 --- a/Documentation/AI.AI_A2A_Gci.html +++ b/Documentation/AI.AI_A2A_Gci.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_A2A_Patrol.html b/Documentation/AI.AI_A2A_Patrol.html index ce5f79f78..4cdc5e47a 100644 --- a/Documentation/AI.AI_A2A_Patrol.html +++ b/Documentation/AI.AI_A2A_Patrol.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_A2G_BAI.html b/Documentation/AI.AI_A2G_BAI.html index d4d8fe3f5..a623eb348 100644 --- a/Documentation/AI.AI_A2G_BAI.html +++ b/Documentation/AI.AI_A2G_BAI.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_A2G_CAS.html b/Documentation/AI.AI_A2G_CAS.html index 1ec280ad0..0f07385a1 100644 --- a/Documentation/AI.AI_A2G_CAS.html +++ b/Documentation/AI.AI_A2G_CAS.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 7d099ea57..7199fdfe3 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -4878,11 +4900,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -13234,6 +13259,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -13356,11 +13392,14 @@ multiplied by the Overhead and rounded up to the smallest integer.

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -14562,6 +14601,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -14684,11 +14734,14 @@ multiplied by the Overhead and rounded up to the smallest integer.

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -16192,6 +16245,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_A2G_DISPATCHER.DefenderPatrolIndex + + +
@@ -16314,11 +16378,14 @@ multiplied by the Overhead and rounded up to the smallest integer.

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
diff --git a/Documentation/AI.AI_A2G_SEAD.html b/Documentation/AI.AI_A2G_SEAD.html index 3820113bb..754f91e94 100644 --- a/Documentation/AI.AI_A2G_SEAD.html +++ b/Documentation/AI.AI_A2G_SEAD.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 35bed5e7f..0300a572b 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3136,28 +3147,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -5964,28 +5953,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6711,28 +6678,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -8346,28 +8291,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index b6bdbd8de..6ea2bba45 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Air_Engage.html b/Documentation/AI.AI_Air_Engage.html index 738fe1f88..d611159a9 100644 --- a/Documentation/AI.AI_Air_Engage.html +++ b/Documentation/AI.AI_Air_Engage.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index 89dcf37ce..dd75706f4 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 20880f485..5fca0df0f 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -2522,17 +2533,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3604,17 +3604,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
diff --git a/Documentation/AI.AI_BAI.html b/Documentation/AI.AI_BAI.html index 77985bf17..04e1637a7 100644 --- a/Documentation/AI.AI_BAI.html +++ b/Documentation/AI.AI_BAI.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index 1c586f4f2..afcd78964 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_CAP.html b/Documentation/AI.AI_CAP.html index 6b036ec8f..9b4db9b20 100644 --- a/Documentation/AI.AI_CAP.html +++ b/Documentation/AI.AI_CAP.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_CAS.html b/Documentation/AI.AI_CAS.html index 558a43b74..71413ca5e 100644 --- a/Documentation/AI.AI_CAS.html +++ b/Documentation/AI.AI_CAS.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index a3f62be50..3e80a5133 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

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

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

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

No loading happened, so we need to pickup something else.

+ diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index b2aaa92cf..963dcda3a 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index d3f8c6e58..e8c04d21d 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Aircraft is on a pickup mission.

- diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 92be83c40..5d7f0a7f7 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index 3aca021d6..a8e23331f 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index 54227e40b..39fb478b1 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index 012e924ed..14d84c3e1 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html index 3b2df51f2..f40652951 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index d149b8b74..70625bbb6 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Cargo_Ship.html b/Documentation/AI.AI_Cargo_Ship.html index 3b49a2fb6..0178af208 100644 --- a/Documentation/AI.AI_Cargo_Ship.html +++ b/Documentation/AI.AI_Cargo_Ship.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Escort.html b/Documentation/AI.AI_Escort.html index 84b3b7d5f..35030bbc8 100644 --- a/Documentation/AI.AI_Escort.html +++ b/Documentation/AI.AI_Escort.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index 099c5dd56..de9d73954 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Escort_Dispatcher_Request.html b/Documentation/AI.AI_Escort_Dispatcher_Request.html index fa6b476b4..d553a978d 100644 --- a/Documentation/AI.AI_Escort_Dispatcher_Request.html +++ b/Documentation/AI.AI_Escort_Dispatcher_Request.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Escort_Request.html b/Documentation/AI.AI_Escort_Request.html index 4b4555c22..0fc0e8eab 100644 --- a/Documentation/AI.AI_Escort_Request.html +++ b/Documentation/AI.AI_Escort_Request.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index 7786d0804..d3efbf0c3 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index a62e057a4..1243336d1 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Actions.Act_Account.html b/Documentation/Actions.Act_Account.html index 287314fe3..be3a6767b 100644 --- a/Documentation/Actions.Act_Account.html +++ b/Documentation/Actions.Act_Account.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Actions.Act_Assign.html b/Documentation/Actions.Act_Assign.html index 1fd130d3b..7251121af 100644 --- a/Documentation/Actions.Act_Assign.html +++ b/Documentation/Actions.Act_Assign.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Actions.Act_Assist.html b/Documentation/Actions.Act_Assist.html index 72e0aa7e2..ee05649de 100644 --- a/Documentation/Actions.Act_Assist.html +++ b/Documentation/Actions.Act_Assist.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Actions.Act_Route.html b/Documentation/Actions.Act_Route.html index 70c799ee0..df7cf4a75 100644 --- a/Documentation/Actions.Act_Route.html +++ b/Documentation/Actions.Act_Route.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index 989dbf1b5..91ab22ba6 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 23ef291a8..8ce240c3b 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -1826,17 +1837,6 @@

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
@@ -2505,17 +2505,6 @@

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 709cc46ad..6d77ff55d 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -1897,20 +1908,6 @@
-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup @@ -3232,20 +3229,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index c092d1509..33e15502e 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 9da278e01..015350d21 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -1775,17 +1786,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2490,17 +2490,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Astar.html b/Documentation/Core.Astar.html index 9d29d6508..28e559866 100644 --- a/Documentation/Core.Astar.html +++ b/Documentation/Core.Astar.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Base.html b/Documentation/Core.Base.html index 6bc5f1399..54ac63c54 100644 --- a/Documentation/Core.Base.html +++ b/Documentation/Core.Base.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Beacon.html b/Documentation/Core.Beacon.html index 9c171b087..15d755630 100644 --- a/Documentation/Core.Beacon.html +++ b/Documentation/Core.Beacon.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Condition.html b/Documentation/Core.Condition.html index aea7a2ede..477102174 100644 --- a/Documentation/Core.Condition.html +++ b/Documentation/Core.Condition.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Database.html b/Documentation/Core.Database.html index c09ef730c..1f4c09f00 100644 --- a/Documentation/Core.Database.html +++ b/Documentation/Core.Database.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Event.html b/Documentation/Core.Event.html index 7a410e084..13c9496ad 100644 --- a/Documentation/Core.Event.html +++ b/Documentation/Core.Event.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 5c7ae450b..285720664 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -5760,7 +5771,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7359,7 +7370,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState diff --git a/Documentation/Core.Goal.html b/Documentation/Core.Goal.html index 37a204b97..31ccc4bee 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.MarkerOps_Base.html b/Documentation/Core.MarkerOps_Base.html index 22a87a97a..1d11bf9e8 100644 --- a/Documentation/Core.MarkerOps_Base.html +++ b/Documentation/Core.MarkerOps_Base.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index e777ddd8c..b2bff3021 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index 00e9f4e83..fbb09ee7c 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 7cb70310a..f7619257e 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -17759,17 +17770,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
@@ -18568,17 +18568,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

the y coordinate in meters.

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

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
diff --git a/Documentation/Core.Report.html b/Documentation/Core.Report.html index f2c545576..4e9a848fb 100644 --- a/Documentation/Core.Report.html +++ b/Documentation/Core.Report.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.ScheduleDispatcher.html b/Documentation/Core.ScheduleDispatcher.html index 2e1fd1652..26ada1f13 100644 --- a/Documentation/Core.ScheduleDispatcher.html +++ b/Documentation/Core.ScheduleDispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Scheduler.html b/Documentation/Core.Scheduler.html index e8fd23926..5c1450b4c 100644 --- a/Documentation/Core.Scheduler.html +++ b/Documentation/Core.Scheduler.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index d7586a0ab..f735815d9 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 050ed138e..78bbe4eb8 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -2817,7 +2828,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -4985,7 +4996,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 09444fad2..fe655b3e0 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3371,14 +3382,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

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

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

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

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

+
@@ -3528,17 +3553,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnGrouping - - -
@@ -3608,17 +3622,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -3713,17 +3716,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -3938,7 +3930,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

+

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

@@ -8728,14 +8720,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -8808,6 +8797,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+ + +
+
+ + #number +SPAWN.SpawnCount + + + + +

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

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

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

- - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -9070,17 +9054,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+

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

diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 9c827547b..9d1196e76 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -1960,6 +1971,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -2874,6 +2903,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -4227,6 +4289,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 0378882be..a38f1bea1 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -2766,50 +2777,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -4071,50 +4038,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
@@ -5615,50 +5538,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - - -
- -
-
-
- - -SPOT.Target - - -
diff --git a/Documentation/Core.TextAndSound.html b/Documentation/Core.TextAndSound.html index 273486b24..d8e0c89fc 100644 --- a/Documentation/Core.TextAndSound.html +++ b/Documentation/Core.TextAndSound.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Timer.html b/Documentation/Core.Timer.html index 25f88cc9f..df18cb808 100644 --- a/Documentation/Core.Timer.html +++ b/Documentation/Core.Timer.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.UserFlag.html b/Documentation/Core.UserFlag.html index 55d181f6e..087a64725 100644 --- a/Documentation/Core.UserFlag.html +++ b/Documentation/Core.UserFlag.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Velocity.html b/Documentation/Core.Velocity.html index 0f9987abc..5efa4f3da 100644 --- a/Documentation/Core.Velocity.html +++ b/Documentation/Core.Velocity.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index f27fc1bd9..0d2e4692a 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Core.Zone_Detection.html b/Documentation/Core.Zone_Detection.html index a7dc5831d..6cc2a9cbe 100644 --- a/Documentation/Core.Zone_Detection.html +++ b/Documentation/Core.Zone_Detection.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/DCS.html b/Documentation/DCS.html index 3c2b593ea..eb1775043 100644 --- a/Documentation/DCS.html +++ b/Documentation/DCS.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index 04e322406..9d2db3e01 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3832,7 +3843,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + ATC_GROUND.Airbases @@ -3848,9 +3859,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Kickspeed

-
@@ -4417,7 +4425,7 @@ An airbase can be specified to set the maximum kick speed for.

- #table + ATC_GROUND.Airbases @@ -4433,9 +4441,6 @@ An airbase can be specified to set the maximum kick speed for.

- -

Kickspeed

-
diff --git a/Documentation/Functional.Artillery.html b/Documentation/Functional.Artillery.html index 99e1dc632..7d80e9798 100644 --- a/Documentation/Functional.Artillery.html +++ b/Documentation/Functional.Artillery.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.CleanUp.html b/Documentation/Functional.CleanUp.html index 58ba99327..85ee8f572 100644 --- a/Documentation/Functional.CleanUp.html +++ b/Documentation/Functional.CleanUp.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index db8562d48..ba7376dfe 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 44ad30d74..fe978ef2f 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -19101,6 +19112,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + +
@@ -19261,7 +19283,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- + #number DETECTION_BASE.RefreshTimeInterval @@ -23793,6 +23815,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + +
@@ -23953,7 +23986,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval @@ -25546,6 +25579,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemCount + + +
@@ -25706,7 +25750,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- + #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.DetectionZones.html b/Documentation/Functional.DetectionZones.html index 5872a68b5..5e9a9d0de 100644 --- a/Documentation/Functional.DetectionZones.html +++ b/Documentation/Functional.DetectionZones.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+ +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Escort.html b/Documentation/Functional.Escort.html index 92c661e54..fd4e3d929 100644 --- a/Documentation/Functional.Escort.html +++ b/Documentation/Functional.Escort.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Fox.html b/Documentation/Functional.Fox.html index 9c5323ae0..65c98025d 100644 --- a/Documentation/Functional.Fox.html +++ b/Documentation/Functional.Fox.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index b92697a2d..2f7026045 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -1970,6 +1981,12 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:GetCommandCenter()

Function to get the HQ object for further use

+ + + +

MANTIS.Groupset

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

Prefix to build the #SET_GROUP for EWR group

+ + + +
+
+ + +MANTIS.Groupset + + +
@@ -4227,50 +4255,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Prefix for logging

- - - -
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -4329,6 +4313,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

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

Prefix to build the #SET_GROUP for EWR group

+ + + +
+
+ + +MANTIS.Groupset + + +
@@ -8727,50 +8725,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Prefix for logging

- - - -
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -8829,6 +8783,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

switch alarm state RED

+ diff --git a/Documentation/Functional.MissileTrainer.html b/Documentation/Functional.MissileTrainer.html index 258c39a36..0192a9aee 100644 --- a/Documentation/Functional.MissileTrainer.html +++ b/Documentation/Functional.MissileTrainer.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index ab68d6d2a..374cac255 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

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

Field(s)

+
+
+ + #number +MOVEMENT.AliveUnits + + + + +

Contains the counter how many units are currently alive.

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

Field(s)

+
+
+ + #number +MOVEMENT.AliveUnits + + + + +

Contains the counter how many units are currently alive.

+ +
+ +
diff --git a/Documentation/Functional.PseudoATC.html b/Documentation/Functional.PseudoATC.html index 601cf4e4b..0f6a898dc 100644 --- a/Documentation/Functional.PseudoATC.html +++ b/Documentation/Functional.PseudoATC.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index 2d5779d69..6b680ed33 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index 19d03e6bc..fef8bef2a 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index f54586b00..e7e9586a8 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -2893,11 +2904,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -3080,7 +3094,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyoncoalitionchange @@ -3091,7 +3105,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyonfratricide @@ -5479,11 +5493,14 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -5666,7 +5683,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyoncoalitionchange @@ -5677,7 +5694,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyonfratricide diff --git a/Documentation/Functional.Sead.html b/Documentation/Functional.Sead.html index be93aee7b..96fbeafb9 100644 --- a/Documentation/Functional.Sead.html +++ b/Documentation/Functional.Sead.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Shorad.html b/Documentation/Functional.Shorad.html index 8de7126ac..98242bec8 100644 --- a/Documentation/Functional.Shorad.html +++ b/Documentation/Functional.Shorad.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index 76ff1a0da..2b73bb5cd 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+ +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index 2631535e2..7d04637f2 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.ZoneCaptureCoalition.html b/Documentation/Functional.ZoneCaptureCoalition.html index b386e13b8..6689598e3 100644 --- a/Documentation/Functional.ZoneCaptureCoalition.html +++ b/Documentation/Functional.ZoneCaptureCoalition.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.ZoneGoal.html b/Documentation/Functional.ZoneGoal.html index f33ff1402..7ad5759e0 100644 --- a/Documentation/Functional.ZoneGoal.html +++ b/Documentation/Functional.ZoneGoal.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.ZoneGoalCargo.html b/Documentation/Functional.ZoneGoalCargo.html index 419944d12..274ab7879 100644 --- a/Documentation/Functional.ZoneGoalCargo.html +++ b/Documentation/Functional.ZoneGoalCargo.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Functional.ZoneGoalCoalition.html b/Documentation/Functional.ZoneGoalCoalition.html index 76b3b3e1e..26032bf80 100644 --- a/Documentation/Functional.ZoneGoalCoalition.html +++ b/Documentation/Functional.ZoneGoalCoalition.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Ops.ATIS.html b/Documentation/Ops.ATIS.html index 6c95cc54e..7b51d6fa5 100644 --- a/Documentation/Ops.ATIS.html +++ b/Documentation/Ops.ATIS.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 3d804db1f..e77e07a30 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -39631,7 +39642,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set case to that of lead.

+

Set case of f

@@ -39695,20 +39706,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-AIRBOSS.PlayerData.flag - - - - -

Set stack flag.

- -
- - -
-
- - AIRBOSS.PlayerData.grade @@ -39863,7 +39860,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set section lead of player flight.

+

Make player section lead if he was not before.

@@ -39887,9 +39884,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set Stable Hover

-
@@ -39923,9 +39917,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set time stamp.

- diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index e385a0e4b..f8c2ff99a 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -2553,6 +2564,12 @@ Dropped troop noMessage and forcedesc parameters aren't saved.

CSAR.inTransitGroups

+ + + +

CSAR.index

+ + @@ -3925,7 +3942,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CSAR.FreeVHFFrequencies @@ -4338,14 +4355,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -4366,25 +4380,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CSAR.downedPilots - -

Replacement woundedGroups

- -
- -
-
-
- - #number -CSAR.downedpilotcounter - - -
@@ -4508,6 +4508,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

contain a table for each SAR with all units he has with the original names

+
+ +
+
+
+ + +CSAR.index + + +
@@ -9910,7 +9921,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -10323,14 +10334,11 @@ callsigns from playername or group name.

- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -10351,25 +10359,11 @@ callsigns from playername or group name.

- #table + CSAR.downedPilots - -

Replacement woundedGroups

- -
- -
-
-
- - #number -CSAR.downedpilotcounter - - -
@@ -10493,6 +10487,17 @@ callsigns from playername or group name.

contain a table for each SAR with all units he has with the original names

+
+ +
+
+
+ + +CSAR.index + + +
@@ -12380,7 +12385,7 @@ callsigns from playername or group name.

- + #table CSAR.FreeVHFFrequencies @@ -12793,14 +12798,11 @@ callsigns from playername or group name.

- #table + CSAR.csarUnits - -

table of CSAR unit names

-
@@ -12821,25 +12823,11 @@ callsigns from playername or group name.

- #table + CSAR.downedPilots - -

Replacement woundedGroups

- -
- -
-
-
- - #number -CSAR.downedpilotcounter - - -
@@ -12963,6 +12951,17 @@ callsigns from playername or group name.

contain a table for each SAR with all units he has with the original names

+
+ +
+
+
+ + +CSAR.index + + +
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index b949cd2b0..f95f4467d 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

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

Field(s)

+
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -7410,6 +7432,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -7441,7 +7474,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -7463,7 +7496,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -7488,11 +7521,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -7524,7 +7574,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -7535,7 +7585,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeUHFFrequencies @@ -7676,11 +7726,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

+
@@ -7720,14 +7773,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string CTLD.RadioPath - -

Folderpath.

-
@@ -7800,6 +7850,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -8222,7 +8283,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

noob catch

+

time to repairor build a unit/group

@@ -8299,7 +8360,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number CTLD.troopdropzoneradius @@ -16543,6 +16604,17 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

+
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -16609,6 +16681,17 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -16640,7 +16723,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.CtldUnits @@ -16662,7 +16745,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.DroppedTroops @@ -16687,11 +16770,28 @@ However, if you create a new folder inside the miz file, which contains the soun
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -16723,7 +16823,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeFMFrequencies @@ -16734,7 +16834,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeUHFFrequencies @@ -16875,11 +16975,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.PilotGroups + +

tables

+
@@ -16919,14 +17022,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #string CTLD.RadioPath - -

Folderpath.

-
@@ -16999,6 +17099,17 @@ However, if you create a new folder inside the miz file, which contains the soun +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -17421,7 +17532,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

noob catch

+

time to repairor build a unit/group

@@ -17498,7 +17609,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #number CTLD.troopdropzoneradius @@ -19009,6 +19120,17 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

+
+
+ + #number +CTLD.CargoCounter + + + +
+ +
@@ -19075,6 +19197,17 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -19106,7 +19239,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.CtldUnits @@ -19128,7 +19261,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.DroppedTroops @@ -19153,11 +19286,28 @@ However, if you create a new folder inside the miz file, which contains the soun
+ #number +CTLD.Engineers + + + +

use as counter

+ +
+ +
+
+
+ + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -19189,7 +19339,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeFMFrequencies @@ -19200,7 +19350,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeUHFFrequencies @@ -19341,11 +19491,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.PilotGroups + +

tables

+
@@ -19385,14 +19538,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #string CTLD.RadioPath - -

Folderpath.

-
@@ -19465,6 +19615,17 @@ However, if you create a new folder inside the miz file, which contains the soun +
+ +
+
+
+ + #number +CTLD.TroopCounter + + +
@@ -19887,7 +20048,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

noob catch

+

time to repairor build a unit/group

@@ -19964,7 +20125,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #number CTLD.troopdropzoneradius @@ -23967,17 +24128,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Can transport crate.

-
- -
-
-
- - #number -CTLD.UnitCapabilities.length - - -
@@ -24153,17 +24303,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
@@ -24313,17 +24452,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Flag for direct loading.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
@@ -32144,17 +32272,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

template for a group of 10 paratroopers

-
- -
-
-
- - #number -CTLD_HERCULES.j - - -
@@ -33408,17 +33525,6 @@ Use either this method to integrate the Hercules **or** the one from the "normal

template for a group of 10 paratroopers

-
- -
-
-
- - #number -CTLD_HERCULES.j - - -
diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index e3008922f..15324131f 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index 9c4bf2941..5e8cd5091 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Sound.Radio.html b/Documentation/Sound.Radio.html index 43a56a490..112f05919 100644 --- a/Documentation/Sound.Radio.html +++ b/Documentation/Sound.Radio.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Sound.RadioQueue.html b/Documentation/Sound.RadioQueue.html index b10d8fe95..3c88ef700 100644 --- a/Documentation/Sound.RadioQueue.html +++ b/Documentation/Sound.RadioQueue.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+ +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Sound.RadioSpeech.html b/Documentation/Sound.RadioSpeech.html index ef727c5d3..02a213de6 100644 --- a/Documentation/Sound.RadioSpeech.html +++ b/Documentation/Sound.RadioSpeech.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html index 79b13370f..09490343a 100644 --- a/Documentation/Sound.SRS.html +++ b/Documentation/Sound.SRS.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Sound.SoundOutput.html b/Documentation/Sound.SoundOutput.html index 847e129a8..f2140d71f 100644 --- a/Documentation/Sound.SoundOutput.html +++ b/Documentation/Sound.SoundOutput.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Sound.UserSound.html b/Documentation/Sound.UserSound.html index 8e0586fd6..b1dcf6770 100644 --- a/Documentation/Sound.UserSound.html +++ b/Documentation/Sound.UserSound.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index 9abe456dc..996737c60 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index af5305e67..0c52e6299 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index ad6d03b30..96d6efcc0 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 2e7e23d93..bfaf4abfe 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -2897,6 +2908,17 @@ but can separately be modified later in your mission using the + + + +
+
+ + +TASK.TaskControlMenu + + +
@@ -7533,6 +7555,17 @@ If the Unit is part of the Task, true is returned.

+ + + +
+
+ + +TASK.TaskControlMenu + + +
diff --git a/Documentation/Tasking.TaskInfo.html b/Documentation/Tasking.TaskInfo.html index 4dd0dd364..ca922bf53 100644 --- a/Documentation/Tasking.TaskInfo.html +++ b/Documentation/Tasking.TaskInfo.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_A2A.html b/Documentation/Tasking.Task_A2A.html index eea8863bf..b37c212b4 100644 --- a/Documentation/Tasking.Task_A2A.html +++ b/Documentation/Tasking.Task_A2A.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index dd7fdf25c..c88883835 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_A2G.html b/Documentation/Tasking.Task_A2G.html index 910c96663..782cf568d 100644 --- a/Documentation/Tasking.Task_A2G.html +++ b/Documentation/Tasking.Task_A2G.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 3a779e93f..064d9ca66 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3168,11 +3179,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -3745,11 +3759,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -4932,11 +4949,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
@@ -6421,11 +6441,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

set to false to suppress flash messages

+
diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index 82754ac01..d30f7c7bc 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3190,7 +3201,7 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo @@ -3227,7 +3238,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -4649,7 +4660,7 @@ based on the tasking capabilities defined in
- + #number TASK_CARGO.CargoLimit @@ -9181,7 +9192,7 @@ If the Unit is part of the Task, true is returned.

- + #number TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Capture_Dispatcher.html b/Documentation/Tasking.Task_Capture_Dispatcher.html index ce0e4c1c3..68bafa618 100644 --- a/Documentation/Tasking.Task_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Capture_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_Capture_Zone.html b/Documentation/Tasking.Task_Capture_Zone.html index 9e65bdf66..98ad4bcac 100644 --- a/Documentation/Tasking.Task_Capture_Zone.html +++ b/Documentation/Tasking.Task_Capture_Zone.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+ +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_Cargo_CSAR.html b/Documentation/Tasking.Task_Cargo_CSAR.html index 41ca01c3e..0562ab8db 100644 --- a/Documentation/Tasking.Task_Cargo_CSAR.html +++ b/Documentation/Tasking.Task_Cargo_CSAR.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 8be8c2430..67a74924d 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3175,18 +3186,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4281,18 +4281,7 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5139,18 +5128,7 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6628,18 +6606,7 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR - - - -
- -
-
-
- - + #table TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Tasking.Task_Cargo_Transport.html b/Documentation/Tasking.Task_Cargo_Transport.html index b2219d749..03275e31b 100644 --- a/Documentation/Tasking.Task_Cargo_Transport.html +++ b/Documentation/Tasking.Task_Cargo_Transport.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index d37f18ab5..70e5fb8a2 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.Enums.html b/Documentation/Utilities.Enums.html index d9b7984a3..08c42966b 100644 --- a/Documentation/Utilities.Enums.html +++ b/Documentation/Utilities.Enums.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+ +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index f798dd2fe..e4a5eb76a 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

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

Stack by pointer.

- - - -
-
- - #number -FIFO.uniquecounter - - -
@@ -4078,17 +4078,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Stack by pointer.

- - - -
-
- - #number -FIFO.uniquecounter - - -
diff --git a/Documentation/Utilities.Profiler.html b/Documentation/Utilities.Profiler.html index 8f43731b2..13a1e1859 100644 --- a/Documentation/Utilities.Profiler.html +++ b/Documentation/Utilities.Profiler.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.Routines.html b/Documentation/Utilities.Routines.html index 3d95343e9..e636dcf40 100644 --- a/Documentation/Utilities.Routines.html +++ b/Documentation/Utilities.Routines.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.STTS.html b/Documentation/Utilities.STTS.html index 6de0a6c6d..d9613f4ab 100644 --- a/Documentation/Utilities.STTS.html +++ b/Documentation/Utilities.STTS.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.Socket.html b/Documentation/Utilities.Socket.html index d807962c4..7aa5e1bf2 100644 --- a/Documentation/Utilities.Socket.html +++ b/Documentation/Utilities.Socket.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.Templates.html b/Documentation/Utilities.Templates.html index da3c4263f..7cccb3c49 100644 --- a/Documentation/Utilities.Templates.html +++ b/Documentation/Utilities.Templates.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Utilities.Utils.html b/Documentation/Utilities.Utils.html index f58196fad..4f9c88367 100644 --- a/Documentation/Utilities.Utils.html +++ b/Documentation/Utilities.Utils.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 4194d0eb3..7eb1bf99f 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 25a2043d3..b864ca77e 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index e32c1da91..902530e49 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 981ec2d40..dba4c8c23 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -4980,18 +4991,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionInner - - - -
- - -
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -9524,18 +9524,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -18679,18 +18668,7 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -22536,18 +22514,7 @@ Coordinates are dependent on the position of the maps origin.

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

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

-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone diff --git a/Documentation/Wrapper.Identifiable.html b/Documentation/Wrapper.Identifiable.html index 3869fb3f9..cc297c9ca 100644 --- a/Documentation/Wrapper.Identifiable.html +++ b/Documentation/Wrapper.Identifiable.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 201632ff0..e8f02ac77 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+
+
+
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Object.html b/Documentation/Wrapper.Object.html index 2dddb6f6d..b2f1aea78 100644 --- a/Documentation/Wrapper.Object.html +++ b/Documentation/Wrapper.Object.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index e80f9a068..f2dbad43e 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html index 70a305fac..f09d392c1 100644 --- a/Documentation/Wrapper.Scenery.html +++ b/Documentation/Wrapper.Scenery.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index da58ca8aa..5f8da1dba 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html index eb61ce17a..a7432b847 100644 --- a/Documentation/Wrapper.Unit.html +++ b/Documentation/Wrapper.Unit.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

diff --git a/Documentation/Wrapper.Weapon.html b/Documentation/Wrapper.Weapon.html new file mode 100644 index 000000000..9ffad6716 --- /dev/null +++ b/Documentation/Wrapper.Weapon.html @@ -0,0 +1,14308 @@ + + + + + + + + + + + + + + + +
+

+ +

+
+
+ + +Banner Image +
+
+

Module Wrapper.Weapon

+
+
+ +

Wrapper - Weapon functions.

+ + + +

Main Features:

+ +
    +
  • Convenient access to DCS API functions
    • +
  • Track weapon and get impact position
    • +
  • Get launcher and target of weapon
    • +
  • Define callback function when weapon impacts
    • +
  • Define callback function when tracking weapon
    • +
  • Mark impact points on F10 map
    • +
  • Put coloured smoke on impact points
    • +
+ +
+ +

Example Missions:

+ +

Demo missions can be found on github.

+ +
+ +

Author: funkyfranky

+ +
+ +
+

Global(s)

+
+ + + + + +

Global WEAPON

 +

In the long run, the sharpest weapon of all is a kind and gentle spirit. -- Anne Frank

+ +
+ +

The WEAPON Concept

+ +

The WEAPON class offers an easy-to-use wrapper interface to all DCS API functions.

+
+
+
+
+ + #WEAPON +WEAPON + +

In the long run, the sharpest weapon of all is a kind and gentle spirit. -- Anne Frank

+ +
+ +

The WEAPON Concept

+ +

The WEAPON class offers an easy-to-use wrapper interface to all DCS API functions.

+ + + +

Probably, the most striking highlight is that the position of the weapon can be tracked and its impact position can be determined, which is not +possible with the native DCS scripting engine functions.

+ +

Note that this wrapper class is different from most others as weapon objects cannot be found with a DCS API function like getByName(). +They can only be found in DCS events like the "Shot" event, where the weapon object is contained in the event data.

+ +

Tracking

+ +

The status of the weapon can be tracked with the WEAPON.StartTrack function. This function will try to determin the position of the weapon in (normally) relatively +small time steps. The time step can be set via the WEAPON.SetTimeStepTrack function and is by default set to 0.01 seconds.

+ +

Once the position cannot be retrieved any more, the weapon has impacted (or was destroyed otherwise) and the last known position is safed as the impact point. +The impact point can be accessed with the WEAPON.GetImpactVec3 or WEAPON.GetImpactCoordinate functions.

+ +

Impact Point Marking

+ +

You can mark the impact point on the F10 map with WEAPON.SetMarkImpact.

+ +

You can also trigger coloured smoke at the impact point via WEAPON.SetSmokeImpact.

+ +

Callback functions

+ +

It is possible to define functions that are called during the tracking of the weapon and upon impact, which help you to customize further actions.

+ +

Callback on Impact

+ +

The function called on impact can be set with WEAPON.SetFuncImpact

+ +

Callback when Tracking

+ +

The function called each time the weapon status is tracked can be set with WEAPON.SetFuncTrack

+ +

Target

+ +

If the weapon has a specific target, you can get it with the WEAPON.GetTarget function. Note that the object, which is returned can vary. Normally, it is a UNIT +but it could also be a STATIC object.

+ +

Also note that the weapon does not always have a target, it can loose a target and re-aquire it and the target might change to another unit.

+ +

You can get the target name with the WEAPON.GetTargetName function.

+ +

The distance to the target is returned by the WEAPON.GetTargetDistance function.

+ +

Category

+ +

The category (bomb, rocket, missile, shell, torpedo) of the weapon can be retrieved with the WEAPON.GetCategory function.

+ +

You can check if the weapon is a

+ + + +

Parameters

+ +

You can get various parameters of the weapon, e.g.

+ + + +

Dependencies

+ +

This class is used (at least) in the MOOSE classes:

+ +
    +
  • RANGE (to determine the impact points of bombs and missiles)
    • +
  • ARTY (to destroy and replace shells with smoke or illumination)
    • +
  • FOX (to destroy the missile before it hits the target)
    • +
+ + +
+ +
+

Type(s)

+

Type WEAPON

+
+ WEAPON +, extends Wrapper.Positionable#POSITIONABLE +, extends Wrapper.Identifiable#IDENTIFIABLE +, extends Wrapper.Object#OBJECT +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from WEAPONDescription

WEAPON.ClassName

 +

Name of the class.

+

WEAPON:Destroy(Delay)

 +

Destroy the weapon object.

+

WEAPON:GetCoalition()

 +

Get coalition.

+

WEAPON:GetCountry()

 +

Get country.

+

WEAPON:GetDCSObject()

 +

Get DCS object.

+

WEAPON:GetImpactCoordinate()

 +

Get the impact coordinate.

+

WEAPON:GetImpactVec3()

 +

Get the impact position vector.

+

WEAPON:GetLauncher()

 +

Get the unit that launched the weapon.

+

WEAPON:GetSpeed(ConversionFunction)

 +

Get speed of weapon.

+

WEAPON:GetTarget()

 +

Get the target, which the weapon is guiding to.

+

WEAPON:GetTargetDistance(ConversionFunction)

 +

Get the distance to the current target the weapon is guiding to.

+

WEAPON:GetTargetName()

 +

Get name the current target the weapon is guiding to.

+

WEAPON:GetTypeName()

 +

Get type name.

+

WEAPON:GetVec2()

 +

Get the current 2D position vector.

+

WEAPON:GetVec3()

 +

Get the current 3D position vector.

+

WEAPON:GetVelocityVec3()

 +

Get velocity vector of weapon.

+

WEAPON:InAir()

 +

Check if weapon is in the air.

+

WEAPON:IsBomb()

 +

Check if weapon is a bomb.

+

WEAPON:IsExist()

 +

Check if weapon object (still) exists.

+

WEAPON:IsMissile()

 +

Check if weapon is a missile.

+

WEAPON:IsRocket()

 +

Check if weapon is a rocket.

+

WEAPON:IsShell()

 +

Check if weapon is a shell.

+

WEAPON:IsTorpedo()

 +

Check if weapon is a torpedo.

+

WEAPON:New(WeaponObject)

 +

Create a new WEAPON object from the DCS weapon object.

+

WEAPON:SetDistanceInterceptPoint(Distance)

 +

Set distance of intercept point for estimated impact point.

+

WEAPON:SetFuncImpact(FuncImpact, ...)

 +

Set callback function when weapon impacted or was destroyed otherwise, i.e. cannot be tracked any more.

+

WEAPON:SetFuncTrack(FuncTrack, ...)

 +

Set callback function when weapon is tracked and still alive.

+

WEAPON:SetMarkImpact(Switch)

 +

Mark impact point on the F10 map.

+

WEAPON:SetSmokeImpact(Switch, SmokeColor)

 +

Put smoke on impact point.

+

WEAPON:SetTimeStepTrack(TimeStep)

 +

Set track position time step.

+

WEAPON:SetVerbosity(VerbosityLevel)

 +

Set verbosity level.

+

WEAPON:StartTrack(Delay)

 +

Start tracking the weapon until it impacts or is destroyed otherwise.

+

WEAPON:StopTrack(Delay)

 +

Stop tracking the weapon by removing the scheduler function.

+

WEAPON:_GetIP(Distance)

 +

Compute estimated intercept/impact point (IP) based on last known position and direction.

+

WEAPON:_TrackWeapon(time)

 +

Track weapon until impact.

+

WEAPON.category

 +

Weapon category 0=SHELL, 1=MISSILE, 2=ROCKET, 3=BOMB, 4=TORPEDO (Weapon.Category.X).

+

WEAPON.categoryMissile

 +

Missile category 0=AAM, 1=SAM, 2=BM, 3=ANTI_SHIP, 4=CRUISE, 5=OTHER (Weapon.MissileCategory.X).

+

WEAPON.coalition

 +

Coalition ID.

+

WEAPON.coordinate

 +

Coordinate object of the weapon. Can be used in other classes.

+

WEAPON.country

 +

Country ID.

+

WEAPON.desc

 +

Descriptor table.

+

WEAPON.distIP

 +

Distance in meters for the intercept point estimation.

+

WEAPON.dtTrack

 +

Time step in seconds for tracking scheduler.

+

WEAPON.impactArg

 +

Optional arguments for the impact callback function.

+

WEAPON.impactCoord

 +

Impact coordinate.

+

WEAPON.impactDestroy

 +

If true, destroy weapon before impact. Requires tracking to be started and sufficiently small time step.

+

WEAPON.impactDestroyDist

 +

Distance in meters to the estimated impact point. If smaller, then weapon is destroyed.

+

WEAPON.impactFunc

 +

Callback function for weapon impact.

+

WEAPON.impactMark

 +

If true, the impact point is marked on the F10 map. Requires tracking to be started.

+

WEAPON.impactSmoke

 +

If true, the impact point is marked by smoke. Requires tracking to be started.

+

WEAPON.impactSmokeColor

 +

Colour of impact point smoke.

+

WEAPON.impactVec3

 +

Impact 3D vector.

+

WEAPON.launcher

 +

Launcher DCS unit.

+

WEAPON.launcherName

 +

Name of launcher unit.

+

WEAPON.launcherUnit

 +

Launcher Unit.

+

WEAPON.lid

 +

Class id string for output to DCS log file.

+

WEAPON.name

 +

Name of the weapon object.

+

WEAPON.pos3

 +

Last known 3D position and direction vector of the tracked weapon.

+

WEAPON.target

 +

Last known target.

+

WEAPON.trackArg

 +

Optional arguments for the track callback function.

+

WEAPON.trackFunc

 +

Callback function when weapon is tracked and alive.

+

WEAPON.trackScheduleID

 +

Tracking scheduler ID. Can be used to remove/destroy the scheduler function.

+

WEAPON.tracking

 +

If true, scheduler will keep tracking. Otherwise, function will return nil and stop tracking.

+

WEAPON.typeName

 +

Type name of the weapon.

+

WEAPON.vec3

 +

Last known 3D position vector of the tracked weapon.

+

WEAPON.verbose

 +

Verbosity level.

+

WEAPON.version

 +

WEAPON class version.

+

WEAPON.weapon

 +

The DCS weapon object.

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from POSITIONABLEDescription

WEAPON:AddCargo(Cargo)

 +

Add cargo.

+

WEAPON:CargoItemCount()

 +

Get cargo item count.

+

WEAPON:ClearCargo()

 +

Clear all cargo.

+

WEAPON:Destroy(GenerateEvent)

 +

Destroys the POSITIONABLE.

+

WEAPON:Flare(FlareColor)

 +

Signal a flare at the position of the POSITIONABLE.

+

WEAPON:FlareGreen()

 +

Signal a green flare at the position of the POSITIONABLE.

+

WEAPON:FlareRed()

 +

Signal a red flare at the position of the POSITIONABLE.

+

WEAPON:FlareWhite()

 +

Signal a white flare at the position of the POSITIONABLE.

+

WEAPON:FlareYellow()

 +

Signal a yellow flare at the position of the POSITIONABLE.

+

WEAPON:GetAltitude()

 +

Returns the altitude above sea level of the POSITIONABLE.

+

WEAPON:GetAoA()

 +

Returns the Angle of Attack of a POSITIONABLE.

+

WEAPON:GetBeacon()

 +

Create a Core.Beacon#BEACON, to allow this POSITIONABLE to broadcast beacon signals.

+

WEAPON:GetBoundingBox()

 +

Get the bounding box of the underlying POSITIONABLE DCS Object.

+

WEAPON:GetBoundingRadius(MinDist)

 +

Get the bounding radius of the underlying POSITIONABLE DCS Object.

+

WEAPON:GetCargo()

 +

Get all contained cargo.

+

WEAPON:GetCargoBayFreeWeight()

 +

Get Cargo Bay Free Weight in kg.

+

WEAPON:GetCargoBayWeightLimit()

 +

Get Cargo Bay Weight Limit in kg.

+

WEAPON:GetClimbAngle()

 +

Returns the climb or descent angle of the POSITIONABLE.

+

WEAPON:GetCoord()

 +

Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+

WEAPON:GetCoordinate()

 +

Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+

WEAPON:GetDCSObject()

 +

Returns the DCS object.

+

WEAPON:GetHeading()

 +

Returns the POSITIONABLE heading in degrees.

+

WEAPON:GetHeight()

 +

Returns the POSITIONABLE height above sea level in meters.

+

WEAPON:GetLaserCode()

 +

Get the last assigned laser code

+

WEAPON:GetMessage(Message, Duration, Name)

 +

Returns a message with the callsign embedded (if there is one).

+

WEAPON:GetMessageText(Message, Name)

 +

Returns the message text with the callsign embedded (if there is one).

+

WEAPON:GetMessageType(Message, MessageType, Name)

 +

Returns a message of a specified type with the callsign embedded (if there is one).

+

WEAPON:GetObjectSize()

 +

Get the object size.

+

WEAPON:GetOffsetCoordinate(x, y, z)

 +

Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.

+

WEAPON:GetOrientation()

 +

Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.

+

WEAPON:GetOrientationX()

 +

Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.

+

WEAPON:GetOrientationY()

 +

Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.

+

WEAPON:GetOrientationZ()

 +

Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.

+

WEAPON:GetPitch()

 +

Returns the pitch angle of a POSITIONABLE.

+

WEAPON:GetPointVec2()

 +

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+

WEAPON:GetPointVec3()

 +

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+

WEAPON:GetPosition()

 +

Returns a pos3 table of the objects current position and orientation in 3D space.

+

WEAPON:GetPositionVec3()

 +

Returns the DCS#Position3 position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.

+

WEAPON:GetRadio()

 +

Create a Sound.Radio#RADIO, to allow radio transmission for this POSITIONABLE.

+

WEAPON:GetRandomVec3(Radius)

 +

Returns a random DCS#Vec3 vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.

+

WEAPON:GetRelativeVelocity(Positionable)

 +

Get relative velocity with respect to another POSITIONABLE.

+

WEAPON:GetRoll()

 +

Returns the roll angle of a unit.

+

WEAPON:GetSize()

 + +

WEAPON:GetSpot()

 +

Get the Spot

+

WEAPON:GetTroopCapacity()

 +

Get the number of infantry soldiers that can be embarked into an aircraft (airplane or helicopter).

+

WEAPON:GetVec2()

 +

Returns the DCS#Vec2 vector indicating the point in 2D of the POSITIONABLE within the mission.

+

WEAPON:GetVec3()

 +

Returns the DCS#Vec3 vector indicating the 3D vector of the POSITIONABLE within the mission.

+

WEAPON:GetVelocity()

 +

Returns the Core.Velocity object from the POSITIONABLE.

+

WEAPON:GetVelocityKMH()

 +

Returns the POSITIONABLE velocity in km/h.

+

WEAPON:GetVelocityKNOTS()

 +

Returns the POSITIONABLE velocity in knots.

+

WEAPON:GetVelocityMPS()

 +

Returns the POSITIONABLE velocity in meters per second.

+

WEAPON:GetVelocityVec3()

 +

Returns the POSITIONABLE velocity Vec3 vector.

+

WEAPON:GetYaw()

 +

Returns the yaw angle of a POSITIONABLE.

+

WEAPON:HasCargo(Cargo)

 +

Returns if carrier has given cargo.

+

WEAPON:InAir()

 +

Returns true if the POSITIONABLE is in the air.

+

WEAPON:IsAboveRunway()

 +

Returns if the Positionable is located above a runway.

+

WEAPON:IsAir()

 +

Returns if the unit is of an air category.

+

WEAPON:IsCargoEmpty()

 +

Is cargo bay empty.

+

WEAPON:IsGround()

 +

Returns if the unit is of an ground category.

+

WEAPON:IsInZone(Zone)

 +

Returns true if the unit is within a Core.Zone.

+

WEAPON:IsLasing()

 +

Check if the POSITIONABLE is lasing a target.

+

WEAPON:IsNotInZone(Zone)

 +

Returns true if the unit is not within a Core.Zone.

+

WEAPON:IsShip()

 +

Returns if the unit is of ship category.

+

WEAPON:IsSubmarine()

 +

Returns if the unit is a submarine.

+

WEAPON:LaseCoordinate(Coordinate, LaserCode, Duration)

 +

Start Lasing a COORDINATE.

+

WEAPON:LaseOff()

 +

Stop Lasing a POSITIONABLE.

+

WEAPON:LaseUnit(Target, LaserCode, Duration)

 +

Start Lasing a POSITIONABLE.

+

WEAPON.LaserCode

 + +

WEAPON:Message(Message, Duration, Name)

 +

Send a message to the players in the Wrapper.Group.

+

WEAPON:MessageToAll(Message, Duration, Name)

 +

Send a message to all coalitions.

+

WEAPON:MessageToBlue(Message, Duration, Name)

 +

Send a message to the blue coalition.

+

WEAPON:MessageToClient(Message, Duration, Client, Name)

 +

Send a message to a client.

+

WEAPON:MessageToCoalition(Message, Duration, MessageCoalition, Name)

 +

Send a message to a coalition.

+

WEAPON:MessageToGroup(Message, Duration, MessageGroup, Name)

 +

Send a message to a Wrapper.Group.

+

WEAPON:MessageToRed(Message, Duration, Name)

 +

Send a message to the red coalition.

+

WEAPON:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)

 +

Send a message to a Core.Set#SET_GROUP.

+

WEAPON:MessageToSetUnit(Message, Duration, MessageSetUnit, Name)

 +

Send a message to a Core.Set#SET_UNIT.

+

WEAPON:MessageToUnit(Message, Duration, MessageUnit, Name)

 +

Send a message to a Wrapper.Unit.

+

WEAPON:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)

 +

Send a message to a coalition.

+

WEAPON:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)

 +

Send a message of a message type to a Wrapper.Group.

+

WEAPON:New(PositionableName)

 +

Create a new POSITIONABLE from a DCSPositionable

+

WEAPON.PositionableName

 + +

WEAPON:RemoveCargo(Cargo)

 +

Remove cargo.

+

WEAPON:SetCargoBayWeightLimit(WeightLimit)

 +

Set Cargo Bay Weight Limit in kg.

+

WEAPON:Smoke(SmokeColor, Range, AddHeight)

 +

Smoke the POSITIONABLE.

+

WEAPON:SmokeBlue()

 +

Smoke the POSITIONABLE Blue.

+

WEAPON:SmokeGreen()

 +

Smoke the POSITIONABLE Green.

+

WEAPON:SmokeOrange()

 +

Smoke the POSITIONABLE Orange.

+

WEAPON:SmokeRed()

 +

Smoke the POSITIONABLE Red.

+

WEAPON:SmokeWhite()

 +

Smoke the POSITIONABLE White.

+

WEAPON.Spot

 + +

WEAPON.__

 + +

WEAPON.coordinate

 +

Coordinate object.

+

WEAPON.pointvec3

 +

Point Vec3 object.

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from IDENTIFIABLEDescription

WEAPON:GetCallsign()

 +

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

+

WEAPON:GetCategory()

 +

Returns object category of the DCS Identifiable.

+

WEAPON:GetCategoryName()

 +

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

+

WEAPON:GetCoalition()

 +

Returns coalition of the Identifiable.

+

WEAPON:GetCoalitionName()

 +

Returns the name of the coalition of the Identifiable.

+

WEAPON:GetCountry()

 +

Returns country of the Identifiable.

+

WEAPON:GetCountryName()

 +

Returns country name of the Identifiable.

+

WEAPON:GetDesc()

 +

Returns Identifiable descriptor.

+

WEAPON:GetName()

 +

Returns DCS Identifiable object name.

+

WEAPON:GetThreatLevel()

 +

Gets the threat level.

+

WEAPON:GetTypeName()

 +

Returns the type name of the DCS Identifiable.

+

WEAPON:HasAttribute(AttributeName)

 +

Check if the Object has the attribute.

+

WEAPON.IdentifiableName

 +

The name of the identifiable.

+

WEAPON:IsAlive()

 +

Returns if the Identifiable is alive.

+

WEAPON:New(IdentifiableName)

 +

Create a new IDENTIFIABLE from a DCSIdentifiable

+
+
+
+ + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from OBJECTDescription

WEAPON:Destroy()

 +

Destroys the OBJECT.

+

WEAPON:GetID()

 +

Returns the unit's unique identifier.

+

WEAPON:New(ObjectName, Test)

 +

Create a new OBJECT from a DCSObject

+

WEAPON.ObjectName

 +

The name of the Object.

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from BASEDescription

WEAPON.ClassID

 +

The ID number of the class.

+

WEAPON.ClassName

 +

The name of the class.

+

WEAPON.ClassNameAndID

 +

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

+

WEAPON:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

WEAPON:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

WEAPON:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

WEAPON:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

WEAPON:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

WEAPON:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

WEAPON:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

WEAPON:E(Arguments)

 +

Log an exception which will be traced always.

+

WEAPON:EventDispatcher()

 +

Returns the event dispatcher

+

WEAPON:EventRemoveAll()

 +

Remove all subscribed events

+

WEAPON:F(Arguments)

 +

Trace a function call.

+

WEAPON:F2(Arguments)

 +

Trace a function call level 2.

+

WEAPON:F3(Arguments)

 +

Trace a function call level 3.

+

WEAPON:GetClassID()

 +

Get the ClassID of the class instance.

+

WEAPON:GetClassName()

 +

Get the ClassName of the class instance.

+

WEAPON:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

WEAPON:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

WEAPON:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

WEAPON:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

WEAPON:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

WEAPON:I(Arguments)

 +

Log an information which will be traced always.

+

WEAPON:Inherit(Child, Parent)

 +

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

+

WEAPON:IsInstanceOf(ClassName)

 +

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

+

WEAPON:IsTrace()

 +

Enquires if tracing is on (for the class).

+

WEAPON:New()

 +

BASE constructor.

+

WEAPON:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

WEAPON:OnEventBDA(EventData)

 +

BDA.

+

WEAPON:OnEventBaseCaptured(EventData)

 +

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

+

WEAPON:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

WEAPON:OnEventCrash(EventData)

 +

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

+

WEAPON:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

WEAPON:OnEventDetailedFailure(EventData)

 +

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

+

WEAPON:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

WEAPON: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.

+

WEAPON:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

WEAPON:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

WEAPON:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

WEAPON:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

WEAPON:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

WEAPON: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.

+

WEAPON:OnEventLandingAfterEjection(EventData)

 +

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

+

WEAPON:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

WEAPON:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

WEAPON:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

WEAPON:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

WEAPON:OnEventMissionEnd(EventData)

 +

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

+

WEAPON:OnEventMissionStart(EventData)

 +

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

+

WEAPON:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

WEAPON:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

WEAPON:OnEventPlayerEnterAircraft(EventData)

 +

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

+

WEAPON:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

WEAPON:OnEventPlayerLeaveUnit(EventData)

 +

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

+

WEAPON:OnEventRefueling(EventData)

 +

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

+

WEAPON:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

WEAPON:OnEventScore(EventData)

 +

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

+

WEAPON:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

WEAPON:OnEventShootingStart(EventData)

 +

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

+

WEAPON:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

WEAPON:OnEventTakeoff(EventData)

 +

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

+

WEAPON:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

WEAPON:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

WEAPON:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

WEAPON.Scheduler

 + +

WEAPON:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

WEAPON:SetState(Object, Key, Value)

 +

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

+

WEAPON:T(Arguments)

 +

Trace a function logic level 1.

+

WEAPON:T2(Arguments)

 +

Trace a function logic level 2.

+

WEAPON:T3(Arguments)

 +

Trace a function logic level 3.

+

WEAPON:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

WEAPON:TraceClass(Class)

 +

Set tracing for a class

+

WEAPON:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

WEAPON:TraceLevel(Level)

 +

Set trace level

+

WEAPON:TraceOff()

 +

Set trace off.

+

WEAPON:TraceOn()

 +

Set trace on.

+

WEAPON:TraceOnOff(TraceOnOff)

 +

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.

+

WEAPON:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

WEAPON._

 + +

WEAPON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

WEAPON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

WEAPON.__

 + +

WEAPON:onEvent(event)

 +

The main event handling function...

+
+
+ +

Type Wrapper.Weapon

+
+
+
+ +
+

Type WEAPON

+
+
+ +

WEAPON class.

+ +
+

Field(s)

+
+
+
+ + #string +WEAPON.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +WEAPON.category + +

Weapon category 0=SHELL, 1=MISSILE, 2=ROCKET, 3=BOMB, 4=TORPEDO (Weapon.Category.X).

+ +
+ +
+
+
+ + #number +WEAPON.categoryMissile + +

Missile category 0=AAM, 1=SAM, 2=BM, 3=ANTI_SHIP, 4=CRUISE, 5=OTHER (Weapon.MissileCategory.X).

+ +
+ +
+
+
+ + #number +WEAPON.coalition + +

Coalition ID.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.coordinate + +

Coordinate object of the weapon. Can be used in other classes.

+ +
+ +
+
+
+ + #number +WEAPON.country + +

Country ID.

+ +
+ +
+
+
+ + DCS#Desc +WEAPON.desc + +

Descriptor table.

+ +
+ +
+
+
+ + #number +WEAPON.distIP + +

Distance in meters for the intercept point estimation.

+ +
+ +
+
+
+ + #number +WEAPON.dtTrack + +

Time step in seconds for tracking scheduler.

+ +
+ +
+
+
+ + #table +WEAPON.impactArg + +

Optional arguments for the impact callback function.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.impactCoord + +

Impact coordinate.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactDestroy + +

If true, destroy weapon before impact. Requires tracking to be started and sufficiently small time step.

+ +
+ +
+
+
+ + #number +WEAPON.impactDestroyDist + +

Distance in meters to the estimated impact point. If smaller, then weapon is destroyed.

+ +
+ +
+
+
+ + #function +WEAPON.impactFunc + +

Callback function for weapon impact.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactMark + +

If true, the impact point is marked on the F10 map. Requires tracking to be started.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactSmoke + +

If true, the impact point is marked by smoke. Requires tracking to be started.

+ +
+ +
+
+
+ + #number +WEAPON.impactSmokeColor + +

Colour of impact point smoke.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.impactVec3 + +

Impact 3D vector.

+ +
+ +
+
+
+ + DCS#Unit +WEAPON.launcher + +

Launcher DCS unit.

+ +
+ +
+
+
+ + #string +WEAPON.launcherName + +

Name of launcher unit.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.launcherUnit + +

Launcher Unit.

+ +
+ +
+
+
+ + #string +WEAPON.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #string +WEAPON.name + +

Name of the weapon object.

+ +
+ +
+
+
+ + DCS#Position3 +WEAPON.pos3 + +

Last known 3D position and direction vector of the tracked weapon.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.target + +

Last known target.

+ +
+ +
+
+
+ + #table +WEAPON.trackArg + +

Optional arguments for the track callback function.

+ +
+ +
+
+
+ + #function +WEAPON.trackFunc + +

Callback function when weapon is tracked and alive.

+ +
+ +
+
+
+ + #number +WEAPON.trackScheduleID + +

Tracking scheduler ID. Can be used to remove/destroy the scheduler function.

+ +
+ +
+
+
+ + #boolean +WEAPON.tracking + +

If true, scheduler will keep tracking. Otherwise, function will return nil and stop tracking.

+ +
+ +
+
+
+ + #string +WEAPON.typeName + +

Type name of the weapon.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.vec3 + +

Last known 3D position vector of the tracked weapon.

+ +
+ +
+
+
+ + #number +WEAPON.verbose + +

Verbosity level.

+ +
+ +
+
+
+ + #string +WEAPON.version + +

WEAPON class version.

+ +
+ +
+
+
+ + DCS#Weapon +WEAPON.weapon + +

The DCS weapon object.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

WEAPON:Destroy(Delay)

+
+ +

Destroy the weapon object.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

Delay before destroy in seconds.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:GetCoalition()

+
+ +

Get coalition.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#number:

+
+
+ +

Coalition ID.

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

WEAPON:GetCountry()

+
+ +

Get country.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#number:

+
+
+ +

Country ID.

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

WEAPON:GetDCSObject()

+
+ +

Get DCS object.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

DCS#Weapon:

+
+
+ +

The weapon object.

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

WEAPON:GetImpactCoordinate()

+
+ +

Get the impact coordinate.

+ + +

Note that this might not exist if the weapon has not impacted yet!

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

Impact coordinate (if any).

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

WEAPON:GetImpactVec3()

+
+ +

Get the impact position vector.

+ + +

Note that this might not exist if the weapon has not impacted yet!

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

DCS#Vec3:

+
+
+ +

Impact position vector (if any).

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

WEAPON:GetLauncher()

+
+ +

Get the unit that launched the weapon.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

Wrapper.Unit#UNIT:

+
+
+ +

Laucher unit.

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

WEAPON:GetSpeed(ConversionFunction)

+
+ +

Get speed of weapon.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #function + ConversionFunction +

+
+
+ +

(Optional) Conversion function from m/s to desired unit, e.g. UTILS.MpsToKmph.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Speed in meters per second.

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

WEAPON:GetTarget()

+
+ +

Get the target, which the weapon is guiding to.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

Wrapper.Object#OBJECT:

+
+
+ +

The target object, which can be a UNIT or STATIC object.

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

WEAPON:GetTargetDistance(ConversionFunction)

+
+ +

Get the distance to the current target the weapon is guiding to.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #function + ConversionFunction +

+
+
+ +

(Optional) Conversion function from meters to desired unit, e.g. UTILS.MpsToKmph.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Distance from weapon to target in meters.

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

WEAPON:GetTargetName()

+
+ +

Get name the current target the weapon is guiding to.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#string:

+
+
+ +

Name of the target or "None" if no target.

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

WEAPON:GetTypeName()

+
+ +

Get type name.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#string:

+
+
+ +

The type name.

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

WEAPON:GetVec2()

+
+ +

Get the current 2D position vector.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

DCS#Vec2:

+
+
+ +

Current position vector in 2D.

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

WEAPON:GetVec3()

+
+ +

Get the current 3D position vector.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

DCS#Vec3:

+
+
+ +

Current position vector in 3D.

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

WEAPON:GetVelocityVec3()

+
+ +

Get velocity vector of weapon.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

DCS#Vec3:

+
+
+ +

Velocity vector with x, y and z components in meters/second.

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

WEAPON:InAir()

+
+ +

Check if weapon is in the air.

+ + +

Obviously not really useful for torpedos. Well, then again, this is DCS...

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, weapon is in the air and false if not. Returns nil if weapon object itself is nil.

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

WEAPON:IsBomb()

+
+ +

Check if weapon is a bomb.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, is a bomb.

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

WEAPON:IsExist()

+
+ +

Check if weapon object (still) exists.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, the weapon object still exists and false otherwise. Returns nil if weapon object itself is nil.

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

WEAPON:IsMissile()

+
+ +

Check if weapon is a missile.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, is a missile.

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

WEAPON:IsRocket()

+
+ +

Check if weapon is a rocket.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, is a missile.

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

WEAPON:IsShell()

+
+ +

Check if weapon is a shell.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, is a shell.

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

WEAPON:IsTorpedo()

+
+ +

Check if weapon is a torpedo.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, is a torpedo.

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

WEAPON:New(WeaponObject)

+
+ +

Create a new WEAPON object from the DCS weapon object.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ DCS#Weapon + WeaponObject +

+
+
+ +

The DCS weapon object.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:SetDistanceInterceptPoint(Distance)

+
+ +

Set distance of intercept point for estimated impact point.

+ + +

If the weapon cannot be tracked any more, the intercept point from its last known position and direction is used to get +a better approximation of the impact point. Can be useful when using longer time steps in the tracking and still achieve +a good result on the impact point. +It uses the DCS function getIP.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + Distance +

+
+
+ +

Distance in meters. Default is 50 m. Set to 0 to deactivate.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:SetFuncImpact(FuncImpact, ...)

+
+ +

Set callback function when weapon impacted or was destroyed otherwise, i.e. cannot be tracked any more.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameters:

+
+
+

+ #function + FuncImpact +

+
+
+ +

Function called once the weapon impacted.

+ +
+
+
+
+

+ ... +

+
+
+ +

Optional function arguments.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

+ + +
+
+

Usage:

+ 
-- Function called on impact.
+local function OnImpact(Weapon)
+  Weapon:GetImpactCoordinate():MarkToAll("Impact Coordinate of weapon")
+end
+
+-- Set which function to call.
+myweapon:SetFuncImpact(OnImpact)
+
+-- Start tracking.
+myweapon:Track()
+
+ +
+ +
+
+ +
+ +
+

WEAPON:SetFuncTrack(FuncTrack, ...)

+
+ +

Set callback function when weapon is tracked and still alive.

+ + +

The first argument will be the WEAPON object. +Note that this can be called many times per second. So be careful for performance reasons.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameters:

+
+
+

+ #function + FuncTrack +

+
+
+ +

Function called during tracking.

+ +
+
+
+
+

+ ... +

+
+
+ +

Optional function arguments.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:SetMarkImpact(Switch)

+
+ +

Mark impact point on the F10 map.

+ + +

This requires that the tracking has been started.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #boolean + Switch +

+
+
+ +

If true or nil, impact is marked.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:SetSmokeImpact(Switch, SmokeColor)

+
+ +

Put smoke on impact point.

+ + +

This requires that the tracking has been started.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameters:

+
+
+

+ #boolean + Switch +

+
+
+ +

If true or nil, impact is smoked.

+ +
+
+
+
+

+ #number + SmokeColor +

+
+
+ +

Color of smoke. Default is SMOKECOLOR.Red.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:SetTimeStepTrack(TimeStep)

+
+ +

Set track position time step.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + TimeStep +

+
+
+ +

Time step in seconds when the position is updated. Default 0.01 sec ==> 100 evaluations per second.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:SetVerbosity(VerbosityLevel)

+
+ +

Set verbosity level.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + VerbosityLevel +

+
+
+ +

Level of output (higher=more). Default 0.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:StartTrack(Delay)

+
+ +

Start tracking the weapon until it impacts or is destroyed otherwise.

+ + +

The position of the weapon is monitored in small time steps. Once the position cannot be determined anymore, the monitoring is stopped and the last known position is +the (approximate) impact point. Of course, the smaller the time step, the better the position can be determined. However, this can hit the performance as many +calculations per second need to be carried out.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

Delay in seconds before the tracking starts. Default 0.001 sec.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:StopTrack(Delay)

+
+ +

Stop tracking the weapon by removing the scheduler function.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + Delay +

+
+
+ +

(Optional) Delay in seconds before the tracking is stopped.

+ +
+
+

Return value:

+
+
+

#WEAPON:

+
+
+ +

self

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

WEAPON:_GetIP(Distance)

+
+ +

Compute estimated intercept/impact point (IP) based on last known position and direction.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ #number + Distance +

+
+
+ +

Distance in meters. Default 50 m.

+ +
+
+

Return value:

+
+
+

DCS#Vec3:

+
+
+ +

Estimated intercept/impact point. Can also return nil, if no IP can be determined.

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

WEAPON:_TrackWeapon(time)

+
+ +

Track weapon until impact.

+ +
+
+

Defined in:

+
+

WEAPON

+
+

Parameter:

+
+
+

+ DCS#Time + time +

+
+
+ +

Time in seconds.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Time when called next or nil if not called again.

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +WEAPON.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +WEAPON.category + +

Weapon category 0=SHELL, 1=MISSILE, 2=ROCKET, 3=BOMB, 4=TORPEDO (Weapon.Category.X).

+ +
+ +
+
+
+ + #number +WEAPON.categoryMissile + +

Missile category 0=AAM, 1=SAM, 2=BM, 3=ANTI_SHIP, 4=CRUISE, 5=OTHER (Weapon.MissileCategory.X).

+ +
+ +
+
+
+ + #number +WEAPON.coalition + +

Coalition ID.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.coordinate + +

Coordinate object of the weapon. Can be used in other classes.

+ +
+ +
+
+
+ + #number +WEAPON.country + +

Country ID.

+ +
+ +
+
+
+ + DCS#Desc +WEAPON.desc + +

Descriptor table.

+ +
+ +
+
+
+ + #number +WEAPON.distIP + +

Distance in meters for the intercept point estimation.

+ +
+ +
+
+
+ + #number +WEAPON.dtTrack + +

Time step in seconds for tracking scheduler.

+ +
+ +
+
+
+ + #table +WEAPON.impactArg + +

Optional arguments for the impact callback function.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.impactCoord + +

Impact coordinate.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactDestroy + +

If true, destroy weapon before impact. Requires tracking to be started and sufficiently small time step.

+ +
+ +
+
+
+ + #number +WEAPON.impactDestroyDist + +

Distance in meters to the estimated impact point. If smaller, then weapon is destroyed.

+ +
+ +
+
+
+ + #function +WEAPON.impactFunc + +

Callback function for weapon impact.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactMark + +

If true, the impact point is marked on the F10 map. Requires tracking to be started.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactSmoke + +

If true, the impact point is marked by smoke. Requires tracking to be started.

+ +
+ +
+
+
+ + #number +WEAPON.impactSmokeColor + +

Colour of impact point smoke.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.impactVec3 + +

Impact 3D vector.

+ +
+ +
+
+
+ + DCS#Unit +WEAPON.launcher + +

Launcher DCS unit.

+ +
+ +
+
+
+ + #string +WEAPON.launcherName + +

Name of launcher unit.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.launcherUnit + +

Launcher Unit.

+ +
+ +
+
+
+ + #string +WEAPON.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #string +WEAPON.name + +

Name of the weapon object.

+ +
+ +
+
+
+ + DCS#Position3 +WEAPON.pos3 + +

Last known 3D position and direction vector of the tracked weapon.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.target + +

Last known target.

+ +
+ +
+
+
+ + #table +WEAPON.trackArg + +

Optional arguments for the track callback function.

+ +
+ +
+
+
+ + #function +WEAPON.trackFunc + +

Callback function when weapon is tracked and alive.

+ +
+ +
+
+
+ + #number +WEAPON.trackScheduleID + +

Tracking scheduler ID. Can be used to remove/destroy the scheduler function.

+ +
+ +
+
+
+ + #boolean +WEAPON.tracking + +

If true, scheduler will keep tracking. Otherwise, function will return nil and stop tracking.

+ +
+ +
+
+
+ + #string +WEAPON.typeName + +

Type name of the weapon.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.vec3 + +

Last known 3D position vector of the tracked weapon.

+ +
+ +
+
+
+ + #number +WEAPON.verbose + +

Verbosity level.

+ +
+ +
+
+
+ + #string +WEAPON.version + +

WEAPON class version.

+ +
+ +
+
+
+ + DCS#Weapon +WEAPON.weapon + +

The DCS weapon object.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

WEAPON:AddCargo(Cargo)

+
+ +

Add cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Cargo#CARGO + Cargo +

+
+
+

+
+
+

Return value:

+
+
+

#POSITIONABLE:

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

WEAPON:CargoItemCount()

+
+ +

Get cargo item count.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Cargo#CARGO:

+
+
+ +

Cargo

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

WEAPON:ClearCargo()

+
+ +

Clear all cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:Destroy(GenerateEvent)

+
+ +

Destroys the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #boolean + GenerateEvent +

+
+
+ +

(Optional) If true, generates a crash or dead event for the unit. If false, no event generated. If nil, a remove event is generated.

+ +
+
+

Return value:

+
+
+

#nil:

+
+
+ +

The DCS Unit is not existing or alive.

+ +
+
+

Usages:

+
    + 
  • 
+Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
+Helicopter = UNIT:FindByName( "Helicopter" )
+Helicopter:Destroy( true )
+
    • + 
  • -- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
+Tanks = UNIT:FindByName( "Tanks" )
+Tanks:Destroy( true )
+
    • + 
  • -- Ship unit example: destroy the Ship silently.
+Ship = STATIC:FindByName( "Ship" )
+Ship:Destroy()
+
    • + 
  • -- Destroy without event generation example.
+Ship = STATIC:FindByName( "Boat" )
+Ship:Destroy( false ) -- Don't generate an event upon destruction.
+
    • +
+ +
+ +
+
+ +
+ +
+

WEAPON:Flare(FlareColor)

+
+ +

Signal a flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Utilities.Utils#FLARECOLOR + FlareColor +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:FlareGreen()

+
+ +

Signal a green flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:FlareRed()

+
+ +

Signal a red flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:FlareWhite()

+
+ +

Signal a white flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:FlareYellow()

+
+ +

Signal a yellow flare at the position of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:GetAltitude()

+
+ +

Returns the altitude above sea level of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Distance:

+
+
+ +

The altitude of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetAoA()

+
+ +

Returns the Angle of Attack of a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Angle of attack in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetBeacon()

+
+ +

Create a Core.Beacon#BEACON, to allow this POSITIONABLE to broadcast beacon signals.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Beacon#BEACON:

+
+
+ +

Beacon

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

WEAPON:GetBoundingBox()

+
+ +

Get the bounding box of the underlying POSITIONABLE DCS Object.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Box3:

+
+
+ +

The bounding box of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetBoundingRadius(MinDist)

+
+ +

Get the bounding radius of the underlying POSITIONABLE DCS Object.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #number + MinDist +

+
+
+ +

(Optional) If bounding box is smaller than this value, MinDist is returned.

+ +
+
+

Return values:

+
+
+

DCS#Distance:

+
+
+ +

The bounding radius of the POSITIONABLE

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetCargo()

+
+ +

Get all contained cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#POSITIONABLE:

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

WEAPON:GetCargoBayFreeWeight()

+
+ +

Get Cargo Bay Free Weight in kg.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

CargoBayFreeWeight

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

WEAPON:GetCargoBayWeightLimit()

+
+ +

Get Cargo Bay Weight Limit in kg.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

Max cargo weight in kg.

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

WEAPON:GetClimbAngle()

+
+ +

Returns the climb or descent angle of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Climb or descent angle in degrees. Or 0 if velocity vector norm is zero.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetCoord()

+
+ +

Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+ + +

This function works similar to POSITIONABLE.GetCoordinate(), however, this function caches, updates and re-uses the same COORDINATE object stored +within the POSITIONABLE. This has higher performance, but comes with all considerations associated with the possible referencing to the same COORDINATE object. +This should only be used when performance is critical and there is sufficient awareness of the possible pitfalls. However, in most instances, GetCoordinate() is +preferred as it will return a fresh new COORDINATE and thus avoid potentially unexpected issues.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

A reference to the COORDINATE object of the POSITIONABLE.

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

WEAPON:GetCoordinate()

+
+ +

Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

A new COORDINATE object of the POSITIONABLE.

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

WEAPON:GetDCSObject()

+
+ +

Returns the DCS object.

+ + +

Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

DCS#Object:

+
+
+ +

The DCS object.

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

WEAPON:GetHeading()

+
+ +

Returns the POSITIONABLE heading in degrees.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

The POSITIONABLE heading in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetHeight()

+
+ +

Returns the POSITIONABLE height above sea level in meters.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

DCS#Vec3:

+
+
+ +

Height of the positionable in meters (or nil, if the object does not exist).

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

WEAPON:GetLaserCode()

+
+ +

Get the last assigned laser code

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The laser code

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

WEAPON:GetMessage(Message, Duration, Name)

+
+ +

Returns a message with the callsign embedded (if there is one).

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

+ +
+
+

Return value:

+
+
+

Core.Message#MESSAGE:

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

WEAPON:GetMessageText(Message, Name)

+
+ +

Returns the message text with the callsign embedded (if there is one).

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

+ +
+
+

Return values:

+
+
+

#string:

+
+
+ +

The message text.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetMessageType(Message, MessageType, Name)

+
+ +

Returns a message of a specified type with the callsign embedded (if there is one).

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ Core.Message#MESSAGE + MessageType +

+
+
+ +

MessageType The message type.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

+ +
+
+

Return value:

+
+
+

Core.Message#MESSAGE:

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

WEAPON:GetObjectSize()

+
+ +

Get the object size.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Distance:

+
+
+ +

Max size of object in x, z or 0 if bounding box could not be obtained.

+ +
+
+

DCS#Distance:

+
+
+ +

Length x or 0 if bounding box could not be obtained.

+ +
+
+

DCS#Distance:

+
+
+ +

Height y or 0 if bounding box could not be obtained.

+ +
+
+

DCS#Distance:

+
+
+ +

Width z or 0 if bounding box could not be obtained.

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

WEAPON:GetOffsetCoordinate(x, y, z)

+
+ +

Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #number + x +

+
+
+ +

Offset in the direction "the nose" of the unit is pointing in meters. Default 0 m.

+ +
+
+
+
+

+ #number + y +

+
+
+ +

Offset "above" the unit in meters. Default 0 m.

+ +
+
+
+
+

+ #number + z +

+
+
+ +

Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z<0 port. Default 0 m.

+ +
+
+

Return value:

+
+
+

Core.Point#COORDINATE:

+
+
+ +

The COORDINATE of the offset with respect to the orientation of the POSITIONABLE.

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

WEAPON:GetOrientation()

+
+ +

Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.

+ + +

X, Y, Z values are unit vectors defining the objects orientation. + X is the orientation parallel to the movement of the object, Z perpendicular and Y vertical orientation.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

X orientation, i.e. parallel to the direction of movement.

+ +
+
+

DCS#Vec3:

+
+
+ +

Y orientation, i.e. vertical.

+ +
+
+

DCS#Vec3:

+
+
+ +

Z orientation, i.e. perpendicular to the direction of movement.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetOrientationX()

+
+ +

Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.

+ + +

along the direction of movement.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

X orientation, i.e. parallel to the direction of movement.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetOrientationY()

+
+ +

Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.

+ + +

vertical orientation.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

Y orientation, i.e. vertical.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetOrientationZ()

+
+ +

Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.

+ + +

perpendicular to direction of movement.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

Z orientation, i.e. perpendicular to movement.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetPitch()

+
+ +

Returns the pitch angle of a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Pitch angle in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetPointVec2()

+
+ +

Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

Core.Point#POINT_VEC2:

+
+
+ +

The 2D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetPointVec3()

+
+ +

Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

Core.Point#POINT_VEC3:

+
+
+ +

The 3D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetPosition()

+
+ +

Returns a pos3 table of the objects current position and orientation in 3D space.

+ + +

X, Y, Z values are unit vectors defining the objects orientation. +Coordinates are dependent on the position of the maps origin.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

DCS#Position3:

+
+
+ +

Table consisting of the point and orientation tables.

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

WEAPON:GetPositionVec3()

+
+ +

Returns the DCS#Position3 position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Position:

+
+
+ +

The 3D position vectors of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetRadio()

+
+ +

Create a Sound.Radio#RADIO, to allow radio transmission for this POSITIONABLE.

+ + +

Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Sound.Radio#RADIO:

+
+
+ +

Radio

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

WEAPON:GetRandomVec3(Radius)

+
+ +

Returns a random DCS#Vec3 vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #number + Radius +

+
+
+

+
+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The 3D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

+ +
+
+

Usage:

+ 
-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP
+ +
+ +
+
+ +
+ +
+

WEAPON:GetRelativeVelocity(Positionable)

+
+ +

Get relative velocity with respect to another POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #POSITIONABLE + Positionable +

+
+
+ +

Other POSITIONABLE.

+ +
+
+

Return value:

+
+
+

#number:

+
+
+ +

Relative velocity in m/s.

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

WEAPON:GetRoll()

+
+ +

Returns the roll angle of a unit.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Pitch angle in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetSize()

+
+ + + +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:GetSpot()

+
+ +

Get the Spot

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

Core.Spot#SPOT:

+
+
+ +

The Spot

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

WEAPON:GetTroopCapacity()

+
+ +

Get the number of infantry soldiers that can be embarked into an aircraft (airplane or helicopter).

+ + +

Returns nil for ground or ship units.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

Descent number of soldiers that fit into the unit. Returns #nil for ground and ship units.

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

WEAPON:GetVec2()

+
+ +

Returns the DCS#Vec2 vector indicating the point in 2D of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec2:

+
+
+ +

The 2D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetVec3()

+
+ +

Returns the DCS#Vec3 vector indicating the 3D vector of the POSITIONABLE within the mission.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The 3D point vector of the POSITIONABLE.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetVelocity()

+
+ +

Returns the Core.Velocity object from the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

Core.Velocity#VELOCITY:

+
+
+ +

Velocity The Velocity object.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetVelocityKMH()

+
+ +

Returns the POSITIONABLE velocity in km/h.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The velocity in km/h.

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

WEAPON:GetVelocityKNOTS()

+
+ +

Returns the POSITIONABLE velocity in knots.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The velocity in knots.

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

WEAPON:GetVelocityMPS()

+
+ +

Returns the POSITIONABLE velocity in meters per second.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The velocity in meters per second.

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

WEAPON:GetVelocityVec3()

+
+ +

Returns the POSITIONABLE velocity Vec3 vector.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

DCS#Vec3:

+
+
+ +

The velocity Vec3 vector

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:GetYaw()

+
+ +

Returns the yaw angle of a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Yaw angle in degrees.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:HasCargo(Cargo)

+
+ +

Returns if carrier has given cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Cargo +

+
+
+

+
+
+

Return value:

+
+
+

Core.Cargo#CARGO:

+
+
+ +

Cargo

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

WEAPON:InAir()

+
+ +

Returns true if the POSITIONABLE is in the air.

+ + +

Polymorphic, is overridden in GROUP and UNIT.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if in the air.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:IsAboveRunway()

+
+ +

Returns if the Positionable is located above a runway.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if Positionable is above a runway.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:IsAir()

+
+ +

Returns if the unit is of an air category.

+ + +

If the unit is a helicopter or a plane, then this method will return true, otherwise false.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

Air category evaluation result.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:IsCargoEmpty()

+
+ +

Is cargo bay empty.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:IsGround()

+
+ +

Returns if the unit is of an ground category.

+ + +

If the unit is a ground vehicle or infantry, this method will return true, otherwise false.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

Ground category evaluation result.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:IsInZone(Zone)

+
+ +

Returns true if the unit is within a Core.Zone.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Zone#ZONE_BASE + Zone +

+
+
+ +

The zone to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

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

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

WEAPON:IsLasing()

+
+ +

Check if the POSITIONABLE is lasing a target.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

true if it is lasing a target

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

WEAPON:IsNotInZone(Zone)

+
+ +

Returns true if the unit is not within a Core.Zone.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Zone#ZONE_BASE + Zone +

+
+
+ +

The zone to test.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

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

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

WEAPON:IsShip()

+
+ +

Returns if the unit is of ship category.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

Ship category evaluation result.

+ +
+
+

#nil:

+
+
+ +

The POSITIONABLE is not existing or alive.

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

WEAPON:IsSubmarine()

+
+ +

Returns if the unit is a submarine.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Submarines attributes result.

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

WEAPON:LaseCoordinate(Coordinate, LaserCode, Duration)

+
+ +

Start Lasing a COORDINATE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ Core.Point#COORDINATE + Coordinate +

+
+
+ +

The coordinate where the lase is pointing at.

+ +
+
+
+
+

+ #number + LaserCode +

+
+
+ +

Laser code or random number in [1000, 9999].

+ +
+
+
+
+

+ #number + Duration +

+
+
+ +

Duration of lasing in seconds.

+ +
+
+

Return value:

+
+
+

Core.Spot#SPOT:

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

WEAPON:LaseOff()

+
+ +

Stop Lasing a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Return value:

+
+
+

#POSITIONABLE:

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

WEAPON:LaseUnit(Target, LaserCode, Duration)

+
+ +

Start Lasing a POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #POSITIONABLE + Target +

+
+
+ +

The target to lase.

+ +
+
+
+
+

+ #number + LaserCode +

+
+
+ +

Laser code or random number in [1000, 9999].

+ +
+
+
+
+

+ #number + Duration +

+
+
+ +

Duration of lasing in seconds.

+ +
+
+

Return value:

+
+
+

Core.Spot#SPOT:

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

WEAPON:Message(Message, Duration, Name)

+
+ +

Send a message to the players in the Wrapper.Group.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToAll(Message, Duration, Name)

+
+ +

Send a message to all coalitions.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToBlue(Message, Duration, Name)

+
+ +

Send a message to the blue coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToClient(Message, Duration, Client, Name)

+
+ +

Send a message to a client.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Wrapper.Client#CLIENT + Client +

+
+
+ +

The client object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToCoalition(Message, Duration, MessageCoalition, Name)

+
+ +

Send a message to a coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ DCS#coalition + MessageCoalition +

+
+
+ +

The Coalition receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToGroup(Message, Duration, MessageGroup, Name)

+
+ +

Send a message to a Wrapper.Group.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Wrapper.Group#GROUP + MessageGroup +

+
+
+ +

The GROUP object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToRed(Message, Duration, Name)

+
+ +

Send a message to the red coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)

+
+ +

Send a message to a Core.Set#SET_GROUP.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Core.Set#SET_GROUP + MessageSetGroup +

+
+
+ +

The SET_GROUP collection receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageToSetUnit(Message, Duration, MessageSetUnit, Name)

+
+ +

Send a message to a Core.Set#SET_UNIT.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Core.Set#SET_UNIT + MessageSetUnit +

+
+
+ +

The SET_UNIT collection receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

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

WEAPON:MessageToUnit(Message, Duration, MessageUnit, Name)

+
+ +

Send a message to a Wrapper.Unit.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ DCS#Duration + Duration +

+
+
+ +

The duration of the message.

+ +
+
+
+
+

+ Wrapper.Unit#UNIT + MessageUnit +

+
+
+ +

The UNIT object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.

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

WEAPON:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)

+
+ +

Send a message to a coalition.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ Core.Message#MESSAGE.Type + MessageType +

+
+
+ +

The message type that determines the duration.

+ +
+
+
+
+

+ DCS#coalition + MessageCoalition +

+
+
+ +

The Coalition receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.

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

WEAPON:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)

+
+ +

Send a message of a message type to a Wrapper.Group.

+ + +

The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ #string + Message +

+
+
+ +

The message text

+ +
+
+
+
+

+ Core.Message#MESSAGE.Type + MessageType +

+
+
+ +

The message type that determines the duration.

+ +
+
+
+
+

+ Wrapper.Group#GROUP + MessageGroup +

+
+
+ +

The GROUP object receiving the message.

+ +
+
+
+
+

+ #string + Name +

+
+
+ +

(Optional) The Name of the sender. If not provided, the Name is the type of the POSITIONABLE.

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

WEAPON:New(PositionableName)

+
+ +

Create a new POSITIONABLE from a DCSPositionable

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #string + PositionableName +

+
+
+ +

The POSITIONABLE name

+ +
+
+

Return value:

+
+
+

#POSITIONABLE:

+
+
+ +

self

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

WEAPON:RemoveCargo(Cargo)

+
+ +

Remove cargo.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ Core.Cargo#CARGO + Cargo +

+
+
+

+
+
+

Return value:

+
+
+

#POSITIONABLE:

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

WEAPON:SetCargoBayWeightLimit(WeightLimit)

+
+ +

Set Cargo Bay Weight Limit in kg.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameter:

+
+
+

+ #number + WeightLimit +

+
+
+ +

(Optional) Weight limit in kg. If not given, the value is taken from the descriptors or hard coded.

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

WEAPON:Smoke(SmokeColor, Range, AddHeight)

+
+ +

Smoke the POSITIONABLE.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+

Parameters:

+
+
+

+ Utilities.Utils#SMOKECOLOR + SmokeColor +

+
+
+ +

The smoke color.

+ +
+
+
+
+

+ #number + Range +

+
+
+ +

The range in meters to randomize the smoking around the POSITIONABLE.

+ +
+
+
+
+

+ #number + AddHeight +

+
+
+ +

The height in meters to add to the altitude of the POSITIONABLE.

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

WEAPON:SmokeBlue()

+
+ +

Smoke the POSITIONABLE Blue.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:SmokeGreen()

+
+ +

Smoke the POSITIONABLE Green.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:SmokeOrange()

+
+ +

Smoke the POSITIONABLE Orange.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:SmokeRed()

+
+ +

Smoke the POSITIONABLE Red.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+ +
+

WEAPON:SmokeWhite()

+
+ +

Smoke the POSITIONABLE White.

+ +
+
+

Defined in:

+
+

Wrapper.Positionable#POSITIONABLE

+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +WEAPON.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +WEAPON.category + +

Weapon category 0=SHELL, 1=MISSILE, 2=ROCKET, 3=BOMB, 4=TORPEDO (Weapon.Category.X).

+ +
+ +
+
+
+ + #number +WEAPON.categoryMissile + +

Missile category 0=AAM, 1=SAM, 2=BM, 3=ANTI_SHIP, 4=CRUISE, 5=OTHER (Weapon.MissileCategory.X).

+ +
+ +
+
+
+ + #number +WEAPON.coalition + +

Coalition ID.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.coordinate + +

Coordinate object of the weapon. Can be used in other classes.

+ +
+ +
+
+
+ + #number +WEAPON.country + +

Country ID.

+ +
+ +
+
+
+ + DCS#Desc +WEAPON.desc + +

Descriptor table.

+ +
+ +
+
+
+ + #number +WEAPON.distIP + +

Distance in meters for the intercept point estimation.

+ +
+ +
+
+
+ + #number +WEAPON.dtTrack + +

Time step in seconds for tracking scheduler.

+ +
+ +
+
+
+ + #table +WEAPON.impactArg + +

Optional arguments for the impact callback function.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.impactCoord + +

Impact coordinate.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactDestroy + +

If true, destroy weapon before impact. Requires tracking to be started and sufficiently small time step.

+ +
+ +
+
+
+ + #number +WEAPON.impactDestroyDist + +

Distance in meters to the estimated impact point. If smaller, then weapon is destroyed.

+ +
+ +
+
+
+ + #function +WEAPON.impactFunc + +

Callback function for weapon impact.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactMark + +

If true, the impact point is marked on the F10 map. Requires tracking to be started.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactSmoke + +

If true, the impact point is marked by smoke. Requires tracking to be started.

+ +
+ +
+
+
+ + #number +WEAPON.impactSmokeColor + +

Colour of impact point smoke.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.impactVec3 + +

Impact 3D vector.

+ +
+ +
+
+
+ + DCS#Unit +WEAPON.launcher + +

Launcher DCS unit.

+ +
+ +
+
+
+ + #string +WEAPON.launcherName + +

Name of launcher unit.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.launcherUnit + +

Launcher Unit.

+ +
+ +
+
+
+ + #string +WEAPON.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #string +WEAPON.name + +

Name of the weapon object.

+ +
+ +
+
+
+ + DCS#Position3 +WEAPON.pos3 + +

Last known 3D position and direction vector of the tracked weapon.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.target + +

Last known target.

+ +
+ +
+
+
+ + #table +WEAPON.trackArg + +

Optional arguments for the track callback function.

+ +
+ +
+
+
+ + #function +WEAPON.trackFunc + +

Callback function when weapon is tracked and alive.

+ +
+ +
+
+
+ + #number +WEAPON.trackScheduleID + +

Tracking scheduler ID. Can be used to remove/destroy the scheduler function.

+ +
+ +
+
+
+ + #boolean +WEAPON.tracking + +

If true, scheduler will keep tracking. Otherwise, function will return nil and stop tracking.

+ +
+ +
+
+
+ + #string +WEAPON.typeName + +

Type name of the weapon.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.vec3 + +

Last known 3D position vector of the tracked weapon.

+ +
+ +
+
+
+ + #number +WEAPON.verbose + +

Verbosity level.

+ +
+ +
+
+
+ + #string +WEAPON.version + +

WEAPON class version.

+ +
+ +
+
+
+ + DCS#Weapon +WEAPON.weapon + +

The DCS weapon object.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

WEAPON:GetCallsign()

+
+ +

Gets the CallSign of the IDENTIFIABLE, which is a blank by default.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The CallSign of the IDENTIFIABLE.

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

WEAPON:GetCategory()

+
+ +

Returns object category of the DCS Identifiable.

+ + +

One of

+ +
    +
  • Object.Category.UNIT = 1
    • +
  • Object.Category.WEAPON = 2
    • +
  • Object.Category.STATIC = 3
    • +
  • Object.Category.BASE = 4
    • +
  • Object.Category.SCENERY = 5
    • +
  • Object.Category.Cargo = 6 +
    • +
+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

DCS#Object.Category:

+
+
+ +

The category ID, i.e. a number.

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

WEAPON:GetCategoryName()

+
+ +

Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The DCS Identifiable Category Name

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

WEAPON:GetCoalition()

+
+ +

Returns coalition of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

DCS#coalition.side:

+
+
+ +

The side of the coalition or #nil The DCS Identifiable is not existing or alive.

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

WEAPON:GetCoalitionName()

+
+ +

Returns the name of the coalition of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

#string:

+
+
+ +

The name of the coalition.

+ +
+
+

#nil:

+
+
+ +

The DCS Identifiable is not existing or alive.

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

WEAPON:GetCountry()

+
+ +

Returns country of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

DCS#country.id:

+
+
+ +

The country identifier or #nil The DCS Identifiable is not existing or alive.

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

WEAPON:GetCountryName()

+
+ +

Returns country name of the Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

Name of the country.

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

WEAPON:GetDesc()

+
+ +

Returns Identifiable descriptor.

+ + +

Descriptor type depends on Identifiable category.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

DCS#Object.Desc:

+
+
+ +

The Identifiable descriptor or #nil The DCS Identifiable is not existing or alive.

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

WEAPON:GetName()

+
+ +

Returns DCS Identifiable object name.

+ + +

The function provides access to non-activated objects too.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The name of the DCS Identifiable or #nil.

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

WEAPON:GetThreatLevel()

+
+ +

Gets the threat level.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return values:

+
+
+

#number:

+
+
+ +

Threat level.

+ +
+
+

#string:

+
+
+ +

Type.

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

WEAPON:GetTypeName()

+
+ +

Returns the type name of the DCS Identifiable.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The type name of the DCS Identifiable.

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

WEAPON:HasAttribute(AttributeName)

+
+ +

Check if the Object has the attribute.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Parameter:

+
+
+

+ #string + AttributeName +

+
+
+ +

The attribute name.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

true if the attribute exists or #nil The DCS Identifiable is not existing or alive.

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

WEAPON:IsAlive()

+
+ +

Returns if the Identifiable is alive.

+ + +

If the Identifiable is not alive, nil is returned.
+If the Identifiable is alive, true is returned.

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

true if Identifiable is alive or #nil if the Identifiable is not existing or is not alive.

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

WEAPON:New(IdentifiableName)

+
+ +

Create a new IDENTIFIABLE from a DCSIdentifiable

+ +
+
+

Defined in:

+
+

Wrapper.Identifiable#IDENTIFIABLE

+
+

Parameter:

+
+
+

+ #string + IdentifiableName +

+
+
+ +

The DCS Identifiable name

+ +
+
+

Return value:

+
+
+

#IDENTIFIABLE:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +WEAPON.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +WEAPON.category + +

Weapon category 0=SHELL, 1=MISSILE, 2=ROCKET, 3=BOMB, 4=TORPEDO (Weapon.Category.X).

+ +
+ +
+
+
+ + #number +WEAPON.categoryMissile + +

Missile category 0=AAM, 1=SAM, 2=BM, 3=ANTI_SHIP, 4=CRUISE, 5=OTHER (Weapon.MissileCategory.X).

+ +
+ +
+
+
+ + #number +WEAPON.coalition + +

Coalition ID.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.coordinate + +

Coordinate object of the weapon. Can be used in other classes.

+ +
+ +
+
+
+ + #number +WEAPON.country + +

Country ID.

+ +
+ +
+
+
+ + DCS#Desc +WEAPON.desc + +

Descriptor table.

+ +
+ +
+
+
+ + #number +WEAPON.distIP + +

Distance in meters for the intercept point estimation.

+ +
+ +
+
+
+ + #number +WEAPON.dtTrack + +

Time step in seconds for tracking scheduler.

+ +
+ +
+
+
+ + #table +WEAPON.impactArg + +

Optional arguments for the impact callback function.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.impactCoord + +

Impact coordinate.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactDestroy + +

If true, destroy weapon before impact. Requires tracking to be started and sufficiently small time step.

+ +
+ +
+
+
+ + #number +WEAPON.impactDestroyDist + +

Distance in meters to the estimated impact point. If smaller, then weapon is destroyed.

+ +
+ +
+
+
+ + #function +WEAPON.impactFunc + +

Callback function for weapon impact.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactMark + +

If true, the impact point is marked on the F10 map. Requires tracking to be started.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactSmoke + +

If true, the impact point is marked by smoke. Requires tracking to be started.

+ +
+ +
+
+
+ + #number +WEAPON.impactSmokeColor + +

Colour of impact point smoke.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.impactVec3 + +

Impact 3D vector.

+ +
+ +
+
+
+ + DCS#Unit +WEAPON.launcher + +

Launcher DCS unit.

+ +
+ +
+
+
+ + #string +WEAPON.launcherName + +

Name of launcher unit.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.launcherUnit + +

Launcher Unit.

+ +
+ +
+
+
+ + #string +WEAPON.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #string +WEAPON.name + +

Name of the weapon object.

+ +
+ +
+
+
+ + DCS#Position3 +WEAPON.pos3 + +

Last known 3D position and direction vector of the tracked weapon.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.target + +

Last known target.

+ +
+ +
+
+
+ + #table +WEAPON.trackArg + +

Optional arguments for the track callback function.

+ +
+ +
+
+
+ + #function +WEAPON.trackFunc + +

Callback function when weapon is tracked and alive.

+ +
+ +
+
+
+ + #number +WEAPON.trackScheduleID + +

Tracking scheduler ID. Can be used to remove/destroy the scheduler function.

+ +
+ +
+
+
+ + #boolean +WEAPON.tracking + +

If true, scheduler will keep tracking. Otherwise, function will return nil and stop tracking.

+ +
+ +
+
+
+ + #string +WEAPON.typeName + +

Type name of the weapon.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.vec3 + +

Last known 3D position vector of the tracked weapon.

+ +
+ +
+
+
+ + #number +WEAPON.verbose + +

Verbosity level.

+ +
+ +
+
+
+ + #string +WEAPON.version + +

WEAPON class version.

+ +
+ +
+
+
+ + DCS#Weapon +WEAPON.weapon + +

The DCS weapon object.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

WEAPON:Destroy()

+
+ +

Destroys the OBJECT.

+ +
+
+

Defined in:

+
+

Wrapper.Object#OBJECT

+
+

Return values:

+
+
+

#boolean:

+
+
+ +

true if the object is destroyed.

+ +
+
+

#nil:

+
+
+ +

The DCS Unit is not existing or alive.

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

WEAPON:GetID()

+
+ +

Returns the unit's unique identifier.

+ +
+
+

Defined in:

+
+

Wrapper.Object#OBJECT

+
+

Return value:

+
+
+

DCS#Object.ID:

+
+
+ +

ObjectID or #nil if the DCS Object is not existing or alive. Note that the ID is passed as a string and not a number.

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

WEAPON:New(ObjectName, Test)

+
+ +

Create a new OBJECT from a DCSObject

+ +
+
+

Defined in:

+
+

Wrapper.Object#OBJECT

+
+

Parameters:

+
+
+

+ DCS#Object + ObjectName +

+
+
+ +

The Object name

+ +
+
+
+
+

+ Test +

+
+
+

+
+
+

Return value:

+
+
+

#OBJECT:

+
+
+ +

self

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+
+ + #string +WEAPON.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #number +WEAPON.category + +

Weapon category 0=SHELL, 1=MISSILE, 2=ROCKET, 3=BOMB, 4=TORPEDO (Weapon.Category.X).

+ +
+ +
+
+
+ + #number +WEAPON.categoryMissile + +

Missile category 0=AAM, 1=SAM, 2=BM, 3=ANTI_SHIP, 4=CRUISE, 5=OTHER (Weapon.MissileCategory.X).

+ +
+ +
+
+
+ + #number +WEAPON.coalition + +

Coalition ID.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.coordinate + +

Coordinate object of the weapon. Can be used in other classes.

+ +
+ +
+
+
+ + #number +WEAPON.country + +

Country ID.

+ +
+ +
+
+
+ + DCS#Desc +WEAPON.desc + +

Descriptor table.

+ +
+ +
+
+
+ + #number +WEAPON.distIP + +

Distance in meters for the intercept point estimation.

+ +
+ +
+
+
+ + #number +WEAPON.dtTrack + +

Time step in seconds for tracking scheduler.

+ +
+ +
+
+
+ + #table +WEAPON.impactArg + +

Optional arguments for the impact callback function.

+ +
+ +
+
+
+ + Core.Point#COORDINATE +WEAPON.impactCoord + +

Impact coordinate.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactDestroy + +

If true, destroy weapon before impact. Requires tracking to be started and sufficiently small time step.

+ +
+ +
+
+
+ + #number +WEAPON.impactDestroyDist + +

Distance in meters to the estimated impact point. If smaller, then weapon is destroyed.

+ +
+ +
+
+
+ + #function +WEAPON.impactFunc + +

Callback function for weapon impact.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactMark + +

If true, the impact point is marked on the F10 map. Requires tracking to be started.

+ +
+ +
+
+
+ + #boolean +WEAPON.impactSmoke + +

If true, the impact point is marked by smoke. Requires tracking to be started.

+ +
+ +
+
+
+ + #number +WEAPON.impactSmokeColor + +

Colour of impact point smoke.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.impactVec3 + +

Impact 3D vector.

+ +
+ +
+
+
+ + DCS#Unit +WEAPON.launcher + +

Launcher DCS unit.

+ +
+ +
+
+
+ + #string +WEAPON.launcherName + +

Name of launcher unit.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.launcherUnit + +

Launcher Unit.

+ +
+ +
+
+
+ + #string +WEAPON.lid + +

Class id string for output to DCS log file.

+ +
+ +
+
+
+ + #string +WEAPON.name + +

Name of the weapon object.

+ +
+ +
+
+
+ + DCS#Position3 +WEAPON.pos3 + +

Last known 3D position and direction vector of the tracked weapon.

+ +
+ +
+
+
+ + Wrapper.Unit#UNIT +WEAPON.target + +

Last known target.

+ +
+ +
+
+
+ + #table +WEAPON.trackArg + +

Optional arguments for the track callback function.

+ +
+ +
+
+
+ + #function +WEAPON.trackFunc + +

Callback function when weapon is tracked and alive.

+ +
+ +
+
+
+ + #number +WEAPON.trackScheduleID + +

Tracking scheduler ID. Can be used to remove/destroy the scheduler function.

+ +
+ +
+
+
+ + #boolean +WEAPON.tracking + +

If true, scheduler will keep tracking. Otherwise, function will return nil and stop tracking.

+ +
+ +
+
+
+ + #string +WEAPON.typeName + +

Type name of the weapon.

+ +
+ +
+
+
+ + DCS#Vec3 +WEAPON.vec3 + +

Last known 3D position vector of the tracked weapon.

+ +
+ +
+
+
+ + #number +WEAPON.verbose + +

Verbosity level.

+ +
+ +
+
+
+ + #string +WEAPON.version + +

WEAPON class version.

+ +
+ +
+
+
+ + DCS#Weapon +WEAPON.weapon + +

The DCS weapon object.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

WEAPON:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

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

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

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:CreateEventDead(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

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

WEAPON:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

WEAPON:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

WEAPON:CreateEventUnitLost(EventTime, Initiator)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

WEAPON:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

WEAPON:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

WEAPON:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

WEAPON:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

WEAPON:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

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

WEAPON:GetEventPriority()

+
+ +

Get 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

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Core.Event processing Priority.

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

WEAPON:GetParent(Child, FromClass)

+
+ +

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()
+
+ + + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

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:

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

WEAPON:GetState(Object, Key)

+
+ +

Get a Value given a Key from the Object.

+ + +

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 +

+
+
+ +

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:

+
+
+
+
+ +

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

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

WEAPON:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

WEAPON:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:Inherit(Child, Parent)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

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

WEAPON:IsInstanceOf(ClassName)

+
+ +

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

    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#boolean:

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

WEAPON:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

WEAPON:New()

+
+ +

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
+
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

WEAPON:OnEvent(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventBDA(EventData)

+
+ +

BDA.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventBaseCaptured(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventBirth(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventCrash(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventDead(EventData)

+
+ +

Occurs when an object is dead.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventDetailedFailure(EventData)

+
+ +

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.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON: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.

+ + +

initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventEngineShutdown(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventEngineStartup(EventData)

+
+ +

Occurs when any aircraft starts its engines.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventHit(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventHumanFailure(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventKill(EventData)

+
+ +

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
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON: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 +

+
+
+ +

The EventData structure.

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

WEAPON: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 +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventMarkAdded(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventMarkChange(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON: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 +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventMissionEnd(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventMissionStart(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventParatrooperLanding(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventPilotDead(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventPlayerEnterAircraft(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventPlayerEnterUnit(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventPlayerLeaveUnit(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventRefueling(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventRefuelingStop(EventData)

+
+ +

Occurs when an aircraft is finished taking fuel.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventScore(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventShootingEnd(EventData)

+
+ +

Occurs when any unit stops firing its weapon.

+ + +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventShootingStart(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventShot(EventData)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventTakeoff(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

WEAPON:OnEventUnitLost(EventData)

+
+ +

Occurs when the game thinks an object is destroyed.

+ + +

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

+ +
    +
  • initiator: The unit that is was destroyed.
    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

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

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

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

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 +

+
+
+ +

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

Specifies the amount of seconds when the scheduler will be stopped.

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

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

WEAPON:ScheduleStop(SchedulerID)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + SchedulerID +

+
+
+ +

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

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

WEAPON: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 +

+
+
+ +

The Core.Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

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

WEAPON: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 +

+
+
+ +

The object that will hold the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

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!

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

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

WEAPON:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

WEAPON:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

WEAPON:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

WEAPON:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

WEAPON:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

WEAPON:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

WEAPON:TraceOnOff(TraceOnOff)

+
+ +

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.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

+  -- Switch the tracing On
+  BASE:TraceOnOff( true )
+
+  -- Switch the tracing Off
+  BASE:TraceOnOff( false )
+
+ +
+ +
+
+ +
+ +
+

WEAPON:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

WEAPON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

WEAPON:onEvent(event)

+
+ +

The main event handling function...

+ + +

This function captures all events generated for the class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ DCS#Event + event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+
+ + +
+ + + + diff --git a/Documentation/index.html b/Documentation/index.html index 3b8ea67f1..89d348e1f 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1555,6 +1555,17 @@

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + +
+
+
+ Image +

Wrapper.Weapon

+
+

+

Wrapper - Weapon functions.

@@ -3230,6 +3241,18 @@

Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.

+

+ + + +
+
+ Image +
+
+

Wrapper.Weapon

+

+

Wrapper - Weapon functions.