From 5edbb5f1ba163210b5915cded7f4231cc144fe65 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Wed, 13 Sep 2023 14:17:09 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2A_Cap.html | 18 + Documentation/AI.AI_A2A_Dispatcher.html | 18 + Documentation/AI.AI_A2G_Dispatcher.html | 18 + Documentation/AI.AI_Air.html | 18 + Documentation/AI.AI_Air_Dispatcher.html | 62 +- Documentation/AI.AI_Air_Patrol.html | 18 + Documentation/AI.AI_Air_Squadron.html | 18 + Documentation/AI.AI_BAI.html | 18 + Documentation/AI.AI_Balancer.html | 18 + Documentation/AI.AI_CAP.html | 18 + Documentation/AI.AI_CAS.html | 18 + Documentation/AI.AI_Cargo.html | 26 +- Documentation/AI.AI_Cargo_APC.html | 18 + Documentation/AI.AI_Cargo_Airplane.html | 74 +- Documentation/AI.AI_Cargo_Dispatcher.html | 18 + Documentation/AI.AI_Cargo_Dispatcher_APC.html | 18 + .../AI.AI_Cargo_Dispatcher_Airplane.html | 18 + .../AI.AI_Cargo_Dispatcher_Helicopter.html | 18 + .../AI.AI_Cargo_Dispatcher_Ship.html | 18 + Documentation/AI.AI_Cargo_Helicopter.html | 58 +- Documentation/AI.AI_Cargo_Ship.html | 18 + Documentation/AI.AI_Escort.html | 18 + Documentation/AI.AI_Escort_Dispatcher.html | 18 + .../AI.AI_Escort_Dispatcher_Request.html | 18 + Documentation/AI.AI_Escort_Request.html | 18 + Documentation/AI.AI_Formation.html | 18 + Documentation/AI.AI_Patrol.html | 30 + Documentation/Actions.Act_Account.html | 18 + Documentation/Actions.Act_Assign.html | 18 + Documentation/Actions.Act_Assist.html | 18 + Documentation/Actions.Act_Route.html | 18 + Documentation/Cargo.Cargo.html | 18 + Documentation/Cargo.CargoGroup.html | 56 +- Documentation/Cargo.CargoUnit.html | 22 - Documentation/Core.Astar.html | 18 + Documentation/Core.Base.html | 18 + Documentation/Core.Beacon.html | 18 + Documentation/Core.Condition.html | 18 + Documentation/Core.Database.html | 4013 +++++++++++++++ Documentation/Core.Event.html | 36 + Documentation/Core.Fsm.html | 76 +- Documentation/Core.Goal.html | 18 + Documentation/Core.MarkerOps_Base.html | 18 + Documentation/Core.Message.html | 18 + Documentation/Core.Pathline.html | 18 + Documentation/Core.Point.html | 69 +- Documentation/Core.Report.html | 18 + Documentation/Core.ScheduleDispatcher.html | 18 + Documentation/Core.Scheduler.html | 18 + Documentation/Core.Set.html | 234 + Documentation/Core.Settings.html | 26 +- Documentation/Core.Spawn.html | 124 +- Documentation/Core.SpawnStatic.html | 18 + Documentation/Core.Spot.html | 117 +- Documentation/Core.TextAndSound.html | 18 + Documentation/Core.Timer.html | 18 + Documentation/Core.UserFlag.html | 18 + Documentation/Core.Velocity.html | 36 + Documentation/Core.Zone.html | 18 + Documentation/Functional.ATC_Ground.html | 40 +- Documentation/Functional.Artillery.html | 18 + Documentation/Functional.CleanUp.html | 18 + Documentation/Functional.Designate.html | 73 +- Documentation/Functional.Detection.html | 144 +- Documentation/Functional.DetectionZones.html | 18 + Documentation/Functional.Escort.html | 4515 ++++++++++++++++- Documentation/Functional.Fox.html | 18 + Documentation/Functional.Mantis.html | 130 +- Documentation/Functional.MissileTrainer.html | 4017 +++++++++++++++ Documentation/Functional.Movement.html | 3957 ++++++++++++++- Documentation/Functional.PseudoATC.html | 18 + Documentation/Functional.RAT.html | 42 +- Documentation/Functional.Range.html | 18 + Documentation/Functional.Scoring.html | 36 +- Documentation/Functional.Sead.html | 18 + Documentation/Functional.Shorad.html | 18 + Documentation/Functional.Suppression.html | 18 + Documentation/Functional.Warehouse.html | 18 + Documentation/Ops.ATIS.html | 18 + Documentation/Ops.Airboss.html | 36 +- Documentation/Ops.CSAR.html | 105 +- Documentation/Ops.CTLD.html | 196 +- Documentation/Ops.RecoveryTanker.html | 18 + Documentation/Ops.RescueHelo.html | 18 + Documentation/Sound.Radio.html | 18 + Documentation/Sound.RadioQueue.html | 18 + Documentation/Sound.SRS.html | 36 + Documentation/Sound.SoundOutput.html | 54 + Documentation/Sound.UserSound.html | 18 + Documentation/Tasking.CommandCenter.html | 18 + Documentation/Tasking.DetectionManager.html | 18 + Documentation/Tasking.Mission.html | 18 + Documentation/Tasking.TaskInfo.html | 18 + .../Tasking.Task_A2A_Dispatcher.html | 18 + .../Tasking.Task_A2G_Dispatcher.html | 18 + .../Tasking.Task_Capture_Dispatcher.html | 18 + .../Tasking.Task_Cargo_Dispatcher.html | 210 +- Documentation/Tasking.Task_Manager.html | 18 + Documentation/Utilities.FiFo.html | 36 + Documentation/Utilities.Socket.html | 18 + Documentation/Utilities.Utils.html | 104 + Documentation/Wrapper.Airbase.html | 18 + Documentation/Wrapper.Client.html | 18 + Documentation/Wrapper.Controllable.html | 18 + Documentation/Wrapper.Group.html | 96 +- Documentation/Wrapper.Identifiable.html | 18 + Documentation/Wrapper.Marker.html | 84 +- Documentation/Wrapper.Net.html | 18 + Documentation/Wrapper.Object.html | 18 + Documentation/Wrapper.Positionable.html | 36 + Documentation/Wrapper.Scenery.html | 18 + Documentation/Wrapper.Static.html | 18 + Documentation/Wrapper.Storage.html | 18 + Documentation/Wrapper.Unit.html | 18 + Documentation/Wrapper.Weapon.html | 18 + 115 files changed, 19482 insertions(+), 946 deletions(-) diff --git a/Documentation/AI.AI_A2A_Cap.html b/Documentation/AI.AI_A2A_Cap.html index 0bebd5060..4978719e4 100644 --- a/Documentation/AI.AI_A2A_Cap.html +++ b/Documentation/AI.AI_A2A_Cap.html @@ -2793,6 +2793,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_A2A_CAP.ClassID

+ +

The ID number of the class.

+ + + +

AI_A2A_CAP.ClassName

+ +

The name of the class.

+ + + +

AI_A2A_CAP.ClassNameAndID

+ +

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

+ +

AI_A2A_CAP:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 0c26daeab..f52c1780c 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -4037,6 +4037,24 @@ The following parameters were given to the :New method of AI_A2A_GCICAP, and mea Fields and Methods inherited from BASE Description + +

AI_A2A_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

AI_A2A_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

AI_A2A_DISPATCHER.ClassNameAndID

+ +

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

+ +

AI_A2A_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 8cc2e66f6..b5ee5066d 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4004,6 +4004,24 @@ of the squadron are destroyed. This is to keep consistency of air operations and Fields and Methods inherited from BASE Description + +

AI_A2G_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

AI_A2G_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

AI_A2G_DISPATCHER.ClassNameAndID

+ +

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

+ +

AI_A2G_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 8cde0df2c..f5a6eff83 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2491,6 +2491,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_AIR.ClassID

+ +

The ID number of the class.

+ + + +

AI_AIR.ClassName

+ +

The name of the class.

+ + + +

AI_AIR.ClassNameAndID

+ +

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

+ +

AI_AIR:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index 1e8f5908a..959f72ad0 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -3764,6 +3764,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_AIR_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

AI_AIR_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

AI_AIR_DISPATCHER.ClassNameAndID

+ +

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

+ +

AI_AIR_DISPATCHER:ClearState(Object, StateName)

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -9813,17 +9820,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -11141,17 +11137,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12771,17 +12756,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air_Patrol.html b/Documentation/AI.AI_Air_Patrol.html index ce8f62754..1c2d17395 100644 --- a/Documentation/AI.AI_Air_Patrol.html +++ b/Documentation/AI.AI_Air_Patrol.html @@ -2734,6 +2734,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_AIR_PATROL.ClassID

+ +

The ID number of the class.

+ + + +

AI_AIR_PATROL.ClassName

+ +

The name of the class.

+ + + +

AI_AIR_PATROL.ClassNameAndID

+ +

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

+ +

AI_AIR_PATROL:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 9698c07bc..bfe8eb819 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -1907,6 +1907,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_AIR_SQUADRON.ClassID

+ +

The ID number of the class.

+ + + +

AI_AIR_SQUADRON.ClassName

+ +

The name of the class.

+ + + +

AI_AIR_SQUADRON.ClassNameAndID

+ +

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

+ +

AI_AIR_SQUADRON:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_BAI.html b/Documentation/AI.AI_BAI.html index 44d7e25cb..e54526611 100644 --- a/Documentation/AI.AI_BAI.html +++ b/Documentation/AI.AI_BAI.html @@ -2931,6 +2931,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_BAI_ZONE.ClassID

+ +

The ID number of the class.

+ + + +

AI_BAI_ZONE.ClassName

+ +

The name of the class.

+ + + +

AI_BAI_ZONE.ClassNameAndID

+ +

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

+ +

AI_BAI_ZONE:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Balancer.html b/Documentation/AI.AI_Balancer.html index 631733819..4927bfa62 100644 --- a/Documentation/AI.AI_Balancer.html +++ b/Documentation/AI.AI_Balancer.html @@ -2158,6 +2158,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_BALANCER.ClassID

+ +

The ID number of the class.

+ + + +

AI_BALANCER.ClassName

+ +

The name of the class.

+ + + +

AI_BALANCER.ClassNameAndID

+ +

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

+ +

AI_BALANCER:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_CAP.html b/Documentation/AI.AI_CAP.html index c3e49e1ea..58b61513d 100644 --- a/Documentation/AI.AI_CAP.html +++ b/Documentation/AI.AI_CAP.html @@ -2844,6 +2844,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CAP_ZONE.ClassID

+ +

The ID number of the class.

+ + + +

AI_CAP_ZONE.ClassName

+ +

The name of the class.

+ + + +

AI_CAP_ZONE.ClassNameAndID

+ +

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

+ +

AI_CAP_ZONE:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_CAS.html b/Documentation/AI.AI_CAS.html index c609c37a2..621790928 100644 --- a/Documentation/AI.AI_CAS.html +++ b/Documentation/AI.AI_CAS.html @@ -2862,6 +2862,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CAS_ZONE.ClassID

+ +

The ID number of the class.

+ + + +

AI_CAS_ZONE.ClassName

+ +

The name of the class.

+ + + +

AI_CAS_ZONE.ClassNameAndID

+ +

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

+ +

AI_CAS_ZONE:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index cff1402fb..6a67bd8cc 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2210,6 +2210,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO.ClassNameAndID

+ +

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

+ +

AI_CARGO:ClearState(Object, StateName)

@@ -2738,7 +2756,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4768,7 +4786,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5380,7 +5398,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -6880,7 +6898,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier diff --git a/Documentation/AI.AI_Cargo_APC.html b/Documentation/AI.AI_Cargo_APC.html index 423d39fe6..4a01c4b35 100644 --- a/Documentation/AI.AI_Cargo_APC.html +++ b/Documentation/AI.AI_Cargo_APC.html @@ -2448,6 +2448,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_APC.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_APC.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_APC.ClassNameAndID

+ +

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

+ +

AI_CARGO_APC:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index ef195286a..ad4d1919a 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2200,6 +2200,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_AIRPLANE.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_AIRPLANE.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_AIRPLANE.ClassNameAndID

+ +

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

+ +

AI_CARGO_AIRPLANE:ClearState(Object, StateName)

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -2791,6 +2798,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -4575,6 +4574,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -5201,6 +5192,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

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

Field(s)

-
-
- - -AI_CARGO_AIRPLANE.Airbase - - - -
- -
@@ -6715,6 +6698,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a pickup mission.

+
diff --git a/Documentation/AI.AI_Cargo_Dispatcher.html b/Documentation/AI.AI_Cargo_Dispatcher.html index 1a51c9190..7736d54e6 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher.html +++ b/Documentation/AI.AI_Cargo_Dispatcher.html @@ -2815,6 +2815,24 @@ Use AI_CARGO_DISPATCHER.SetHomeZon Fields and Methods inherited from BASE Description + +

AI_CARGO_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_DISPATCHER.ClassNameAndID

+ +

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

+ +

AI_CARGO_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_APC.html b/Documentation/AI.AI_Cargo_Dispatcher_APC.html index 79f483840..0218d36f5 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_APC.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_APC.html @@ -2456,6 +2456,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_DISPATCHER_APC.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_DISPATCHER_APC.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_DISPATCHER_APC.ClassNameAndID

+ +

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

+ +

AI_CARGO_DISPATCHER_APC:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html index dbd2ea131..da91882cf 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Airplane.html @@ -2367,6 +2367,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_DISPATCHER_AIRPLANE.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_DISPATCHER_AIRPLANE.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_DISPATCHER_AIRPLANE.ClassNameAndID

+ +

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

+ +

AI_CARGO_DISPATCHER_AIRPLANE:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html index bcacd716d..b4fae8c97 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Helicopter.html @@ -2405,6 +2405,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_DISPATCHER_HELICOPTER.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_DISPATCHER_HELICOPTER.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_DISPATCHER_HELICOPTER.ClassNameAndID

+ +

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

+ +

AI_CARGO_DISPATCHER_HELICOPTER:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html index 7fb06b7a5..33abc813a 100644 --- a/Documentation/AI.AI_Cargo_Dispatcher_Ship.html +++ b/Documentation/AI.AI_Cargo_Dispatcher_Ship.html @@ -2401,6 +2401,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_DISPATCHER_SHIP.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_DISPATCHER_SHIP.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_DISPATCHER_SHIP.ClassNameAndID

+ +

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

+ +

AI_CARGO_DISPATCHER_SHIP:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Cargo_Helicopter.html b/Documentation/AI.AI_Cargo_Helicopter.html index da5f70fed..7cba70c93 100644 --- a/Documentation/AI.AI_Cargo_Helicopter.html +++ b/Documentation/AI.AI_Cargo_Helicopter.html @@ -2271,6 +2271,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_HELICOPTER.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_HELICOPTER.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_HELICOPTER.ClassNameAndID

+ +

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

+ +

AI_CARGO_HELICOPTER:ClearState(Object, StateName)

@@ -2890,28 +2908,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + AI_CARGO_HELICOPTER.landingheight - -

meter

-
- #number + AI_CARGO_HELICOPTER.landingspeed - -

kph

-
@@ -4814,28 +4826,22 @@ Adjust if necessary.
- #number + AI_CARGO_HELICOPTER.landingheight - -

meter

-
- #number + AI_CARGO_HELICOPTER.landingspeed - -

kph

-
@@ -5490,28 +5496,22 @@ Adjust if necessary.
- #number + AI_CARGO_HELICOPTER.landingheight - -

meter

-
- #number + AI_CARGO_HELICOPTER.landingspeed - -

kph

-
@@ -7054,28 +7054,22 @@ Adjust if necessary.
- #number + AI_CARGO_HELICOPTER.landingheight - -

meter

-
- #number + AI_CARGO_HELICOPTER.landingspeed - -

kph

-
diff --git a/Documentation/AI.AI_Cargo_Ship.html b/Documentation/AI.AI_Cargo_Ship.html index 9c7225771..966d75085 100644 --- a/Documentation/AI.AI_Cargo_Ship.html +++ b/Documentation/AI.AI_Cargo_Ship.html @@ -2343,6 +2343,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_CARGO_SHIP.ClassID

+ +

The ID number of the class.

+ + + +

AI_CARGO_SHIP.ClassName

+ +

The name of the class.

+ + + +

AI_CARGO_SHIP.ClassNameAndID

+ +

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

+ +

AI_CARGO_SHIP:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Escort.html b/Documentation/AI.AI_Escort.html index 8f1157eb2..38fe0e985 100644 --- a/Documentation/AI.AI_Escort.html +++ b/Documentation/AI.AI_Escort.html @@ -3280,6 +3280,24 @@ Therefore, this class is considered to be deprecated Fields and Methods inherited from BASE Description + +

AI_ESCORT.ClassID

+ +

The ID number of the class.

+ + + +

AI_ESCORT.ClassName

+ +

The name of the class.

+ + + +

AI_ESCORT.ClassNameAndID

+ +

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

+ +

AI_ESCORT:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Escort_Dispatcher.html b/Documentation/AI.AI_Escort_Dispatcher.html index 80857628a..3799c82a8 100644 --- a/Documentation/AI.AI_Escort_Dispatcher.html +++ b/Documentation/AI.AI_Escort_Dispatcher.html @@ -2033,6 +2033,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_ESCORT_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

AI_ESCORT_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

AI_ESCORT_DISPATCHER.ClassNameAndID

+ +

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

+ +

AI_ESCORT_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Escort_Dispatcher_Request.html b/Documentation/AI.AI_Escort_Dispatcher_Request.html index f329e23af..d07a7d070 100644 --- a/Documentation/AI.AI_Escort_Dispatcher_Request.html +++ b/Documentation/AI.AI_Escort_Dispatcher_Request.html @@ -2035,6 +2035,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_ESCORT_DISPATCHER_REQUEST.ClassID

+ +

The ID number of the class.

+ + + +

AI_ESCORT_DISPATCHER_REQUEST.ClassName

+ +

The name of the class.

+ + + +

AI_ESCORT_DISPATCHER_REQUEST.ClassNameAndID

+ +

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

+ +

AI_ESCORT_DISPATCHER_REQUEST:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Escort_Request.html b/Documentation/AI.AI_Escort_Request.html index 415a1850d..8bb290a1c 100644 --- a/Documentation/AI.AI_Escort_Request.html +++ b/Documentation/AI.AI_Escort_Request.html @@ -3365,6 +3365,24 @@ EscortPlanes = AI_ESCORT_REQUEST:New( EscortUnit, EscortGroup, "Desert", "Welcom Fields and Methods inherited from BASE Description + +

AI_ESCORT_REQUEST.ClassID

+ +

The ID number of the class.

+ + + +

AI_ESCORT_REQUEST.ClassName

+ +

The name of the class.

+ + + +

AI_ESCORT_REQUEST.ClassNameAndID

+ +

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

+ +

AI_ESCORT_REQUEST:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Formation.html b/Documentation/AI.AI_Formation.html index e775c00b5..2f4712af4 100644 --- a/Documentation/AI.AI_Formation.html +++ b/Documentation/AI.AI_Formation.html @@ -2499,6 +2499,24 @@ Therefore, this class is considered to be deprecated Fields and Methods inherited from BASE Description + +

AI_FORMATION.ClassID

+ +

The ID number of the class.

+ + + +

AI_FORMATION.ClassName

+ +

The name of the class.

+ + + +

AI_FORMATION.ClassNameAndID

+ +

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

+ +

AI_FORMATION:ClearState(Object, StateName)

diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index 050182a89..526c78036 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -2628,6 +2628,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

AI_PATROL_ZONE.ClassID

+ +

The ID number of the class.

+ + + +

AI_PATROL_ZONE.ClassName

+ +

The name of the class.

+ + + +

AI_PATROL_ZONE.ClassNameAndID

+ +

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

+ +

AI_PATROL_ZONE:ClearState(Object, StateName)

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

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

This table contains the targets detected during patrol.

+
diff --git a/Documentation/Actions.Act_Account.html b/Documentation/Actions.Act_Account.html index ce32ce9e5..5e6e0ffd0 100644 --- a/Documentation/Actions.Act_Account.html +++ b/Documentation/Actions.Act_Account.html @@ -2163,6 +2163,24 @@ Fields and Methods inherited from BASE Description + +

ACT_ACCOUNT.ClassID

+ +

The ID number of the class.

+ + + +

ACT_ACCOUNT.ClassName

+ +

The name of the class.

+ + + +

ACT_ACCOUNT.ClassNameAndID

+ +

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

+ +

ACT_ACCOUNT:ClearState(Object, StateName)

diff --git a/Documentation/Actions.Act_Assign.html b/Documentation/Actions.Act_Assign.html index 35cc39ef8..6f14fd8d9 100644 --- a/Documentation/Actions.Act_Assign.html +++ b/Documentation/Actions.Act_Assign.html @@ -2261,6 +2261,24 @@ The assignment type also allows to reject the task.

Fields and Methods inherited from BASE Description + +

ACT_ASSIGN.ClassID

+ +

The ID number of the class.

+ + + +

ACT_ASSIGN.ClassName

+ +

The name of the class.

+ + + +

ACT_ASSIGN.ClassNameAndID

+ +

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

+ +

ACT_ASSIGN:ClearState(Object, StateName)

diff --git a/Documentation/Actions.Act_Assist.html b/Documentation/Actions.Act_Assist.html index 6d7b5691f..cc1e11188 100644 --- a/Documentation/Actions.Act_Assist.html +++ b/Documentation/Actions.Act_Assist.html @@ -2263,6 +2263,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

ACT_ASSIST.ClassID

+ +

The ID number of the class.

+ + + +

ACT_ASSIST.ClassName

+ +

The name of the class.

+ + + +

ACT_ASSIST.ClassNameAndID

+ +

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

+ +

ACT_ASSIST:ClearState(Object, StateName)

diff --git a/Documentation/Actions.Act_Route.html b/Documentation/Actions.Act_Route.html index d952ba011..c13b89556 100644 --- a/Documentation/Actions.Act_Route.html +++ b/Documentation/Actions.Act_Route.html @@ -2320,6 +2320,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

ACT_ROUTE.ClassID

+ +

The ID number of the class.

+ + + +

ACT_ROUTE.ClassName

+ +

The name of the class.

+ + + +

ACT_ROUTE.ClassNameAndID

+ +

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

+ +

ACT_ROUTE:ClearState(Object, StateName)

diff --git a/Documentation/Cargo.Cargo.html b/Documentation/Cargo.Cargo.html index 420be2f15..d45efe2aa 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -3047,6 +3047,24 @@ All derived classes from CARGO follow the same state machine, expose the same ca Fields and Methods inherited from BASE Description + +

CARGO.ClassID

+ +

The ID number of the class.

+ + + +

CARGO.ClassName

+ +

The name of the class.

+ + + +

CARGO.ClassNameAndID

+ +

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

+ +

CARGO:ClearState(Object, StateName)

diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 3a69e0b92..11b8eef81 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1935,6 +1935,20 @@ Therefore, this class is considered to be deprecated

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup @@ -1950,20 +1964,6 @@ Therefore, this class is considered to be deprecated

-
- -
-
-
- - -CARGO_GROUP.CargoObject - - - - -

Now we spawn the new group based on the template created.

-
@@ -3253,6 +3253,20 @@ This works for ground only groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup @@ -3268,20 +3282,6 @@ This works for ground only groups.

-
- -
-
-
- - -CARGO_GROUP.CargoObject - - - - -

Now we spawn the new group based on the template created.

-
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 664d12d05..775118c02 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1813,17 +1813,6 @@ Therefore, this class is considered to be deprecated

-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2539,17 +2528,6 @@ Therefore, this class is considered to be deprecated

-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Astar.html b/Documentation/Core.Astar.html index bf37e1d02..6dd2168eb 100644 --- a/Documentation/Core.Astar.html +++ b/Documentation/Core.Astar.html @@ -2087,6 +2087,24 @@ describe the optimal path from the start node to the end node.

Fields and Methods inherited from BASE Description + +

ASTAR.ClassID

+ +

The ID number of the class.

+ + + +

ASTAR.ClassName

+ +

The name of the class.

+ + + +

ASTAR.ClassNameAndID

+ +

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

+ +

ASTAR:ClearState(Object, StateName)

diff --git a/Documentation/Core.Base.html b/Documentation/Core.Base.html index fb7e06cdd..321d15b3a 100644 --- a/Documentation/Core.Base.html +++ b/Documentation/Core.Base.html @@ -1859,6 +1859,24 @@ object name to the method.

Fields and Methods inherited from BASE Description + +

BASE.ClassID

+ +

The ID number of the class.

+ + + +

BASE.ClassName

+ +

The name of the class.

+ + + +

BASE.ClassNameAndID

+ +

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

+ +

BASE:ClearState(Object, StateName)

diff --git a/Documentation/Core.Beacon.html b/Documentation/Core.Beacon.html index 9a0c45496..cf5d93f23 100644 --- a/Documentation/Core.Beacon.html +++ b/Documentation/Core.Beacon.html @@ -1746,6 +1746,24 @@ This uses the very generic singleton function "trigger.action.radioTransmission( Fields and Methods inherited from BASE Description + +

BEACON.ClassID

+ +

The ID number of the class.

+ + + +

BEACON.ClassName

+ +

The name of the class.

+ + + +

BEACON.ClassNameAndID

+ +

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

+ +

BEACON:ClearState(Object, StateName)

diff --git a/Documentation/Core.Condition.html b/Documentation/Core.Condition.html index fb9475703..249070bd7 100644 --- a/Documentation/Core.Condition.html +++ b/Documentation/Core.Condition.html @@ -1862,6 +1862,24 @@ Fields and Methods inherited from BASE Description + +

CONDITION.ClassID

+ +

The ID number of the class.

+ + + +

CONDITION.ClassName

+ +

The name of the class.

+ + + +

CONDITION.ClassNameAndID

+ +

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

+ +

CONDITION:ClearState(Object, StateName)

diff --git a/Documentation/Core.Database.html b/Documentation/Core.Database.html index e429b890a..524b57a8d 100644 --- a/Documentation/Core.Database.html +++ b/Documentation/Core.Database.html @@ -1687,6 +1687,7 @@ Moose refers to _DATABASE within the framework extensively, but

Type DATABASE

DATABASE +, extends Core.Base#BASE
@@ -1788,6 +1789,18 @@ Moose refers to _DATABASE within the framework extensively, but + + + + + + + + @@ -2124,6 +2137,12 @@ Moose refers to _DATABASE within the framework extensively, but + + + + @@ -2142,6 +2161,12 @@ Moose refers to _DATABASE within the framework extensively, but + + + + @@ -2238,6 +2263,542 @@ Moose refers to _DATABASE within the framework extensively, but + +

DATABASE:AddZoneGoal(ZoneName, Zone)

Adds a Core.Zone based on the zone name in the DATABASE.

+

DATABASE.CLIENTS

 +

Clients.

+

DATABASE.ClassName

 +

Name of the class.

DATABASE:OnEventNewZone(EventData)

Handles the OnEventNewZone event.

+

DATABASE.STORAGES

 +

DCS warehouse storages.

DATABASE:Spawn(SpawnTemplate)

Instantiate new Groups within the DCSRTE.

+

DATABASE.Templates

 +

Templates: Units, Groups, Statics, ClientsByName, ClientsByID.

DATABASE:_RegisterZones()

Private method that registers new ZONE_BASE derived objects within the DATABASE Object.

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

DATABASE.ClassID

 +

The ID number of the class.

+

DATABASE.ClassName

 +

The name of the class.

+

DATABASE.ClassNameAndID

 +

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

+

DATABASE:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

DATABASE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

DATABASE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

DATABASE:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

DATABASE:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

DATABASE:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

DATABASE:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

DATABASE:E(Arguments)

 +

Log an exception which will be traced always.

+

DATABASE:EventDispatcher()

 +

Returns the event dispatcher

+

DATABASE:EventRemoveAll()

 +

Remove all subscribed events

+

DATABASE:F(Arguments)

 +

Trace a function call.

+

DATABASE:F2(Arguments)

 +

Trace a function call level 2.

+

DATABASE:F3(Arguments)

 +

Trace a function call level 3.

+

DATABASE:GetClassID()

 +

Get the ClassID of the class instance.

+

DATABASE:GetClassName()

 +

Get the ClassName of the class instance.

+

DATABASE:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

DATABASE:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

DATABASE:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

DATABASE:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

DATABASE:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

DATABASE:I(Arguments)

 +

Log an information which will be traced always.

+

DATABASE:Inherit(Child, Parent)

 +

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

+

DATABASE:IsInstanceOf(ClassName)

 +

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

+

DATABASE:IsTrace()

 +

Enquires if tracing is on (for the class).

+

DATABASE:New()

 +

BASE constructor.

+

DATABASE:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

DATABASE:OnEventBDA(EventData)

 +

BDA.

+

DATABASE:OnEventBaseCaptured(EventData)

 +

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

+

DATABASE:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

DATABASE:OnEventCrash(EventData)

 +

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

+

DATABASE:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

DATABASE:OnEventDetailedFailure(EventData)

 +

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

+

DATABASE:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

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

+

DATABASE:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

DATABASE:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

DATABASE:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

DATABASE:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

DATABASE:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

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

+

DATABASE:OnEventLandingAfterEjection(EventData)

 +

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

+

DATABASE:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

DATABASE:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

DATABASE:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

DATABASE:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

DATABASE:OnEventMissionEnd(EventData)

 +

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

+

DATABASE:OnEventMissionStart(EventData)

 +

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

+

DATABASE:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

DATABASE:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

DATABASE:OnEventPlayerEnterAircraft(EventData)

 +

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

+

DATABASE:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

DATABASE:OnEventPlayerLeaveUnit(EventData)

 +

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

+

DATABASE:OnEventRefueling(EventData)

 +

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

+

DATABASE:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

DATABASE:OnEventScore(EventData)

 +

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

+

DATABASE:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

DATABASE:OnEventShootingStart(EventData)

 +

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

+

DATABASE:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

DATABASE:OnEventTakeoff(EventData)

 +

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

+

DATABASE:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

DATABASE:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

DATABASE:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

DATABASE.Scheduler

 + +

DATABASE:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

DATABASE:SetState(Object, Key, Value)

 +

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

+

DATABASE:T(Arguments)

 +

Trace a function logic level 1.

+

DATABASE:T2(Arguments)

 +

Trace a function logic level 2.

+

DATABASE:T3(Arguments)

 +

Trace a function logic level 3.

+

DATABASE:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

DATABASE:TraceClass(Class)

 +

Set tracing for a class

+

DATABASE:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

DATABASE:TraceLevel(Level)

 +

Set trace level

+

DATABASE:TraceOff()

 +

Set trace off.

+

DATABASE:TraceOn()

 +

Set trace on.

+

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

+

DATABASE:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

DATABASE._

 + +

DATABASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

DATABASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

DATABASE.__

 + +

DATABASE:onEvent(event)

 +

The main event handling function...
@@ -2255,6 +2816,50 @@ Moose refers to _DATABASE within the framework extensively, but

Field(s)

+
+
+ + #table +DATABASE.CLIENTS + +

Clients.

+ +
+ +
+
+
+ + #string +DATABASE.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #table +DATABASE.STORAGES + +

DCS warehouse storages.

+ +
+ +
+
+
+ + #table +DATABASE.Templates + +

Templates: Units, Groups, Statics, ClientsByName, ClientsByID.

+ +
+ +
@@ -6035,6 +6640,3414 @@ This method is used by the SPAWN class.

+
+

Field(s)

+
+
+
+ + #table +DATABASE.CLIENTS + +

Clients.

+ +
+ +
+
+
+ + #string +DATABASE.ClassName + +

Name of the class.

+ +
+ +
+
+
+ + #table +DATABASE.STORAGES + +

DCS warehouse storages.

+ +
+ +
+
+
+ + #table +DATABASE.Templates + +

Templates: Units, Groups, Statics, ClientsByName, ClientsByID.

+ +
+ +
+
+
+ + #number +DATABASE.UNITS_Position + + + +
+ +
+
+

Function(s)

+
+
+ +
+

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

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

DATABASE: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

DATABASE: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

DATABASE: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

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

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

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

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

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

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

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

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

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

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

DATABASE:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

DATABASE:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

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

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

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

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

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

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

DATABASE:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

DATABASE:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

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

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

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

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

DATABASE: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:

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

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

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

DATABASE: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:

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

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

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

DATABASE: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

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

DATABASE: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:

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

DATABASE:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

DATABASE: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:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DATABASE: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

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

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

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

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

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

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

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

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

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

DATABASE:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

DATABASE:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

DATABASE:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

DATABASE:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

DATABASE:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

DATABASE:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

DATABASE: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 )
+
+ +
+ +
+
+ +
+ +
+

DATABASE:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

DATABASE:_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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

DATABASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

DATABASE: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/Core.Event.html b/Documentation/Core.Event.html index f04c27ad9..3b44bf2e9 100644 --- a/Documentation/Core.Event.html +++ b/Documentation/Core.Event.html @@ -2026,6 +2026,24 @@ Example code snippet:

Fields and Methods inherited from BASE Description + +

EVENT.ClassID

+ +

The ID number of the class.

+ + + +

EVENT.ClassName

+ +

The name of the class.

+ + + +

EVENT.ClassNameAndID

+ +

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

+ +

EVENT:ClearState(Object, StateName)

@@ -2920,6 +2938,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

EVENTHANDLER.ClassID

+ +

The ID number of the class.

+ + + +

EVENTHANDLER.ClassName

+ +

The name of the class.

+ + + +

EVENTHANDLER.ClassNameAndID

+ +

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

+ +

EVENTHANDLER:ClearState(Object, StateName)

diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 44e1204cd..58c6b9480 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -2391,6 +2391,24 @@ for multiple objects or the position of the state machine in the process.

Fields and Methods inherited from BASE Description + +

FSM.ClassID

+ +

The ID number of the class.

+ + + +

FSM.ClassName

+ +

The name of the class.

+ + + +

FSM.ClassNameAndID

+ +

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

+ +

FSM:ClearState(Object, StateName)

@@ -3268,6 +3286,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

FSM_CONTROLLABLE.ClassID

+ +

The ID number of the class.

+ + + +

FSM_CONTROLLABLE.ClassName

+ +

The name of the class.

+ + + +

FSM_CONTROLLABLE.ClassNameAndID

+ +

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

+ +

FSM_CONTROLLABLE:ClearState(Object, StateName)

@@ -4238,6 +4274,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

FSM_PROCESS.ClassID

+ +

The ID number of the class.

+ + + +

FSM_PROCESS.ClassName

+ +

The name of the class.

+ + + +

FSM_PROCESS.ClassNameAndID

+ +

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

+ +

FSM_PROCESS:ClearState(Object, StateName)

@@ -5073,6 +5127,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

FSM_SET.ClassID

+ +

The ID number of the class.

+ + + +

FSM_SET.ClassName

+ +

The name of the class.

+ + + +

FSM_SET.ClassNameAndID

+ +

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

+ +

FSM_SET:ClearState(Object, StateName)

@@ -5721,7 +5793,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7320,7 +7392,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 807596285..baf8c3d51 100644 --- a/Documentation/Core.Goal.html +++ b/Documentation/Core.Goal.html @@ -2081,6 +2081,24 @@ You can use this method to check asynchronously if a goal has been achieved, for Fields and Methods inherited from BASE Description + +

GOAL.ClassID

+ +

The ID number of the class.

+ + + +

GOAL.ClassName

+ +

The name of the class.

+ + + +

GOAL.ClassNameAndID

+ +

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

+ +

GOAL:ClearState(Object, StateName)

diff --git a/Documentation/Core.MarkerOps_Base.html b/Documentation/Core.MarkerOps_Base.html index 2119dd1a9..31ff3d6d9 100644 --- a/Documentation/Core.MarkerOps_Base.html +++ b/Documentation/Core.MarkerOps_Base.html @@ -2074,6 +2074,24 @@ Last Update: Feb 2023

Fields and Methods inherited from BASE Description + +

MARKEROPS_BASE.ClassID

+ +

The ID number of the class.

+ + + +

MARKEROPS_BASE.ClassName

+ +

The name of the class.

+ + + +

MARKEROPS_BASE.ClassNameAndID

+ +

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

+ +

MARKEROPS_BASE:ClearState(Object, StateName)

diff --git a/Documentation/Core.Message.html b/Documentation/Core.Message.html index ccd003b6b..619c87797 100644 --- a/Documentation/Core.Message.html +++ b/Documentation/Core.Message.html @@ -1825,6 +1825,24 @@ To send messages, you need to use the To functions.

Fields and Methods inherited from BASE Description + +

MESSAGE.ClassID

+ +

The ID number of the class.

+ + + +

MESSAGE.ClassName

+ +

The name of the class.

+ + + +

MESSAGE.ClassNameAndID

+ +

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

+ +

MESSAGE:ClearState(Object, StateName)

diff --git a/Documentation/Core.Pathline.html b/Documentation/Core.Pathline.html index 2cd05a4cd..a30d05323 100644 --- a/Documentation/Core.Pathline.html +++ b/Documentation/Core.Pathline.html @@ -1824,6 +1824,24 @@ water depth.

Fields and Methods inherited from BASE Description + +

PATHLINE.ClassID

+ +

The ID number of the class.

+ + + +

PATHLINE.ClassName

+ +

The name of the class.

+ + + +

PATHLINE.ClassNameAndID

+ +

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

+ +

PATHLINE:ClearState(Object, StateName)

diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 417de9c2f..86d84f262 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -2964,6 +2964,24 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these Fields and Methods inherited from BASE Description + +

COORDINATE.ClassID

+ +

The ID number of the class.

+ + + +

COORDINATE.ClassName

+ +

The name of the class.

+ + + +

COORDINATE.ClassNameAndID

+ +

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

+ +

COORDINATE:ClearState(Object, StateName)

@@ -4744,6 +4762,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

POINT_VEC2.ClassID

+ +

The ID number of the class.

+ + + +

POINT_VEC2.ClassName

+ +

The name of the class.

+ + + +

POINT_VEC2.ClassNameAndID

+ +

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

+ +

POINT_VEC2:ClearState(Object, StateName)

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

the y coordinate in meters.

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

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -27752,17 +27766,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 66eb5c8d9..09d55a659 100644 --- a/Documentation/Core.Report.html +++ b/Documentation/Core.Report.html @@ -1729,6 +1729,24 @@ Fields and Methods inherited from BASE Description + +

REPORT.ClassID

+ +

The ID number of the class.

+ + + +

REPORT.ClassName

+ +

The name of the class.

+ + + +

REPORT.ClassNameAndID

+ +

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

+ +

REPORT:ClearState(Object, StateName)

diff --git a/Documentation/Core.ScheduleDispatcher.html b/Documentation/Core.ScheduleDispatcher.html index f630fb058..409da7edf 100644 --- a/Documentation/Core.ScheduleDispatcher.html +++ b/Documentation/Core.ScheduleDispatcher.html @@ -1762,6 +1762,24 @@ The Schedule() method returns the CallID that is the reference ID for each plann Fields and Methods inherited from BASE Description + +

SCHEDULEDISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

SCHEDULEDISPATCHER.ClassName

+ +

The name of the class.

+ + + +

SCHEDULEDISPATCHER.ClassNameAndID

+ +

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

+ +

SCHEDULEDISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/Core.Scheduler.html b/Documentation/Core.Scheduler.html index 30d8abfd7..1724de151 100644 --- a/Documentation/Core.Scheduler.html +++ b/Documentation/Core.Scheduler.html @@ -1914,6 +1914,24 @@ The schedule will stop after 300 seconds.

Fields and Methods inherited from BASE Description + +

SCHEDULER.ClassID

+ +

The ID number of the class.

+ + + +

SCHEDULER.ClassName

+ +

The name of the class.

+ + + +

SCHEDULER.ClassNameAndID

+ +

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

+ +

SCHEDULER:ClearState(Object, StateName)

diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index 58a09dc47..9f07c55ad 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -3242,6 +3242,24 @@ The following iterator methods are currently available within the SET_ZONE_GOAL: Fields and Methods inherited from BASE Description + +

SET_AIRBASE.ClassID

+ +

The ID number of the class.

+ + + +

SET_AIRBASE.ClassName

+ +

The name of the class.

+ + + +

SET_AIRBASE.ClassNameAndID

+ +

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

+ +

SET_AIRBASE:ClearState(Object, StateName)

@@ -4080,6 +4098,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_BASE.ClassID

+ +

The ID number of the class.

+ + + +

SET_BASE.ClassName

+ +

The name of the class.

+ + + +

SET_BASE.ClassNameAndID

+ +

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

+ +

SET_BASE:ClearState(Object, StateName)

@@ -5096,6 +5132,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_CARGO.ClassID

+ +

The ID number of the class.

+ + + +

SET_CARGO.ClassName

+ +

The name of the class.

+ + + +

SET_CARGO.ClassNameAndID

+ +

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

+ +

SET_CARGO:ClearState(Object, StateName)

@@ -6105,6 +6159,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_CLIENT.ClassID

+ +

The ID number of the class.

+ + + +

SET_CLIENT.ClassName

+ +

The name of the class.

+ + + +

SET_CLIENT.ClassNameAndID

+ +

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

+ +

SET_CLIENT:ClearState(Object, StateName)

@@ -7244,6 +7316,24 @@ mission designer to add a dedicated method

Fields and Methods inherited from BASE Description + +

SET_GROUP.ClassID

+ +

The ID number of the class.

+ + + +

SET_GROUP.ClassName

+ +

The name of the class.

+ + + +

SET_GROUP.ClassNameAndID

+ +

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

+ +

SET_GROUP:ClearState(Object, StateName)

@@ -8259,6 +8349,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_OPSGROUP.ClassID

+ +

The ID number of the class.

+ + + +

SET_OPSGROUP.ClassName

+ +

The name of the class.

+ + + +

SET_OPSGROUP.ClassNameAndID

+ +

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

+ +

SET_OPSGROUP:ClearState(Object, StateName)

@@ -9232,6 +9340,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_OPSZONE.ClassID

+ +

The ID number of the class.

+ + + +

SET_OPSZONE.ClassName

+ +

The name of the class.

+ + + +

SET_OPSZONE.ClassNameAndID

+ +

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

+ +

SET_OPSZONE:ClearState(Object, StateName)

@@ -10181,6 +10307,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_PLAYER.ClassID

+ +

The ID number of the class.

+ + + +

SET_PLAYER.ClassName

+ +

The name of the class.

+ + + +

SET_PLAYER.ClassNameAndID

+ +

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

+ +

SET_PLAYER:ClearState(Object, StateName)

@@ -11136,6 +11280,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_SCENERY.ClassID

+ +

The ID number of the class.

+ + + +

SET_SCENERY.ClassName

+ +

The name of the class.

+ + + +

SET_SCENERY.ClassNameAndID

+ +

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

+ +

SET_SCENERY:ClearState(Object, StateName)

@@ -12169,6 +12331,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_STATIC.ClassID

+ +

The ID number of the class.

+ + + +

SET_STATIC.ClassName

+ +

The name of the class.

+ + + +

SET_STATIC.ClassNameAndID

+ +

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

+ +

SET_STATIC:ClearState(Object, StateName)

@@ -13294,6 +13474,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_UNIT.ClassID

+ +

The ID number of the class.

+ + + +

SET_UNIT.ClassName

+ +

The name of the class.

+ + + +

SET_UNIT.ClassNameAndID

+ +

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

+ +

SET_UNIT:ClearState(Object, StateName)

@@ -14255,6 +14453,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_ZONE.ClassID

+ +

The ID number of the class.

+ + + +

SET_ZONE.ClassName

+ +

The name of the class.

+ + + +

SET_ZONE.ClassNameAndID

+ +

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

+ +

SET_ZONE:ClearState(Object, StateName)

@@ -15198,6 +15414,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SET_ZONE_GOAL.ClassID

+ +

The ID number of the class.

+ + + +

SET_ZONE_GOAL.ClassName

+ +

The name of the class.

+ + + +

SET_ZONE_GOAL.ClassNameAndID

+ +

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

+ +

SET_ZONE_GOAL:ClearState(Object, StateName)

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index fd10068a9..9878ae348 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2267,6 +2267,24 @@ Therefore, there are 4 era that are defined within the settings:

Fields and Methods inherited from BASE Description + +

SETTINGS.ClassID

+ +

The ID number of the class.

+ + + +

SETTINGS.ClassName

+ +

The name of the class.

+ + + +

SETTINGS.ClassNameAndID

+ +

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

+ +

SETTINGS:ClearState(Object, StateName)

@@ -2843,7 +2861,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + SETTINGS.A2GSystem @@ -2887,7 +2905,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SETTINGS.Metric @@ -5000,7 +5018,7 @@ It is advised to use this method at the start of the mission.

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

- #boolean + SETTINGS.Metric diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index b4cec791d..eb8d651fd 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2925,12 +2925,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.uncontrolled

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

Fields and Methods inherited from BASE Description + +

SPAWN.ClassID

+ +

The ID number of the class.

+ + + +

SPAWN.ClassName

+ +

The name of the class.

+ + + +

SPAWN.ClassNameAndID

+ +

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

+ +

SPAWN:ClearState(Object, StateName)

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

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

-
@@ -3723,17 +3732,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnInitFreq - - -
@@ -3789,6 +3787,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + #boolean +SPAWN.SpawnInitKeepUnitNames + + + + +

Overwrite unit names by default with group name.

+
@@ -3814,17 +3826,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -4138,17 +4139,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPAWN.uncontrolled - - -
@@ -9326,9 +9316,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- - -
-
- - -SPAWN.SpawnInitFreq - - -
@@ -9566,6 +9542,20 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

Overwrite unit names by default with group name.

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

- - -
-
- - #string -SPAWN.SpawnInitSkill - - -
@@ -9915,17 +9894,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- - -
-
- - -SPAWN.uncontrolled - - -
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index ab1988739..d9c973a66 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -2021,6 +2021,24 @@ such as position and heading.

Fields and Methods inherited from BASE Description + +

SPAWNSTATIC.ClassID

+ +

The ID number of the class.

+ + + +

SPAWNSTATIC.ClassName

+ +

The name of the class.

+ + + +

SPAWNSTATIC.ClassNameAndID

+ +

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

+ +

SPAWNSTATIC:ClearState(Object, StateName)

diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index 918d32421..ed1f8e82c 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2217,6 +2217,24 @@ Fields and Methods inherited from BASE Description + +

SPOT.ClassID

+ +

The ID number of the class.

+ + + +

SPOT.ClassName

+ +

The name of the class.

+ + + +

SPOT.ClassNameAndID

+ +

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

+ +

SPOT:ClearState(Object, StateName)

@@ -2794,39 +2812,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -4110,39 +4095,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -5665,39 +5617,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
diff --git a/Documentation/Core.TextAndSound.html b/Documentation/Core.TextAndSound.html index fe2e7b7d9..653e9066c 100644 --- a/Documentation/Core.TextAndSound.html +++ b/Documentation/Core.TextAndSound.html @@ -1750,6 +1750,24 @@ Fields and Methods inherited from BASE Description + +

TEXTANDSOUND.ClassID

+ +

The ID number of the class.

+ + + +

TEXTANDSOUND.ClassName

+ +

The name of the class.

+ + + +

TEXTANDSOUND.ClassNameAndID

+ +

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

+ +

TEXTANDSOUND:ClearState(Object, StateName)

diff --git a/Documentation/Core.Timer.html b/Documentation/Core.Timer.html index 6e3bb0617..b38e9bbc2 100644 --- a/Documentation/Core.Timer.html +++ b/Documentation/Core.Timer.html @@ -1892,6 +1892,24 @@ mytimer:Start(1.0, nil, 10) -- Does not make sense as the function is only calle Fields and Methods inherited from BASE Description + +

TIMER.ClassID

+ +

The ID number of the class.

+ + + +

TIMER.ClassName

+ +

The name of the class.

+ + + +

TIMER.ClassNameAndID

+ +

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

+ +

TIMER:ClearState(Object, StateName)

diff --git a/Documentation/Core.UserFlag.html b/Documentation/Core.UserFlag.html index 9915636b8..3300d5588 100644 --- a/Documentation/Core.UserFlag.html +++ b/Documentation/Core.UserFlag.html @@ -1714,6 +1714,24 @@ Fields and Methods inherited from BASE Description + +

USERFLAG.ClassID

+ +

The ID number of the class.

+ + + +

USERFLAG.ClassName

+ +

The name of the class.

+ + + +

USERFLAG.ClassNameAndID

+ +

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

+ +

USERFLAG:ClearState(Object, StateName)

diff --git a/Documentation/Core.Velocity.html b/Documentation/Core.Velocity.html index da164a94d..c556f7d0e 100644 --- a/Documentation/Core.Velocity.html +++ b/Documentation/Core.Velocity.html @@ -1769,6 +1769,24 @@ Fields and Methods inherited from BASE Description + +

VELOCITY.ClassID

+ +

The ID number of the class.

+ + + +

VELOCITY.ClassName

+ +

The name of the class.

+ + + +

VELOCITY.ClassNameAndID

+ +

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

+ +

VELOCITY:ClearState(Object, StateName)

@@ -2343,6 +2361,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

VELOCITY_POSITIONABLE.ClassID

+ +

The ID number of the class.

+ + + +

VELOCITY_POSITIONABLE.ClassName

+ +

The name of the class.

+ + + +

VELOCITY_POSITIONABLE.ClassNameAndID

+ +

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

+ +

VELOCITY_POSITIONABLE:ClearState(Object, StateName)

diff --git a/Documentation/Core.Zone.html b/Documentation/Core.Zone.html index 638b2ce21..4a3c7c9ed 100644 --- a/Documentation/Core.Zone.html +++ b/Documentation/Core.Zone.html @@ -2739,6 +2739,24 @@ This class is an abstract BASE class for derived classes, and is not meant to be Fields and Methods inherited from BASE Description + +

ZONE_BASE.ClassID

+ +

The ID number of the class.

+ + + +

ZONE_BASE.ClassName

+ +

The name of the class.

+ + + +

ZONE_BASE.ClassNameAndID

+ +

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

+ +

ZONE_BASE:ClearState(Object, StateName)

diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index fb1d75664..f75408af5 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -2484,6 +2484,24 @@ ATC_Ground = ATC_GROUND_PERSIANGULF:New( Fields and Methods inherited from BASE Description + +

ATC_GROUND.ClassID

+ +

The ID number of the class.

+ + + +

ATC_GROUND.ClassName

+ +

The name of the class.

+ + + +

ATC_GROUND.ClassNameAndID

+ +

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

+ +

ATC_GROUND:ClearState(Object, StateName)

@@ -3290,6 +3308,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

ATC_GROUND_UNIVERSAL.ClassID

+ +

The ID number of the class.

+ + + +

ATC_GROUND_UNIVERSAL.ClassName

+ +

The name of the class.

+ + + +

ATC_GROUND_UNIVERSAL.ClassNameAndID

+ +

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

+ +

ATC_GROUND_UNIVERSAL:ClearState(Object, StateName)

@@ -3829,7 +3865,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table ATC_GROUND.Airbases @@ -4411,7 +4447,7 @@ An airbase can be specified to set the maximum kick speed for.

- + #table ATC_GROUND.Airbases diff --git a/Documentation/Functional.Artillery.html b/Documentation/Functional.Artillery.html index 01b62432f..e2531f8b1 100644 --- a/Documentation/Functional.Artillery.html +++ b/Documentation/Functional.Artillery.html @@ -3856,6 +3856,24 @@ normandy:Start() Fields and Methods inherited from BASE Description + +

ARTY.ClassID

+ +

The ID number of the class.

+ + + +

ARTY.ClassName

+ +

The name of the class.

+ + + +

ARTY.ClassNameAndID

+ +

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

+ +

ARTY:ClearState(Object, StateName)

diff --git a/Documentation/Functional.CleanUp.html b/Documentation/Functional.CleanUp.html index be441076a..24bfd1dab 100644 --- a/Documentation/Functional.CleanUp.html +++ b/Documentation/Functional.CleanUp.html @@ -1780,6 +1780,24 @@ Note that this method will not allow anymore airbases to be attacked, so there i Fields and Methods inherited from BASE Description + +

CLEANUP_AIRBASE.__.ClassID

+ +

The ID number of the class.

+ + + +

CLEANUP_AIRBASE.__.ClassName

+ +

The name of the class.

+ + + +

CLEANUP_AIRBASE.__.ClassNameAndID

+ +

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

+ +

CLEANUP_AIRBASE.__:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index cd0bf2375..67b5595ed 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2934,6 +2934,24 @@ Use the method DESIGNATE.SetMission() to Fields and Methods inherited from BASE Description + +

DESIGNATE.ClassID

+ +

The ID number of the class.

+ + + +

DESIGNATE.ClassName

+ +

The name of the class.

+ + + +

DESIGNATE.ClassNameAndID

+ +

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

+ +

DESIGNATE:ClearState(Object, StateName)

@@ -3533,17 +3551,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -6708,17 +6715,6 @@ Using the menu system, the player can "forget" a designation, so that gradually -
- -
-
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -7518,17 +7514,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -8298,17 +8283,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
@@ -9966,17 +9940,6 @@ Using the menu system, the player can "forget" a designation, so that gradually - - - -
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 081f49166..4f2050db8 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -3206,6 +3206,24 @@ The different values of Unit.Category can be:

Fields and Methods inherited from BASE Description + +

DETECTION_AREAS.ClassID

+ +

The ID number of the class.

+ + + +

DETECTION_AREAS.ClassName

+ +

The name of the class.

+ + + +

DETECTION_AREAS.ClassNameAndID

+ +

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

+ +

DETECTION_AREAS:ClearState(Object, StateName)

@@ -4772,6 +4790,24 @@ The different values of Unit.Category can be:

Fields and Methods inherited from BASE Description + +

DETECTION_BASE.ClassID

+ +

The ID number of the class.

+ + + +

DETECTION_BASE.ClassName

+ +

The name of the class.

+ + + +

DETECTION_BASE.ClassNameAndID

+ +

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

+ +

DETECTION_BASE:ClearState(Object, StateName)

@@ -6655,6 +6691,24 @@ The different values of Unit.Category can be:

Fields and Methods inherited from BASE Description + +

DETECTION_TYPES.ClassID

+ +

The ID number of the class.

+ + + +

DETECTION_TYPES.ClassName

+ +

The name of the class.

+ + + +

DETECTION_TYPES.ClassNameAndID

+ +

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

+ +

DETECTION_TYPES:ClearState(Object, StateName)

@@ -8296,6 +8350,24 @@ The different values of Unit.Category can be:

Fields and Methods inherited from BASE Description + +

DETECTION_UNITS.ClassID

+ +

The ID number of the class.

+ + + +

DETECTION_UNITS.ClassName

+ +

The name of the class.

+ + + +

DETECTION_UNITS.ClassNameAndID

+ +

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

+ +

DETECTION_UNITS:ClearState(Object, StateName)

@@ -19062,28 +19134,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -19233,7 +19283,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
- #number + DETECTION_BASE.RefreshTimeInterval @@ -23765,28 +23815,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -23936,7 +23964,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
- #number + DETECTION_BASE.RefreshTimeInterval @@ -25529,28 +25557,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -25700,7 +25706,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 31b04d6f2..e5bb22f48 100644 --- a/Documentation/Functional.DetectionZones.html +++ b/Documentation/Functional.DetectionZones.html @@ -2904,6 +2904,24 @@ The different values of Unit.Category can be:

Fields and Methods inherited from BASE Description + +

DETECTION_ZONES.ClassID

+ +

The ID number of the class.

+ + + +

DETECTION_ZONES.ClassName

+ +

The name of the class.

+ + + +

DETECTION_ZONES.ClassNameAndID

+ +

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

+ +

DETECTION_ZONES:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Escort.html b/Documentation/Functional.Escort.html index bdf9d90d7..43dd77cc6 100644 --- a/Documentation/Functional.Escort.html +++ b/Documentation/Functional.Escort.html @@ -1816,6 +1816,7 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the

Type ESCORT

ESCORT +, extends Core.Base#BASE
@@ -2072,7 +2073,7 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the @@ -2090,7 +2091,19 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the + + + + + + + + @@ -2181,12 +2194,24 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the + + + + + + + + @@ -2289,6 +2314,542 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the + +

ESCORT.EscortMode

 - +

The mode the escort is in.

ESCORT.FollowDistance

 - +

The current follow distance.

+

ESCORT.FollowScheduler

 +

The instance of the SCHEDULER class.

+

ESCORT.FunctionalMENU_GROUPDETECTION_BASE

 +

Detection

ESCORT:New(EscortClient, EscortGroup, EscortName, EscortBriefing)

ESCORT class constructor for an AI group

+

ESCORT.OptionReactionOnThreat

 +

Which REACTION_ON_THREAT is set to the EscortGroup.

ESCORT:RegisterRoute()

Registers the waypoints

+

ESCORT.ReportTargets

 +

If true, nearby targets are reported.

ESCORT:_SwitchReportNearbyTargets(ReportTargets)

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

ESCORT.ClassID

 +

The ID number of the class.

+

ESCORT.ClassName

 +

The name of the class.

+

ESCORT.ClassNameAndID

 +

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

+

ESCORT:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

ESCORT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

ESCORT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

ESCORT:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

ESCORT:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

ESCORT:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

ESCORT:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

ESCORT:E(Arguments)

 +

Log an exception which will be traced always.

+

ESCORT:EventDispatcher()

 +

Returns the event dispatcher

+

ESCORT:EventRemoveAll()

 +

Remove all subscribed events

+

ESCORT:F(Arguments)

 +

Trace a function call.

+

ESCORT:F2(Arguments)

 +

Trace a function call level 2.

+

ESCORT:F3(Arguments)

 +

Trace a function call level 3.

+

ESCORT:GetClassID()

 +

Get the ClassID of the class instance.

+

ESCORT:GetClassName()

 +

Get the ClassName of the class instance.

+

ESCORT:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

ESCORT:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

ESCORT:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

ESCORT:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

ESCORT:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

ESCORT:I(Arguments)

 +

Log an information which will be traced always.

+

ESCORT:Inherit(Child, Parent)

 +

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

+

ESCORT:IsInstanceOf(ClassName)

 +

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

+

ESCORT:IsTrace()

 +

Enquires if tracing is on (for the class).

+

ESCORT:New()

 +

BASE constructor.

+

ESCORT:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

ESCORT:OnEventBDA(EventData)

 +

BDA.

+

ESCORT:OnEventBaseCaptured(EventData)

 +

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

+

ESCORT:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

ESCORT:OnEventCrash(EventData)

 +

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

+

ESCORT:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

ESCORT:OnEventDetailedFailure(EventData)

 +

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

+

ESCORT:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

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

+

ESCORT:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

ESCORT:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

ESCORT:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

ESCORT:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

ESCORT:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

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

+

ESCORT:OnEventLandingAfterEjection(EventData)

 +

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

+

ESCORT:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

ESCORT:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

ESCORT:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

ESCORT:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

ESCORT:OnEventMissionEnd(EventData)

 +

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

+

ESCORT:OnEventMissionStart(EventData)

 +

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

+

ESCORT:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

ESCORT:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

ESCORT:OnEventPlayerEnterAircraft(EventData)

 +

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

+

ESCORT:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

ESCORT:OnEventPlayerLeaveUnit(EventData)

 +

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

+

ESCORT:OnEventRefueling(EventData)

 +

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

+

ESCORT:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

ESCORT:OnEventScore(EventData)

 +

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

+

ESCORT:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

ESCORT:OnEventShootingStart(EventData)

 +

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

+

ESCORT:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

ESCORT:OnEventTakeoff(EventData)

 +

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

+

ESCORT:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

ESCORT:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

ESCORT:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

ESCORT.Scheduler

 + +

ESCORT:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

ESCORT:SetState(Object, Key, Value)

 +

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

+

ESCORT:T(Arguments)

 +

Trace a function logic level 1.

+

ESCORT:T2(Arguments)

 +

Trace a function logic level 2.

+

ESCORT:T3(Arguments)

 +

Trace a function logic level 3.

+

ESCORT:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

ESCORT:TraceClass(Class)

 +

Set tracing for a class

+

ESCORT:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

ESCORT:TraceLevel(Level)

 +

Set trace level

+

ESCORT:TraceOff()

 +

Set trace off.

+

ESCORT:TraceOn()

 +

Set trace on.

+

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

+

ESCORT:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

ESCORT._

 + +

ESCORT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

ESCORT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

ESCORT.__

 + +

ESCORT:onEvent(event)

 +

The main event handling function...
@@ -2841,10 +3402,10 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the
- + #ESCORT.MODE ESCORT.EscortMode - +

The mode the escort is in.

@@ -2852,7 +3413,7 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the
- + #string ESCORT.EscortName @@ -2877,7 +3438,18 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the #number ESCORT.FollowDistance +

The current follow distance.

+
+ +
+
+
+ + Core.Scheduler#SCHEDULER +ESCORT.FollowScheduler + +

The instance of the SCHEDULER class.

@@ -2890,6 +3462,28 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the +
+ +
+
+
+ + DCS#AI.Option.Air.val.REACTION_ON_THREAT +ESCORT.OptionReactionOnThreat + +

Which REACTION_ON_THREAT is set to the EscortGroup.

+ +
+ +
+
+
+ + #boolean +ESCORT.ReportTargets + +

If true, nearby targets are reported.

+
@@ -4230,6 +4824,3917 @@ EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the
+
+

Field(s)

+
+
+
+ + #number +ESCORT.CT1 + + + +
+ +
+
+
+ + +ESCORT.Detection + + + +
+ +
+
+
+ + +ESCORT.EscortBriefing + + + +
+ +
+
+
+ + Wrapper.Client#CLIENT +ESCORT.EscortClient + + + +
+ +
+
+
+ + Wrapper.Group#GROUP +ESCORT.EscortGroup + + + +
+ +
+
+
+ + +ESCORT.EscortMenu + + + +
+ +
+
+
+ + +ESCORT.EscortMenuAttackNearbyTargets + + + + +

Attack Targets

+ +
+ +
+
+
+ + +ESCORT.EscortMenuEvasion + + + + +

Reaction to Threats

+ +
+ +
+
+
+ + +ESCORT.EscortMenuEvasionEvadeFire + + + +
+ +
+
+
+ + +ESCORT.EscortMenuEvasionNoReaction + + + +
+ +
+
+
+ + +ESCORT.EscortMenuEvasionPassiveDefense + + + +
+ +
+
+
+ + +ESCORT.EscortMenuFlare + + + +
+ +
+
+
+ + +ESCORT.EscortMenuFlareGreen + + + +
+ +
+
+
+ + +ESCORT.EscortMenuFlareRed + + + +
+ +
+
+
+ + +ESCORT.EscortMenuFlareWhite + + + +
+ +
+
+
+ + +ESCORT.EscortMenuFlareYellow + + + +
+ +
+
+
+ + +ESCORT.EscortMenuHold + + + +
+ +
+
+
+ + #table +ESCORT.EscortMenuHoldAtLeaderPosition + + + +
+ +
+
+
+ + #table +ESCORT.EscortMenuHoldPosition + + + +
+ +
+
+
+ + #table +ESCORT.EscortMenuJoinUpAndFollow + + + +
+ +
+
+
+ + +ESCORT.EscortMenuOptionEvasionVertical + + + +
+ +
+
+
+ + +ESCORT.EscortMenuROE + + + + +

Rules of Engagement

+ +
+ +
+
+
+ + +ESCORT.EscortMenuROEHoldFire + + + +
+ +
+
+
+ + +ESCORT.EscortMenuROEOpenFire + + + +
+ +
+
+
+ + +ESCORT.EscortMenuROEReturnFire + + + +
+ +
+
+
+ + +ESCORT.EscortMenuROEWeaponFree + + + +
+ +
+
+
+ + +ESCORT.EscortMenuReportNavigation + + + +
+ +
+
+
+ + +ESCORT.EscortMenuReportNearbyTargets + + + +
+ +
+
+
+ + +ESCORT.EscortMenuReportNearbyTargetsNow + + + + +

Report Targets

+ +
+ +
+
+
+ + +ESCORT.EscortMenuReportNearbyTargetsOff + + + +
+ +
+
+
+ + +ESCORT.EscortMenuReportNearbyTargetsOn + + + +
+ +
+
+
+ + +ESCORT.EscortMenuResumeMission + + + + +

Mission Resume Menu Root

+ +
+ +
+
+
+ + +ESCORT.EscortMenuScan + + + +
+ +
+
+
+ + #table +ESCORT.EscortMenuScanForTargets + + + +
+ +
+
+
+ + +ESCORT.EscortMenuSmoke + + + +
+ +
+
+
+ + +ESCORT.EscortMenuSmokeBlue + + + +
+ +
+
+
+ + +ESCORT.EscortMenuSmokeGreen + + + +
+ +
+
+
+ + +ESCORT.EscortMenuSmokeOrange + + + +
+ +
+
+
+ + +ESCORT.EscortMenuSmokeRed + + + +
+ +
+
+
+ + +ESCORT.EscortMenuSmokeWhite + + + +
+ +
+
+
+ + +ESCORT.EscortMenuTargetAssistance + + + + +

Request assistance from other escorts. + This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...

+ +
+ +
+
+
+ + #ESCORT.MODE +ESCORT.EscortMode + +

The mode the escort is in.

+ +
+ +
+
+
+ + #string +ESCORT.EscortName + + + +
+ +
+
+
+ + +ESCORT.EscortSetGroup + + + +
+ +
+
+
+ + #number +ESCORT.FollowDistance + +

The current follow distance.

+ +
+ +
+
+
+ + Core.Scheduler#SCHEDULER +ESCORT.FollowScheduler + +

The instance of the SCHEDULER class.

+ +
+ +
+
+
+ + #number +ESCORT.GT1 + + + +
+ +
+
+
+ + DCS#AI.Option.Air.val.REACTION_ON_THREAT +ESCORT.OptionReactionOnThreat + +

Which REACTION_ON_THREAT is set to the EscortGroup.

+ +
+ +
+
+
+ + #boolean +ESCORT.ReportTargets + +

If true, nearby targets are reported.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

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

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

ESCORT: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

ESCORT: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

ESCORT: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

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

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

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

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

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

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

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

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

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

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

ESCORT:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

ESCORT:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

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

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

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

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

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

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

ESCORT:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

ESCORT:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

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

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

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

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

ESCORT: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:

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

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

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

ESCORT: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:

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

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

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

ESCORT: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

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

ESCORT: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:

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

ESCORT:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

ESCORT: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:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ESCORT: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

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

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

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

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

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

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

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

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

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

ESCORT:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

ESCORT:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

ESCORT:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

ESCORT:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

ESCORT:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

ESCORT:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

ESCORT: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 )
+
+ +
+ +
+
+ +
+ +
+

ESCORT:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

ESCORT:_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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

ESCORT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

ESCORT: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/Functional.Fox.html b/Documentation/Functional.Fox.html index 4f9f82e90..8d03efa07 100644 --- a/Documentation/Functional.Fox.html +++ b/Documentation/Functional.Fox.html @@ -2576,6 +2576,24 @@ fox:Start() Fields and Methods inherited from BASE Description + +

FOX.ClassID

+ +

The ID number of the class.

+ + + +

FOX.ClassName

+ +

The name of the class.

+ + + +

FOX.ClassNameAndID

+ +

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

+ +

FOX:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 813b78a80..ea923bf35 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2011,6 +2011,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

+ + @@ -2723,6 +2729,24 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75% Fields and Methods inherited from BASE Description + +

MANTIS.ClassID

+ +

The ID number of the class.

+ + + +

MANTIS.ClassName

+ +

The name of the class.

+ + + +

MANTIS.ClassNameAndID

+ +

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

+ +

MANTIS:ClearState(Object, StateName)

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

The #DETECTION_AREAS object for AWACS

- - - -
-
- - #table -MANTIS.AcceptZones - - -
@@ -3923,17 +3936,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #table -MANTIS.ConflictZones - - -
@@ -4000,6 +4002,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +MANTIS.Groupset + + +
@@ -4022,17 +4035,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The ME name of the HQ object

- - - -
-
- - #table -MANTIS.RejectZones - - -
@@ -4061,7 +4063,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Long @@ -4072,7 +4074,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Medium @@ -4083,7 +4085,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table MANTIS.SAM_Table_Short @@ -4529,9 +4531,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

self.SAMCheckRanges = {}

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

The #DETECTION_AREAS object for AWACS

-
- -
-
-
- - #table -MANTIS.AcceptZones - - -
@@ -8455,17 +8443,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` -
- -
-
-
- - #table -MANTIS.ConflictZones - - -
@@ -8532,6 +8509,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + + + +
+
+ + +MANTIS.Groupset + + +
@@ -8554,17 +8542,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

The ME name of the HQ object

- - - -
-
- - #table -MANTIS.RejectZones - - -
@@ -8593,7 +8570,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Long @@ -8604,7 +8581,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Medium @@ -8615,7 +8592,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- + #table MANTIS.SAM_Table_Short @@ -9061,9 +9038,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` - -

self.SAMCheckRanges = {}

-
diff --git a/Documentation/Functional.MissileTrainer.html b/Documentation/Functional.MissileTrainer.html index afa02afc8..fb1a83281 100644 --- a/Documentation/Functional.MissileTrainer.html +++ b/Documentation/Functional.MissileTrainer.html @@ -1754,6 +1754,7 @@ Therefore, this class is considered to be deprecated and superseded by the

Type MISSILETRAINER

MISSILETRAINER +, extends Core.Base#BASE
@@ -1777,6 +1778,12 @@ Therefore, this class is considered to be deprecated and superseded by the

MISSILETRAINER.AlertsToAll

+ + + + @@ -1921,6 +1928,542 @@ Therefore, this class is considered to be deprecated and superseded by the

MISSILETRAINER:_TrackMissiles()

+ +
+

MISSILETRAINER.DBClients

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

MISSILETRAINER.ClassID

 +

The ID number of the class.

+

MISSILETRAINER.ClassName

 +

The name of the class.

+

MISSILETRAINER.ClassNameAndID

 +

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

+

MISSILETRAINER:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

MISSILETRAINER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

MISSILETRAINER:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

MISSILETRAINER:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

MISSILETRAINER:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

MISSILETRAINER:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

MISSILETRAINER:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

MISSILETRAINER:E(Arguments)

 +

Log an exception which will be traced always.

+

MISSILETRAINER:EventDispatcher()

 +

Returns the event dispatcher

+

MISSILETRAINER:EventRemoveAll()

 +

Remove all subscribed events

+

MISSILETRAINER:F(Arguments)

 +

Trace a function call.

+

MISSILETRAINER:F2(Arguments)

 +

Trace a function call level 2.

+

MISSILETRAINER:F3(Arguments)

 +

Trace a function call level 3.

+

MISSILETRAINER:GetClassID()

 +

Get the ClassID of the class instance.

+

MISSILETRAINER:GetClassName()

 +

Get the ClassName of the class instance.

+

MISSILETRAINER:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

MISSILETRAINER:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

MISSILETRAINER:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

MISSILETRAINER:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

MISSILETRAINER:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

MISSILETRAINER:I(Arguments)

 +

Log an information which will be traced always.

+

MISSILETRAINER:Inherit(Child, Parent)

 +

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

+

MISSILETRAINER:IsInstanceOf(ClassName)

 +

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

+

MISSILETRAINER:IsTrace()

 +

Enquires if tracing is on (for the class).

+

MISSILETRAINER:New()

 +

BASE constructor.

+

MISSILETRAINER:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

MISSILETRAINER:OnEventBDA(EventData)

 +

BDA.

+

MISSILETRAINER:OnEventBaseCaptured(EventData)

 +

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

+

MISSILETRAINER:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

MISSILETRAINER:OnEventCrash(EventData)

 +

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

+

MISSILETRAINER:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

MISSILETRAINER:OnEventDetailedFailure(EventData)

 +

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

+

MISSILETRAINER:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

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

+

MISSILETRAINER:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

MISSILETRAINER:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

MISSILETRAINER:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

MISSILETRAINER:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

MISSILETRAINER:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

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

+

MISSILETRAINER:OnEventLandingAfterEjection(EventData)

 +

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

+

MISSILETRAINER:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

MISSILETRAINER:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

MISSILETRAINER:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

MISSILETRAINER:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

MISSILETRAINER:OnEventMissionEnd(EventData)

 +

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

+

MISSILETRAINER:OnEventMissionStart(EventData)

 +

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

+

MISSILETRAINER:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

MISSILETRAINER:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

MISSILETRAINER:OnEventPlayerEnterAircraft(EventData)

 +

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

+

MISSILETRAINER:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

MISSILETRAINER:OnEventPlayerLeaveUnit(EventData)

 +

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

+

MISSILETRAINER:OnEventRefueling(EventData)

 +

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

+

MISSILETRAINER:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

MISSILETRAINER:OnEventScore(EventData)

 +

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

+

MISSILETRAINER:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

MISSILETRAINER:OnEventShootingStart(EventData)

 +

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

+

MISSILETRAINER:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

MISSILETRAINER:OnEventTakeoff(EventData)

 +

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

+

MISSILETRAINER:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

MISSILETRAINER:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

MISSILETRAINER:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

MISSILETRAINER.Scheduler

 + +

MISSILETRAINER:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

MISSILETRAINER:SetState(Object, Key, Value)

 +

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

+

MISSILETRAINER:T(Arguments)

 +

Trace a function logic level 1.

+

MISSILETRAINER:T2(Arguments)

 +

Trace a function logic level 2.

+

MISSILETRAINER:T3(Arguments)

 +

Trace a function logic level 3.

+

MISSILETRAINER:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

MISSILETRAINER:TraceClass(Class)

 +

Set tracing for a class

+

MISSILETRAINER:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

MISSILETRAINER:TraceLevel(Level)

 +

Set trace level

+

MISSILETRAINER:TraceOff()

 +

Set trace off.

+

MISSILETRAINER:TraceOn()

 +

Set trace on.

+

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

+

MISSILETRAINER:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

MISSILETRAINER._

 + +

MISSILETRAINER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

MISSILETRAINER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

MISSILETRAINER.__

 + +

MISSILETRAINER:onEvent(event)

 +

The main event handling function...
@@ -1968,6 +2511,17 @@ Therefore, this class is considered to be deprecated and superseded by the + +
+
+
+ + Core.Set#SET_CLIENT +MISSILETRAINER.DBClients + + +
@@ -2756,6 +3310,3469 @@ Therefore, this class is considered to be deprecated and superseded by the
+
+

Field(s)

+
+
+
+ + +MISSILETRAINER.AlertsHitsOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.AlertsLaunchesOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.AlertsToAll + + + +
+ +
+
+
+ + Core.Set#SET_CLIENT +MISSILETRAINER.DBClients + + + +
+ +
+
+
+ + +MISSILETRAINER.DetailsBearingOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.DetailsRangeOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.MenusOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.MessagesOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.TrackingOnOff + + + +
+ +
+
+
+ + +MISSILETRAINER.TrackingToAll + + + +
+ +
+
+

Function(s)

+
+
+ +
+

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

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

MISSILETRAINER: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MISSILETRAINER: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MISSILETRAINER: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

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

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

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

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

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

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

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

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

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

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

MISSILETRAINER:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

MISSILETRAINER:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

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

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

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

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

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

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

MISSILETRAINER:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

MISSILETRAINER:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

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

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

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

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

MISSILETRAINER: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:

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

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

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

MISSILETRAINER: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:

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

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

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

MISSILETRAINER: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

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

MISSILETRAINER: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:

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

MISSILETRAINER:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

MISSILETRAINER: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:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MISSILETRAINER: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

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

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

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

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

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

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

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

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

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

MISSILETRAINER:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

MISSILETRAINER:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

MISSILETRAINER:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

MISSILETRAINER:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MISSILETRAINER:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

MISSILETRAINER:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

MISSILETRAINER: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 )
+
+ +
+ +
+
+ +
+ +
+

MISSILETRAINER:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

MISSILETRAINER:_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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MISSILETRAINER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MISSILETRAINER: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/Functional.Movement.html b/Documentation/Functional.Movement.html index 8c96cb5ee..a8c9e3c32 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -1640,6 +1640,7 @@ on defined intervals (currently every minute).

Type MOVEMENT

MOVEMENT +, extends Core.Base#BASE
@@ -1711,6 +1712,542 @@ on defined intervals (currently every minute).

+ +

MOVEMENT:_Scheduler()

This function is called automatically by the MOVEMENT scheduler.

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

MOVEMENT.ClassID

 +

The ID number of the class.

+

MOVEMENT.ClassName

 +

The name of the class.

+

MOVEMENT.ClassNameAndID

 +

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

+

MOVEMENT:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

MOVEMENT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

MOVEMENT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

MOVEMENT:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

MOVEMENT:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

MOVEMENT:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

MOVEMENT:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

MOVEMENT:E(Arguments)

 +

Log an exception which will be traced always.

+

MOVEMENT:EventDispatcher()

 +

Returns the event dispatcher

+

MOVEMENT:EventRemoveAll()

 +

Remove all subscribed events

+

MOVEMENT:F(Arguments)

 +

Trace a function call.

+

MOVEMENT:F2(Arguments)

 +

Trace a function call level 2.

+

MOVEMENT:F3(Arguments)

 +

Trace a function call level 3.

+

MOVEMENT:GetClassID()

 +

Get the ClassID of the class instance.

+

MOVEMENT:GetClassName()

 +

Get the ClassName of the class instance.

+

MOVEMENT:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

MOVEMENT:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

MOVEMENT:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

MOVEMENT:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

MOVEMENT:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

MOVEMENT:I(Arguments)

 +

Log an information which will be traced always.

+

MOVEMENT:Inherit(Child, Parent)

 +

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

+

MOVEMENT:IsInstanceOf(ClassName)

 +

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

+

MOVEMENT:IsTrace()

 +

Enquires if tracing is on (for the class).

+

MOVEMENT:New()

 +

BASE constructor.

+

MOVEMENT:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

MOVEMENT:OnEventBDA(EventData)

 +

BDA.

+

MOVEMENT:OnEventBaseCaptured(EventData)

 +

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

+

MOVEMENT:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

MOVEMENT:OnEventCrash(EventData)

 +

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

+

MOVEMENT:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

MOVEMENT:OnEventDetailedFailure(EventData)

 +

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

+

MOVEMENT:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

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

+

MOVEMENT:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

MOVEMENT:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

MOVEMENT:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

MOVEMENT:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

MOVEMENT:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

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

+

MOVEMENT:OnEventLandingAfterEjection(EventData)

 +

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

+

MOVEMENT:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

MOVEMENT:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

MOVEMENT:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

MOVEMENT:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

MOVEMENT:OnEventMissionEnd(EventData)

 +

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

+

MOVEMENT:OnEventMissionStart(EventData)

 +

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

+

MOVEMENT:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

MOVEMENT:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

MOVEMENT:OnEventPlayerEnterAircraft(EventData)

 +

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

+

MOVEMENT:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

MOVEMENT:OnEventPlayerLeaveUnit(EventData)

 +

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

+

MOVEMENT:OnEventRefueling(EventData)

 +

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

+

MOVEMENT:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

MOVEMENT:OnEventScore(EventData)

 +

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

+

MOVEMENT:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

MOVEMENT:OnEventShootingStart(EventData)

 +

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

+

MOVEMENT:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

MOVEMENT:OnEventTakeoff(EventData)

 +

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

+

MOVEMENT:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

MOVEMENT:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

MOVEMENT:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

MOVEMENT.Scheduler

 + +

MOVEMENT:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

MOVEMENT:SetState(Object, Key, Value)

 +

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

+

MOVEMENT:T(Arguments)

 +

Trace a function logic level 1.

+

MOVEMENT:T2(Arguments)

 +

Trace a function logic level 2.

+

MOVEMENT:T3(Arguments)

 +

Trace a function logic level 3.

+

MOVEMENT:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

MOVEMENT:TraceClass(Class)

 +

Set tracing for a class

+

MOVEMENT:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

MOVEMENT:TraceLevel(Level)

 +

Set trace level

+

MOVEMENT:TraceOff()

 +

Set trace off.

+

MOVEMENT:TraceOn()

 +

Set trace on.

+

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

+

MOVEMENT:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

MOVEMENT._

 + +

MOVEMENT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

MOVEMENT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

MOVEMENT.__

 + +

MOVEMENT:onEvent(event)

 +

The main event handling function...
@@ -1728,20 +2265,6 @@ on defined intervals (currently every minute).

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive.

- -
- -
@@ -1969,6 +2492,3412 @@ on defined intervals (currently every minute).

+
+

Field(s)

+
+
+
+ + #number +MOVEMENT.MoveCount + + + + +

The internal counter of the amount of Moving the has happened since MoveStart.

+ +
+ +
+
+
+ + +MOVEMENT.MoveMaximum + + + + +

Contains the Maximum amount of units that are allowed to move.

+ +
+ +
+
+
+ + +MOVEMENT.MovePrefixes + + + +
+ +
+
+
+ + #table +MOVEMENT.MoveUnits + + + + +

Reflects if the Moving for this MovePrefixes is going to be scheduled or not.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

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

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

MOVEMENT: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MOVEMENT: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MOVEMENT: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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

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

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

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

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

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

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

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

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

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

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

MOVEMENT:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

MOVEMENT:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

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

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

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

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

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

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

MOVEMENT:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

MOVEMENT:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

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

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

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

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

MOVEMENT: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:

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

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

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

MOVEMENT: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:

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

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

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

MOVEMENT: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

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

MOVEMENT: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:

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

MOVEMENT:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

MOVEMENT: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:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MOVEMENT: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

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

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

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

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

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

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

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

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

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

MOVEMENT:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

MOVEMENT:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

MOVEMENT:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

MOVEMENT:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MOVEMENT:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing Off
+BASE:TraceOff()
+ +
+ +
+
+ +
+ +
+

MOVEMENT:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

+ 
-- Switch the tracing On
+BASE:TraceOn()
+ +
+ +
+
+ +
+ +
+

MOVEMENT: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 )
+
+ +
+ +
+
+ +
+ +
+

MOVEMENT:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

MOVEMENT:_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 +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MOVEMENT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

MOVEMENT: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/Functional.PseudoATC.html b/Documentation/Functional.PseudoATC.html index f549e6386..3ea6fd1db 100644 --- a/Documentation/Functional.PseudoATC.html +++ b/Documentation/Functional.PseudoATC.html @@ -1987,6 +1987,24 @@ pseudoATC:Start() Fields and Methods inherited from BASE Description + +

PSEUDOATC.ClassID

+ +

The ID number of the class.

+ + + +

PSEUDOATC.ClassName

+ +

The name of the class.

+ + + +

PSEUDOATC.ClassNameAndID

+ +

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

+ +

PSEUDOATC:ClearState(Object, StateName)

diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index b140e0593..52854b76e 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -4501,12 +4501,6 @@ and any spaces before and after the resulting name are removed.

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

- - - -

RAT.uncontrolled

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

Fields and Methods inherited from BASE Description + +

RAT.ClassID

+ +

The ID number of the class.

+ + + +

RAT.ClassName

+ +

The name of the class.

+ + + +

RAT.ClassNameAndID

+ +

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

+ +

RAT:ClearState(Object, StateName)

@@ -5199,6 +5211,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

RATMANAGER.ClassID

+ +

The ID number of the class.

+ + + +

RATMANAGER.ClassName

+ +

The name of the class.

+ + + +

RATMANAGER.ClassNameAndID

+ +

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

+ +

RATMANAGER:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Range.html b/Documentation/Functional.Range.html index ae2def7e6..93e7fabdd 100644 --- a/Documentation/Functional.Range.html +++ b/Documentation/Functional.Range.html @@ -3243,6 +3243,24 @@ The could avoid the lua garbage collection to accidentally/falsely deallocate th Fields and Methods inherited from BASE Description + +

RANGE.ClassID

+ +

The ID number of the class.

+ + + +

RANGE.ClassName

+ +

The name of the class.

+ + + +

RANGE.ClassNameAndID

+ +

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

+ +

RANGE:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Scoring.html b/Documentation/Functional.Scoring.html index b59b5dd9c..d02b8709f 100644 --- a/Documentation/Functional.Scoring.html +++ b/Documentation/Functional.Scoring.html @@ -2317,6 +2317,24 @@ Various methods exist to configure:

Fields and Methods inherited from BASE Description + +

SCORING.ClassID

+ +

The ID number of the class.

+ + + +

SCORING.ClassName

+ +

The name of the class.

+ + + +

SCORING.ClassNameAndID

+ +

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

+ +

SCORING:ClearState(Object, StateName)

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

Create the CSV file.

+
@@ -3032,7 +3053,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyoncoalitionchange @@ -3043,7 +3064,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SCORING.penaltyonfratricide @@ -5431,11 +5452,14 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.AutoSave + +

Create the CSV file.

+
@@ -5618,7 +5642,7 @@ The scale magnifies the scores given to the players.

- + #boolean SCORING.penaltyoncoalitionchange @@ -5629,7 +5653,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 c51709a9a..69779acfa 100644 --- a/Documentation/Functional.Sead.html +++ b/Documentation/Functional.Sead.html @@ -1798,6 +1798,24 @@ period of time to stay defensive, before it takes evasive actions.

Fields and Methods inherited from BASE Description + +

SEAD.ClassID

+ +

The ID number of the class.

+ + + +

SEAD.ClassName

+ +

The name of the class.

+ + + +

SEAD.ClassNameAndID

+ +

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

+ +

SEAD:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Shorad.html b/Documentation/Functional.Shorad.html index c1f64d996..a1e1adef6 100644 --- a/Documentation/Functional.Shorad.html +++ b/Documentation/Functional.Shorad.html @@ -1945,6 +1945,24 @@ When a missile is detected, SHORAD will activate defense groups in the given rad Fields and Methods inherited from BASE Description + +

SHORAD.ClassID

+ +

The ID number of the class.

+ + + +

SHORAD.ClassName

+ +

The name of the class.

+ + + +

SHORAD.ClassNameAndID

+ +

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

+ +

SHORAD:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Suppression.html b/Documentation/Functional.Suppression.html index f070ad41a..db195b2fa 100644 --- a/Documentation/Functional.Suppression.html +++ b/Documentation/Functional.Suppression.html @@ -3012,6 +3012,24 @@ If no scenery object is near the group the TakeCover event is r Fields and Methods inherited from BASE Description + +

SUPPRESSION.ClassID

+ +

The ID number of the class.

+ + + +

SUPPRESSION.ClassName

+ +

The name of the class.

+ + + +

SUPPRESSION.ClassNameAndID

+ +

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

+ +

SUPPRESSION:ClearState(Object, StateName)

diff --git a/Documentation/Functional.Warehouse.html b/Documentation/Functional.Warehouse.html index d655d990b..310a99222 100644 --- a/Documentation/Functional.Warehouse.html +++ b/Documentation/Functional.Warehouse.html @@ -5289,6 +5289,24 @@ end Fields and Methods inherited from BASE Description + +

WAREHOUSE.ClassID

+ +

The ID number of the class.

+ + + +

WAREHOUSE.ClassName

+ +

The name of the class.

+ + + +

WAREHOUSE.ClassNameAndID

+ +

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

+ +

WAREHOUSE:ClearState(Object, StateName)

diff --git a/Documentation/Ops.ATIS.html b/Documentation/Ops.ATIS.html index 71c96ca28..55382f224 100644 --- a/Documentation/Ops.ATIS.html +++ b/Documentation/Ops.ATIS.html @@ -2916,6 +2916,24 @@ atis:Start() Fields and Methods inherited from BASE Description + +

ATIS.ClassID

+ +

The ID number of the class.

+ + + +

ATIS.ClassName

+ +

The name of the class.

+ + + +

ATIS.ClassNameAndID

+ +

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

+ +

ATIS:ClearState(Object, StateName)

diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index cfa2b0de2..46e9fe449 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -6243,6 +6243,24 @@ If enabled, status and debug text messages will be displayed on the screen. Also Fields and Methods inherited from BASE Description + +

AIRBOSS.ClassID

+ +

The ID number of the class.

+ + + +

AIRBOSS.ClassName

+ +

The name of the class.

+ + + +

AIRBOSS.ClassNameAndID

+ +

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

+ +

AIRBOSS:ClearState(Object, StateName)

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

Set case to that of lead.

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

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

+

Also decrease flag for section members of flight.

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

Set time stamp.

+

Set new time stamp.

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

Band modulation.

+
+ +
+
+
+ + +AIRBOSS.Radio.voice + + +
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index c4b137014..961cb2582 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2586,12 +2586,6 @@ Dropped troop noMessage and forcedesc parameters aren't saved.

CSAR.inTransitGroups

- - - -

CSAR.index

- - @@ -3162,6 +3156,24 @@ Dropped troop noMessage and forcedesc parameters aren't saved.

Fields and Methods inherited from BASE Description + +

CSAR.ClassID

+ +

The ID number of the class.

+ + + +

CSAR.ClassName

+ +

The name of the class.

+ + + +

CSAR.ClassNameAndID

+ +

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

+ +

CSAR:ClearState(Object, StateName)

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

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -4515,17 +4541,6 @@ 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 - - -
@@ -10369,11 +10384,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

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

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

- - - -
-
- - -CSAR.index - - -
@@ -12836,11 +12854,25 @@ callsigns from playername or group name.

- + #table CSAR.downedPilots + +

Replacement woundedGroups

+ +
+ +
+
+
+ + #number +CSAR.downedpilotcounter + + +
@@ -12964,17 +12996,6 @@ 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 b6c01b534..d225f2b4a 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -3870,6 +3870,24 @@ for FARP vehicles, so -- services are goin to work (e.g. for the blue side: an u Fields and Methods inherited from BASE Description + +

CTLD.ClassID

+ +

The ID number of the class.

+ + + +

CTLD.ClassName

+ +

The name of the class.

+ + + +

CTLD.ClassNameAndID

+ +

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

+ +

CTLD:ClearState(Object, StateName)

@@ -5051,6 +5069,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

CTLD_CARGO.ClassID

+ +

The ID number of the class.

+ + + +

CTLD_CARGO.ClassName

+ +

The name of the class.

+ + + +

CTLD_CARGO.ClassNameAndID

+ +

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

+ +

CTLD_CARGO:ClearState(Object, StateName)

@@ -5782,6 +5818,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

CTLD_ENGINEERING.ClassID

+ +

The ID number of the class.

+ + + +

CTLD_ENGINEERING.ClassName

+ +

The name of the class.

+ + + +

CTLD_ENGINEERING.ClassNameAndID

+ +

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

+ +

CTLD_ENGINEERING:ClearState(Object, StateName)

@@ -6506,6 +6560,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

CTLD_HERCULES.ClassID

+ +

The ID number of the class.

+ + + +

CTLD_HERCULES.ClassName

+ +

The name of the class.

+ + + +

CTLD_HERCULES.ClassNameAndID

+ +

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

+ +

CTLD_HERCULES:ClearState(Object, StateName)

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

Field(s)

-
-
- - #number -CTLD.CargoCounter - - - -
- -
@@ -7597,7 +7658,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.CtldUnits @@ -7710,9 +7771,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Beacons

-
@@ -7783,11 +7841,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.PilotGroups + +

tables

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

#1570

-
- -
-
-
- - #table -CTLD.droppedBeacons - - -
@@ -8329,7 +8379,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

time to repairor build a unit/group

+

noob catch

@@ -17112,17 +17162,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

-
-
- - #number -CTLD.CargoCounter - - - -
- -
@@ -17209,7 +17248,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -17322,9 +17361,6 @@ However, if you create a new folder inside the miz file, which contains the soun - -

Beacons

-
@@ -17395,11 +17431,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.PilotGroups + +

tables

+
@@ -17674,17 +17713,6 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

-
- -
-
-
- - #table -CTLD.droppedBeacons - - -
@@ -17941,7 +17969,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -19551,17 +19579,6 @@ However, if you create a new folder inside the miz file, which contains the soun

Field(s)

-
-
- - #number -CTLD.CargoCounter - - - -
- -
@@ -19648,7 +19665,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -19761,9 +19778,6 @@ However, if you create a new folder inside the miz file, which contains the soun - -

Beacons

-
@@ -19834,11 +19848,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.PilotGroups + +

tables

+
@@ -20113,17 +20130,6 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

-
- -
-
-
- - #table -CTLD.droppedBeacons - - -
@@ -20380,7 +20386,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

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

Flag for direct loading.

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

Flag for direct loading.

+ + + +
+
+ + +CTLD_CARGO.Mark + + +
diff --git a/Documentation/Ops.RecoveryTanker.html b/Documentation/Ops.RecoveryTanker.html index 2d3d283fd..6d2b94b91 100644 --- a/Documentation/Ops.RecoveryTanker.html +++ b/Documentation/Ops.RecoveryTanker.html @@ -2857,6 +2857,24 @@ If enabled, text messages about the tanker status will be displayed on screen an Fields and Methods inherited from BASE Description + +

RECOVERYTANKER.ClassID

+ +

The ID number of the class.

+ + + +

RECOVERYTANKER.ClassName

+ +

The name of the class.

+ + + +

RECOVERYTANKER.ClassNameAndID

+ +

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

+ +

RECOVERYTANKER:ClearState(Object, StateName)

diff --git a/Documentation/Ops.RescueHelo.html b/Documentation/Ops.RescueHelo.html index 743430e0d..1633bddd0 100644 --- a/Documentation/Ops.RescueHelo.html +++ b/Documentation/Ops.RescueHelo.html @@ -2687,6 +2687,24 @@ If enabled, text messages about the helo status will be displayed on screen and Fields and Methods inherited from BASE Description + +

RESCUEHELO.ClassID

+ +

The ID number of the class.

+ + + +

RESCUEHELO.ClassName

+ +

The name of the class.

+ + + +

RESCUEHELO.ClassNameAndID

+ +

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

+ +

RESCUEHELO:ClearState(Object, StateName)

diff --git a/Documentation/Sound.Radio.html b/Documentation/Sound.Radio.html index f2d513aa0..e52d3a21c 100644 --- a/Documentation/Sound.Radio.html +++ b/Documentation/Sound.Radio.html @@ -1833,6 +1833,24 @@ This function is especially useful to stop the broadcast of looped transmissions Fields and Methods inherited from BASE Description + +

RADIO.ClassID

+ +

The ID number of the class.

+ + + +

RADIO.ClassName

+ +

The name of the class.

+ + + +

RADIO.ClassNameAndID

+ +

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

+ +

RADIO:ClearState(Object, StateName)

diff --git a/Documentation/Sound.RadioQueue.html b/Documentation/Sound.RadioQueue.html index 2cb783f20..7d95f148c 100644 --- a/Documentation/Sound.RadioQueue.html +++ b/Documentation/Sound.RadioQueue.html @@ -1895,6 +1895,24 @@ Fields and Methods inherited from BASE Description + +

RADIOQUEUE.ClassID

+ +

The ID number of the class.

+ + + +

RADIOQUEUE.ClassName

+ +

The name of the class.

+ + + +

RADIOQUEUE.ClassNameAndID

+ +

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

+ +

RADIOQUEUE:ClearState(Object, StateName)

diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html index 60f83f202..b51a746dd 100644 --- a/Documentation/Sound.SRS.html +++ b/Documentation/Sound.SRS.html @@ -2071,6 +2071,24 @@ For voices there are enumerators in this class to help you out on voice names:Fields and Methods inherited from BASE Description + +

MSRS.ClassID

+ +

The ID number of the class.

+ + + +

MSRS.ClassName

+ +

The name of the class.

+ + + +

MSRS.ClassNameAndID

+ +

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

+ +

MSRS:ClearState(Object, StateName)

@@ -2736,6 +2754,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

MSRSQUEUE.ClassID

+ +

The ID number of the class.

+ + + +

MSRSQUEUE.ClassName

+ +

The name of the class.

+ + + +

MSRSQUEUE.ClassNameAndID

+ +

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

+ +

MSRSQUEUE:ClearState(Object, StateName)

diff --git a/Documentation/Sound.SoundOutput.html b/Documentation/Sound.SoundOutput.html index 9016cffc9..15c8c020e 100644 --- a/Documentation/Sound.SoundOutput.html +++ b/Documentation/Sound.SoundOutput.html @@ -1816,6 +1816,24 @@ Note that the gender voice needs to be installed on your windows machine for the Fields and Methods inherited from BASE Description + +

SOUNDBASE.ClassID

+ +

The ID number of the class.

+ + + +

SOUNDBASE.ClassName

+ +

The name of the class.

+ + + +

SOUNDBASE.ClassNameAndID

+ +

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

+ +

SOUNDBASE:ClearState(Object, StateName)

@@ -2444,6 +2462,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SOUNDFILE.ClassID

+ +

The ID number of the class.

+ + + +

SOUNDFILE.ClassName

+ +

The name of the class.

+ + + +

SOUNDFILE.ClassNameAndID

+ +

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

+ +

SOUNDFILE:ClearState(Object, StateName)

@@ -3048,6 +3084,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

SOUNDTEXT.ClassID

+ +

The ID number of the class.

+ + + +

SOUNDTEXT.ClassName

+ +

The name of the class.

+ + + +

SOUNDTEXT.ClassNameAndID

+ +

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

+ +

SOUNDTEXT:ClearState(Object, StateName)

diff --git a/Documentation/Sound.UserSound.html b/Documentation/Sound.UserSound.html index 65873c80f..bc1c191c9 100644 --- a/Documentation/Sound.UserSound.html +++ b/Documentation/Sound.UserSound.html @@ -1724,6 +1724,24 @@ Fields and Methods inherited from BASE Description + +

USERSOUND.ClassID

+ +

The ID number of the class.

+ + + +

USERSOUND.ClassName

+ +

The name of the class.

+ + + +

USERSOUND.ClassNameAndID

+ +

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

+ +

USERSOUND:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.CommandCenter.html b/Documentation/Tasking.CommandCenter.html index 83142bab9..337553a23 100644 --- a/Documentation/Tasking.CommandCenter.html +++ b/Documentation/Tasking.CommandCenter.html @@ -2110,6 +2110,24 @@ and will be replaced by a navigation using Reference Zones.

Fields and Methods inherited from BASE Description + +

COMMANDCENTER.ClassID

+ +

The ID number of the class.

+ + + +

COMMANDCENTER.ClassName

+ +

The name of the class.

+ + + +

COMMANDCENTER.ClassNameAndID

+ +

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

+ +

COMMANDCENTER:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.DetectionManager.html b/Documentation/Tasking.DetectionManager.html index 7168f796e..b5e0502ae 100644 --- a/Documentation/Tasking.DetectionManager.html +++ b/Documentation/Tasking.DetectionManager.html @@ -2156,6 +2156,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

DETECTION_MANAGER.ClassID

+ +

The ID number of the class.

+ + + +

DETECTION_MANAGER.ClassName

+ +

The name of the class.

+ + + +

DETECTION_MANAGER.ClassNameAndID

+ +

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

+ +

DETECTION_MANAGER:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.Mission.html b/Documentation/Tasking.Mission.html index 9954dcdb3..0ed38acd7 100644 --- a/Documentation/Tasking.Mission.html +++ b/Documentation/Tasking.Mission.html @@ -2571,6 +2571,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

MISSION.ClassID

+ +

The ID number of the class.

+ + + +

MISSION.ClassName

+ +

The name of the class.

+ + + +

MISSION.ClassNameAndID

+ +

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

+ +

MISSION:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.TaskInfo.html b/Documentation/Tasking.TaskInfo.html index 9e8d19258..4db2077cb 100644 --- a/Documentation/Tasking.TaskInfo.html +++ b/Documentation/Tasking.TaskInfo.html @@ -1801,6 +1801,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

TASKINFO.ClassID

+ +

The ID number of the class.

+ + + +

TASKINFO.ClassName

+ +

The name of the class.

+ + + +

TASKINFO.ClassNameAndID

+ +

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

+ +

TASKINFO:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index de623189d..f3dc32a8f 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2376,6 +2376,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

TASK_A2A_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

TASK_A2A_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

TASK_A2A_DISPATCHER.ClassNameAndID

+ +

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

+ +

TASK_A2A_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index c2619e07e..41ee270a3 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -2646,6 +2646,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

TASK_A2G_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

TASK_A2G_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

TASK_A2G_DISPATCHER.ClassNameAndID

+ +

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

+ +

TASK_A2G_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.Task_Capture_Dispatcher.html b/Documentation/Tasking.Task_Capture_Dispatcher.html index 2140bdc7c..e8696e390 100644 --- a/Documentation/Tasking.Task_Capture_Dispatcher.html +++ b/Documentation/Tasking.Task_Capture_Dispatcher.html @@ -2316,6 +2316,24 @@ and setup a new capture zone task and assign it to a group of players, while you Fields and Methods inherited from BASE Description + +

TASK_CAPTURE_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

TASK_CAPTURE_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

TASK_CAPTURE_DISPATCHER.ClassNameAndID

+ +

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

+ +

TASK_CAPTURE_DISPATCHER:ClearState(Object, StateName)

diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 992743ad0..ed093b2ce 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -2639,6 +2639,24 @@ You can use this event handler to post messages to players, or provide status up Fields and Methods inherited from BASE Description + +

TASK_CARGO_DISPATCHER.ClassID

+ +

The ID number of the class.

+ + + +

TASK_CARGO_DISPATCHER.ClassName

+ +

The name of the class.

+ + + +

TASK_CARGO_DISPATCHER.ClassNameAndID

+ +

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

+ +

TASK_CARGO_DISPATCHER:ClearState(Object, StateName)

@@ -3195,8 +3213,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -3207,21 +3225,43 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -4312,8 +4352,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -4324,21 +4364,43 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -5181,8 +5243,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -5193,21 +5255,43 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+
+
+ + +TASK_CARGO_DISPATCHER.CSARTaskName + + + +
+ +
+
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+
+
+ + #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -6681,8 +6765,8 @@ This method can only be used once!

- #number -TASK_CARGO_DISPATCHER.CountCSAR + +TASK_CARGO_DISPATCHER.CSARBriefing @@ -6693,21 +6777,43 @@ This method can only be used once!

+TASK_CARGO_DISPATCHER.CSARDeployZones + + + +
+ +
+ +
+
+ + #boolean +TASK_CARGO_DISPATCHER.CSARTasks + + + +
+ +
+ - diff --git a/Documentation/Tasking.Task_Manager.html b/Documentation/Tasking.Task_Manager.html index 065754ae3..2da82423f 100644 --- a/Documentation/Tasking.Task_Manager.html +++ b/Documentation/Tasking.Task_Manager.html @@ -2079,6 +2079,24 @@ Therefore, this class is considered to be deprecated

Fields and Methods inherited from BASE Description + +

TASK_MANAGER.ClassID

+ +

The ID number of the class.

+ + + +

TASK_MANAGER.ClassName

+ +

The name of the class.

+ + + +

TASK_MANAGER.ClassNameAndID

+ +

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

+ +

TASK_MANAGER:ClearState(Object, StateName)

diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index e3eb49085..1cbe77c88 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -1856,6 +1856,24 @@ Fields and Methods inherited from BASE Description + +

FIFO.ClassID

+ +

The ID number of the class.

+ + + +

FIFO.ClassName

+ +

The name of the class.

+ + + +

FIFO.ClassNameAndID

+ +

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

+ +

FIFO:ClearState(Object, StateName)

@@ -2593,6 +2611,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

LIFO.ClassID

+ +

The ID number of the class.

+ + + +

LIFO.ClassName

+ +

The name of the class.

+ + + +

LIFO.ClassNameAndID

+ +

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

+ +

LIFO:ClearState(Object, StateName)

diff --git a/Documentation/Utilities.Socket.html b/Documentation/Utilities.Socket.html index 01a456926..99a899f72 100644 --- a/Documentation/Utilities.Socket.html +++ b/Documentation/Utilities.Socket.html @@ -2055,6 +2055,24 @@ Fields and Methods inherited from BASE Description + +

SOCKET.ClassID

+ +

The ID number of the class.

+ + + +

SOCKET.ClassName

+ +

The name of the class.

+ + + +

SOCKET.ClassNameAndID

+ +

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

+ +

SOCKET:ClearState(Object, StateName)

diff --git a/Documentation/Utilities.Utils.html b/Documentation/Utilities.Utils.html index 803ff2b63..a38d6d561 100644 --- a/Documentation/Utilities.Utils.html +++ b/Documentation/Utilities.Utils.html @@ -1971,6 +1971,86 @@

DCSMAP.TheChannel

The Channel map.

+ + + +
+ +

Type FLARECOLOR

+
+ FLARECOLOR +
+
+ + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from FLARECOLORDescription

FLARECOLOR.Green

 + +

FLARECOLOR.Red

 + +

FLARECOLOR.White

 + +

FLARECOLOR.Yellow

 + +
+
+ +

Type SMOKECOLOR

+
+ SMOKECOLOR +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from SMOKECOLORDescription

SMOKECOLOR.Blue

 + +

SMOKECOLOR.Green

 + +

SMOKECOLOR.Orange

 + +

SMOKECOLOR.Red

 + +

SMOKECOLOR.White

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

Function(s)

+
+ +
+

Type FLARECOLOR

+
+
+
+

Field(s)

+
+
+

Function(s)

+
+
+ +
+

Type SMOKECOLOR

+
+
+
+

Field(s)

+
+
+

Function(s)

+
diff --git a/Documentation/Wrapper.Airbase.html b/Documentation/Wrapper.Airbase.html index 75e5dfeb4..72a3daa6c 100644 --- a/Documentation/Wrapper.Airbase.html +++ b/Documentation/Wrapper.Airbase.html @@ -3205,6 +3205,24 @@ is implemented in the AIRBASE class as AIRBASE.Get Fields and Methods inherited from BASE Description + +

AIRBASE.ClassID

+ +

The ID number of the class.

+ + + +

AIRBASE.ClassName

+ +

The name of the class.

+ + + +

AIRBASE.ClassNameAndID

+ +

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

+ +

AIRBASE:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index b96e9fd99..2a8db54ce 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4119,6 +4119,24 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return Fields and Methods inherited from BASE Description + +

CLIENT.ClassID

+ +

The ID number of the class.

+ + + +

CLIENT.ClassName

+ +

The name of the class.

+ + + +

CLIENT.ClassNameAndID

+ +

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

+ +

CLIENT:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Controllable.html b/Documentation/Wrapper.Controllable.html index 37b921d3b..1b43d52ce 100644 --- a/Documentation/Wrapper.Controllable.html +++ b/Documentation/Wrapper.Controllable.html @@ -3623,6 +3623,24 @@ The method CONTROLLABLE.SetTaskWaypoi Fields and Methods inherited from BASE Description + +

CONTROLLABLE.ClassID

+ +

The ID number of the class.

+ + + +

CONTROLLABLE.ClassName

+ +

The name of the class.

+ + + +

CONTROLLABLE.ClassNameAndID

+ +

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

+ +

CONTROLLABLE:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index d468a5fe4..10ca549c3 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4335,6 +4335,24 @@ amount of fuel in the group.

Fields and Methods inherited from BASE Description + +

GROUP.ClassID

+ +

The ID number of the class.

+ + + +

GROUP.ClassName

+ +

The name of the class.

+ + + +

GROUP.ClassNameAndID

+ +

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

+ +

GROUP:ClearState(Object, StateName)

@@ -5169,18 +5187,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -9673,18 +9680,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21542,18 +21538,7 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -25642,18 +25627,7 @@ Coordinates are dependent on the position of the maps origin.

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

-GROUP.InitRespawnRandomizePositionInner - - - -
- -
-
-
- - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -26549,18 +26512,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 ecd91a955..6da4a8f37 100644 --- a/Documentation/Wrapper.Identifiable.html +++ b/Documentation/Wrapper.Identifiable.html @@ -1797,6 +1797,24 @@ Fields and Methods inherited from BASE Description + +

IDENTIFIABLE.ClassID

+ +

The ID number of the class.

+ + + +

IDENTIFIABLE.ClassName

+ +

The name of the class.

+ + + +

IDENTIFIABLE.ClassNameAndID

+ +

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

+ +

IDENTIFIABLE:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 75a5589ee..c3ca51f04 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2434,6 +2434,24 @@ env.info( "Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS() ) Fields and Methods inherited from BASE Description + +

MARKER.ClassID

+ +

The ID number of the class.

+ + + +

MARKER.ClassName

+ +

The name of the class.

+ + + +

MARKER.ClassNameAndID

+ +

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

+ +

MARKER:ClearState(Object, StateName)

@@ -3091,28 +3109,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoalition - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
@@ -5230,28 +5226,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoalition - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
@@ -6840,28 +6814,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -MARKER.tocoalition - - - -
- -
-
-
- - #boolean -MARKER.togroup - - -
diff --git a/Documentation/Wrapper.Net.html b/Documentation/Wrapper.Net.html index 1b5a3a52f..ccd9369a5 100644 --- a/Documentation/Wrapper.Net.html +++ b/Documentation/Wrapper.Net.html @@ -2289,6 +2289,24 @@ with some added FSM functions and options to block/unblock players in MP environ Fields and Methods inherited from BASE Description + +

NET.ClassID

+ +

The ID number of the class.

+ + + +

NET.ClassName

+ +

The name of the class.

+ + + +

NET.ClassNameAndID

+ +

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

+ +

NET:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Object.html b/Documentation/Wrapper.Object.html index 53f3156bb..deb16cfc0 100644 --- a/Documentation/Wrapper.Object.html +++ b/Documentation/Wrapper.Object.html @@ -1717,6 +1717,24 @@ Fields and Methods inherited from BASE Description + +

OBJECT.ClassID

+ +

The ID number of the class.

+ + + +

OBJECT.ClassName

+ +

The name of the class.

+ + + +

OBJECT.ClassNameAndID

+ +

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

+ +

OBJECT:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index b1836d4dd..b9c6178c6 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -2442,6 +2442,24 @@ The method POSITIONABLE.GetVelocity() Fields and Methods inherited from BASE Description + +

POSITIONABLE.ClassID

+ +

The ID number of the class.

+ + + +

POSITIONABLE.ClassName

+ +

The name of the class.

+ + + +

POSITIONABLE.ClassNameAndID

+ +

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

+ +

POSITIONABLE:ClearState(Object, StateName)

@@ -3112,6 +3130,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from BASE Description + +

POSITIONABLE.__.ClassID

+ +

The ID number of the class.

+ + + +

POSITIONABLE.__.ClassName

+ +

The name of the class.

+ + + +

POSITIONABLE.__.ClassNameAndID

+ +

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

+ +

POSITIONABLE.__:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Scenery.html b/Documentation/Wrapper.Scenery.html index eeb383b7f..09820a461 100644 --- a/Documentation/Wrapper.Scenery.html +++ b/Documentation/Wrapper.Scenery.html @@ -2541,6 +2541,24 @@ Fields and Methods inherited from BASE Description + +

SCENERY.ClassID

+ +

The ID number of the class.

+ + + +

SCENERY.ClassName

+ +

The name of the class.

+ + + +

SCENERY.ClassNameAndID

+ +

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

+ +

SCENERY:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Static.html b/Documentation/Wrapper.Static.html index a43bc3273..2382db0d8 100644 --- a/Documentation/Wrapper.Static.html +++ b/Documentation/Wrapper.Static.html @@ -2514,6 +2514,24 @@ If the DCS Static object does not exist or is nil, the STATIC methods will retur Fields and Methods inherited from BASE Description + +

STATIC.ClassID

+ +

The ID number of the class.

+ + + +

STATIC.ClassName

+ +

The name of the class.

+ + + +

STATIC.ClassNameAndID

+ +

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

+ +

STATIC:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Storage.html b/Documentation/Wrapper.Storage.html index 8d0f16eb6..57cbc8dea 100644 --- a/Documentation/Wrapper.Storage.html +++ b/Documentation/Wrapper.Storage.html @@ -1970,6 +1970,24 @@ UTILS.PrintTableToLog(weapons) Fields and Methods inherited from BASE Description + +

STORAGE.ClassID

+ +

The ID number of the class.

+ + + +

STORAGE.ClassName

+ +

The name of the class.

+ + + +

STORAGE.ClassNameAndID

+ +

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

+ +

STORAGE:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Unit.html b/Documentation/Wrapper.Unit.html index 71d3b5355..1141378fb 100644 --- a/Documentation/Wrapper.Unit.html +++ b/Documentation/Wrapper.Unit.html @@ -3905,6 +3905,24 @@ If you want to obtain the complete 3D position including orient Fields and Methods inherited from BASE Description + +

UNIT.ClassID

+ +

The ID number of the class.

+ + + +

UNIT.ClassName

+ +

The name of the class.

+ + + +

UNIT.ClassNameAndID

+ +

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

+ +

UNIT:ClearState(Object, StateName)

diff --git a/Documentation/Wrapper.Weapon.html b/Documentation/Wrapper.Weapon.html index fad34e2ef..2921b14a7 100644 --- a/Documentation/Wrapper.Weapon.html +++ b/Documentation/Wrapper.Weapon.html @@ -2920,6 +2920,24 @@ but it could also be a STATIC object.

Fields and Methods inherited from BASE Description + +

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)