From 52aa0eb715504f7aca07512375b1bdd8f8ebde7e Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Sun, 24 Apr 2022 12:14:58 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_AIR_Dispatcher.html | 44 + Documentation/AI.AI_Air.html | 44 + Documentation/AI.AI_Cargo.html | 12 + Documentation/AI.AI_Cargo_Airplane.html | 24 +- Documentation/Cargo.CargoCrate.html | 22 - Documentation/Cargo.CargoGroup.html | 28 - Documentation/Cargo.CargoUnit.html | 22 + Documentation/Core.Fsm.html | 4 +- Documentation/Core.Menu.html | 42752 +--------------- Documentation/Core.Settings.html | 4 +- Documentation/Core.Spawn.html | 278 +- Documentation/Core.Spot.html | 99 + Documentation/Functional.Detection.html | 72 +- Documentation/Functional.Mantis.html | 6 - Documentation/Functional.Movement.html | 28 + Documentation/Functional.Rat.html | 69 +- Documentation/Ops.Airboss.html | 24 +- Documentation/Ops.CSAR.html | 201 +- Documentation/Ops.CTLD.html | 34 +- Documentation/Tasking.Task.html | 22 + .../Tasking.Task_A2A_Dispatcher.html | 8 +- .../Tasking.Task_A2G_Dispatcher.html | 20 +- Documentation/Tasking.Task_Cargo.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 220 +- Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Group.html | 78 +- Documentation/Wrapper.Marker.html | 132 +- Documentation/Wrapper.Positionable.html | 44 + 28 files changed, 944 insertions(+), 43380 deletions(-) diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 30bb524cf..b2641ffc8 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4437,6 +4437,17 @@ 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 + + +
@@ -9734,6 +9745,17 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

+ + + +
+
+ + #number +AI_AIR_DISPATCHER.DefenderPatrolIndex + + +
@@ -12674,6 +12707,17 @@ 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.html b/Documentation/AI.AI_Air.html index 8396e6637..159977bc1 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -2934,6 +2934,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #number +AI_AIR.IdleCount + + +
@@ -5678,6 +5689,17 @@ Once the time is finished, the old AI will return to the base.

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

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

+ + + +
+
+ + #number +AI_AIR.IdleCount + + +
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 9d5e82608..3802dd9c7 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2671,6 +2671,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

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

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

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

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

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

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

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

+ diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 61b2bec73..61dde2240 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2628,6 +2628,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

- diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index d42206294..0db380efb 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1749,17 +1749,6 @@ Controls a network of short range air/missile defense groups.

Field(s)

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

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index dafe628a8..f82ea5469 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1820,20 +1820,6 @@ Controls a network of short range air/missile defense groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup @@ -3155,20 +3141,6 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 0acaf3e53..b3c66a4d4 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1698,6 +1698,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2402,6 +2413,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 3e303283d..789151b7f 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5651,7 +5651,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7254,7 +7254,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Menu.html b/Documentation/Core.Menu.html index 6ce236d96..0c05d2e41 100644 --- a/Documentation/Core.Menu.html +++ b/Documentation/Core.Menu.html @@ -1521,12 +1521,12 @@ Controls a network of short range air/missile defense groups.

  • Provide a great tool to manage menus in your code.
    • -

    DCS Menus can be managed using the MENU classes. +

    DCS Menus can be managed using the MENU classes. The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scenarios where you need to set menus and later remove them, and later set them again. You'll find while using use normal DCS scripting functions, that setting and removing -menus is not a easy feat if you have complex menu hierarchies defined. +menus is not a easy feat if you have complex menu hierarchies defined. Using the MOOSE menu classes, the removal and refreshing of menus are nicely being handled within these classes, and becomes much more easy. -On top, MOOSE implements variable parameter passing for command menus.

    +On top, MOOSE implements variable parameter passing for command menus.

    There are basically two different MENU class types that you need to use:

    @@ -1547,12 +1547,12 @@ On top, MOOSE implements variable parameter passing for command
    -

    -

    +

    -

    Author: FlightControl

    Contributions:

    - +

    Global(s)

    @@ -1561,7 +1561,7 @@ On top, MOOSE implements variable parameter passing for command

    Global MENU_BASE

    -

    Defines the main MENU class where other MENU classes are derived from.

    + @@ -1569,13 +1569,10 @@ On top, MOOSE implements variable parameter passing for command
    - #MENU_BASE + #table MENU_BASE -

    Defines the main MENU class where other MENU classes are derived from.

    - -

    This is an abstract class, so don't use it.

    @@ -1633,7 +1630,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde end local function AddStatusMenu() - + -- This would create a menu for the red coalition under the MenuCoalitionRed menu object. MenuStatus = MENU_COALITION:New( coalition.side.RED, "Status for Planes" ) MenuStatusShow = MENU_COALITION_COMMAND:New( coalition.side.RED, "Show Status", MenuStatus, ShowStatus, "Status of planes is ok!", "Message to Red Coalition" ) @@ -1678,7 +1675,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde

    Global MENU_COMMAND_BASE

    -

    Defines the main MENU class where other MENU COMMAND_ +

    Defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.

    @@ -1691,7 +1688,7 @@ classes are derived from, in order to set commands.

    #MENU_COMMAND_BASE MENU_COMMAND_BASE -

    Defines the main MENU class where other MENU COMMAND_ +

    Defines the main MENU class where other MENU COMMAND_ classes are derived from, in order to set commands.

    @@ -1728,7 +1725,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde -- To test, join the planes, then look at the other radio menus (Option F10). -- Then switch planes and check if the menu is still there. -- And play with the Add and Remove menu options. - + -- Note that in multi player, this will only work after the DCS groups bug is solved. local function ShowStatus( PlaneGroup, StatusText, Coalition ) @@ -1884,7 +1881,7 @@ This method is most of the time called after the "old" menu items have been remo

    Global MENU_MISSION

    -

    Manages the main menus for a complete mission.

    + @@ -1892,15 +1889,10 @@ This method is most of the time called after the "old" menu items have been remo
    - #MENU_MISSION + #table MENU_MISSION -

    Manages the main menus for a complete mission.

    - - -

    You can add menus with the MENU_MISSION.New method, which constructs a MENU_MISSION object and returns you the object reference. -Using this object reference, you can then remove ALL the menus and submenus underlying automatically with MENU_MISSION.Remove.

    @@ -1936,7 +1928,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde

    Type MENU_BASE

    MENU_BASE -, extends Core.Base#BASE
    @@ -1944,24 +1935,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASE Description

    MENU_BASE:ClearParentMenu(MenuText)

    		 - -

    MENU_BASE:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_BASE:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_BASE.MenuRemoveParent

    		 @@ -1978,570 +1951,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde

    MENU_BASE.MenuTag

    		 -

    MENU_BASE:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_BASE:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_BASE:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_BASE:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_BASE:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_BASE:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_BASE.ClassID

    		 -

    The ID number of the class.

    -

    MENU_BASE.ClassName

    		 -

    The name of the class.

    -

    MENU_BASE.ClassNameAndID

    		 -

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

    -

    MENU_BASE:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_BASE:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_BASE:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_BASE:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_BASE:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_BASE:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_BASE:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_BASE:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_BASE:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_BASE:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_BASE:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_BASE:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_BASE:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_BASE:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_BASE:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_BASE:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_BASE:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_BASE:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_BASE:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_BASE:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_BASE:Inherit(Child, Parent)

    		 -

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

    -

    MENU_BASE:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_BASE:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_BASE:New()

    		 -

    BASE constructor.

    -

    MENU_BASE:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_BASE:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_BASE:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_BASE:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_BASE:OnEventCrash(EventData)

    		 -

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

    -

    MENU_BASE:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_BASE:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_BASE:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_BASE:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_BASE:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_BASE:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_BASE:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_BASE:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_BASE:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_BASE:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_BASE:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_BASE:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_BASE:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_BASE:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_BASE:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_BASE:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_BASE:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_BASE:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_BASE:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_BASE:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_BASE:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_BASE:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_BASE:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_BASE:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_BASE:OnEventScore(EventData)

    		 -

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

    -

    MENU_BASE:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_BASE:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_BASE:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_BASE:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_BASE:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_BASE:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_BASE:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_BASE.Scheduler

    		 - -

    MENU_BASE:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_BASE:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_BASE:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_BASE:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_BASE:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_BASE:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_BASE:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_BASE:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_BASE:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_BASE:TraceOff()

    		 -

    Set trace off.

    -

    MENU_BASE:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_BASE:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_BASE._

    		 - -

    MENU_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_BASE.__

    		 - -

    MENU_BASE:onEvent(event)

    		 -
    @@ -2550,8 +1959,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Type MENU_COALITION

    MENU_COALITION -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -2587,614 +1994,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

    MENU_COALITION:RemoveSubMenus()

    Removes the sub menus recursively of this MENU_COALITION.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_COALITION:ClearParentMenu(MenuText)

    		 - -

    MENU_COALITION:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_COALITION:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_COALITION.MenuRemoveParent

    		 - -

    MENU_COALITION.MenuStamp

    		 - -

    MENU_COALITION.MenuTag

    		 - -

    MENU_COALITION:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_COALITION:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_COALITION:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_COALITION:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_COALITION:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_COALITION:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_COALITION.ClassID

    		 -

    The ID number of the class.

    -

    MENU_COALITION.ClassName

    		 -

    The name of the class.

    -

    MENU_COALITION.ClassNameAndID

    		 -

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

    -

    MENU_COALITION:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_COALITION:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_COALITION:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_COALITION:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_COALITION:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_COALITION:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_COALITION:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_COALITION:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_COALITION:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_COALITION:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_COALITION:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_COALITION:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_COALITION:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_COALITION:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_COALITION:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_COALITION:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_COALITION:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_COALITION:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_COALITION:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_COALITION:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_COALITION:Inherit(Child, Parent)

    		 -

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

    -

    MENU_COALITION:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_COALITION:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_COALITION:New()

    		 -

    BASE constructor.

    -

    MENU_COALITION:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_COALITION:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_COALITION:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_COALITION:OnEventCrash(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_COALITION:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_COALITION:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_COALITION:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_COALITION:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_COALITION:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_COALITION:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_COALITION:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_COALITION:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_COALITION:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_COALITION:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_COALITION:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_COALITION:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_COALITION:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_COALITION:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_COALITION:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_COALITION:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_COALITION:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_COALITION:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_COALITION:OnEventScore(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_COALITION:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_COALITION:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_COALITION:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_COALITION:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_COALITION:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_COALITION.Scheduler

    		 - -

    MENU_COALITION:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_COALITION:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_COALITION:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_COALITION:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_COALITION:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_COALITION:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_COALITION:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_COALITION:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_COALITION:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_COALITION:TraceOff()

    		 -

    Set trace off.

    -

    MENU_COALITION:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_COALITION:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_COALITION._

    		 - -

    MENU_COALITION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_COALITION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_COALITION.__

    		 - -

    MENU_COALITION:onEvent(event)

    		 -
    @@ -3204,8 +2003,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    MENU_COALITION_COMMAND , extends Core.Menu#MENU_COMMAND_BASE -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -3240,7 +2037,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - + @@ -3263,618 +2060,10 @@ If the arguments change, no new menu needs to be generated if the menu text is t - -
    Description

    MENU_COALITION_COMMAND.MenuCallHandler

    MENU_COALITION_COMMAND.MenuCallHandler()

    MENU_COALITION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    		 -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_COALITION_COMMAND:ClearParentMenu(MenuText)

    		 - -

    MENU_COALITION_COMMAND:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_COALITION_COMMAND:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_COALITION_COMMAND.MenuRemoveParent

    		 - -

    MENU_COALITION_COMMAND.MenuStamp

    		 - -

    MENU_COALITION_COMMAND.MenuTag

    		 - -

    MENU_COALITION_COMMAND:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_COALITION_COMMAND:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_COALITION_COMMAND:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_COALITION_COMMAND:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_COALITION_COMMAND:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_COALITION_COMMAND:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_COALITION_COMMAND.ClassID

    		 -

    The ID number of the class.

    -

    MENU_COALITION_COMMAND.ClassName

    		 -

    The name of the class.

    -

    MENU_COALITION_COMMAND.ClassNameAndID

    		 -

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

    -

    MENU_COALITION_COMMAND:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_COALITION_COMMAND:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_COALITION_COMMAND:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_COALITION_COMMAND:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_COALITION_COMMAND:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_COALITION_COMMAND:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_COALITION_COMMAND:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_COALITION_COMMAND:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_COALITION_COMMAND:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_COALITION_COMMAND:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_COALITION_COMMAND:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_COALITION_COMMAND:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_COALITION_COMMAND:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_COALITION_COMMAND:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_COALITION_COMMAND:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_COALITION_COMMAND:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_COALITION_COMMAND:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_COALITION_COMMAND:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_COALITION_COMMAND:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_COALITION_COMMAND:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_COALITION_COMMAND:Inherit(Child, Parent)

    		 -

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

    -

    MENU_COALITION_COMMAND:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_COALITION_COMMAND:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_COALITION_COMMAND:New()

    		 -

    BASE constructor.

    -

    MENU_COALITION_COMMAND:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_COALITION_COMMAND:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_COALITION_COMMAND:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_COALITION_COMMAND:OnEventCrash(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_COALITION_COMMAND:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_COALITION_COMMAND:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_COALITION_COMMAND:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_COALITION_COMMAND:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_COALITION_COMMAND:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_COALITION_COMMAND:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_COALITION_COMMAND:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_COALITION_COMMAND:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_COALITION_COMMAND:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_COALITION_COMMAND:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_COALITION_COMMAND:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_COALITION_COMMAND:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_COALITION_COMMAND:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_COALITION_COMMAND:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_COALITION_COMMAND:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_COALITION_COMMAND:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_COALITION_COMMAND:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_COALITION_COMMAND:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_COALITION_COMMAND:OnEventScore(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_COALITION_COMMAND:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_COALITION_COMMAND:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_COALITION_COMMAND:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_COALITION_COMMAND:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_COALITION_COMMAND:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_COALITION_COMMAND.Scheduler

    		 - -

    MENU_COALITION_COMMAND:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_COALITION_COMMAND:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_COALITION_COMMAND:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_COALITION_COMMAND:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_COALITION_COMMAND:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_COALITION_COMMAND:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_COALITION_COMMAND:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_COALITION_COMMAND:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_COALITION_COMMAND:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_COALITION_COMMAND:TraceOff()

    		 -

    Set trace off.

    -

    MENU_COALITION_COMMAND:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_COALITION_COMMAND:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_COALITION_COMMAND._

    		 - -

    MENU_COALITION_COMMAND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_COALITION_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_COALITION_COMMAND.__

    		 - -

    MENU_COALITION_COMMAND:onEvent(event)

    		 -
    @@ -3883,8 +2072,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Type MENU_COMMAND_BASE

    MENU_COMMAND_BASE -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -3893,7 +2080,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - + @@ -3916,618 +2103,10 @@ If the arguments change, no new menu needs to be generated if the menu text is t - -
    Description

    MENU_COMMAND_BASE.MenuCallHandler

    MENU_COMMAND_BASE.MenuCallHandler()

    MENU_COMMAND_BASE:SetCommandMenuFunction(CommandMenuFunction)

    		 -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_COMMAND_BASE:ClearParentMenu(MenuText)

    		 - -

    MENU_COMMAND_BASE:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_COMMAND_BASE:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_COMMAND_BASE.MenuRemoveParent

    		 - -

    MENU_COMMAND_BASE.MenuStamp

    		 - -

    MENU_COMMAND_BASE.MenuTag

    		 - -

    MENU_COMMAND_BASE:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_COMMAND_BASE:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_COMMAND_BASE:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_COMMAND_BASE:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_COMMAND_BASE:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_COMMAND_BASE:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_COMMAND_BASE.ClassID

    		 -

    The ID number of the class.

    -

    MENU_COMMAND_BASE.ClassName

    		 -

    The name of the class.

    -

    MENU_COMMAND_BASE.ClassNameAndID

    		 -

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

    -

    MENU_COMMAND_BASE:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_COMMAND_BASE:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_COMMAND_BASE:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_COMMAND_BASE:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_COMMAND_BASE:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_COMMAND_BASE:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_COMMAND_BASE:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_COMMAND_BASE:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_COMMAND_BASE:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_COMMAND_BASE:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_COMMAND_BASE:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_COMMAND_BASE:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_COMMAND_BASE:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_COMMAND_BASE:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_COMMAND_BASE:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_COMMAND_BASE:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_COMMAND_BASE:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_COMMAND_BASE:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_COMMAND_BASE:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_COMMAND_BASE:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_COMMAND_BASE:Inherit(Child, Parent)

    		 -

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

    -

    MENU_COMMAND_BASE:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_COMMAND_BASE:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_COMMAND_BASE:New()

    		 -

    BASE constructor.

    -

    MENU_COMMAND_BASE:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_COMMAND_BASE:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_COMMAND_BASE:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_COMMAND_BASE:OnEventCrash(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_COMMAND_BASE:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_COMMAND_BASE:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_COMMAND_BASE:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_COMMAND_BASE:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_COMMAND_BASE:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_COMMAND_BASE:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_COMMAND_BASE:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_COMMAND_BASE:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_COMMAND_BASE:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_COMMAND_BASE:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_COMMAND_BASE:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_COMMAND_BASE:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_COMMAND_BASE:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_COMMAND_BASE:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_COMMAND_BASE:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_COMMAND_BASE:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_COMMAND_BASE:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_COMMAND_BASE:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_COMMAND_BASE:OnEventScore(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_COMMAND_BASE:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_COMMAND_BASE:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_COMMAND_BASE:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_COMMAND_BASE:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_COMMAND_BASE:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_COMMAND_BASE.Scheduler

    		 - -

    MENU_COMMAND_BASE:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_COMMAND_BASE:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_COMMAND_BASE:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_COMMAND_BASE:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_COMMAND_BASE:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_COMMAND_BASE:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_COMMAND_BASE:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_COMMAND_BASE:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_COMMAND_BASE:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_COMMAND_BASE:TraceOff()

    		 -

    Set trace off.

    -

    MENU_COMMAND_BASE:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_COMMAND_BASE:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_COMMAND_BASE._

    		 - -

    MENU_COMMAND_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_COMMAND_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_COMMAND_BASE.__

    		 - -

    MENU_COMMAND_BASE:onEvent(event)

    		 -
    @@ -4537,7 +2116,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    MENU_GROUP , extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -4601,24 +2179,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASE Description

    MENU_GROUP:ClearParentMenu(MenuText)

    		 - -

    MENU_GROUP:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_GROUP:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP.MenuRemoveParent

    		 @@ -4635,570 +2195,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    MENU_GROUP.MenuTag

    		 -

    MENU_GROUP:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_GROUP:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_GROUP:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_GROUP:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_GROUP:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_GROUP.ClassID

    		 -

    The ID number of the class.

    -

    MENU_GROUP.ClassName

    		 -

    The name of the class.

    -

    MENU_GROUP.ClassNameAndID

    		 -

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

    -

    MENU_GROUP:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_GROUP:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_GROUP:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_GROUP:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_GROUP:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_GROUP:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_GROUP:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_GROUP:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_GROUP:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_GROUP:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_GROUP:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_GROUP:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_GROUP:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_GROUP:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_GROUP:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_GROUP:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_GROUP:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_GROUP:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_GROUP:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_GROUP:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_GROUP:Inherit(Child, Parent)

    		 -

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

    -

    MENU_GROUP:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_GROUP:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_GROUP:New()

    		 -

    BASE constructor.

    -

    MENU_GROUP:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_GROUP:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_GROUP:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_GROUP:OnEventCrash(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_GROUP:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_GROUP:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_GROUP:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_GROUP:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_GROUP:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_GROUP:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_GROUP:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_GROUP:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_GROUP:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_GROUP:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_GROUP:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_GROUP:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_GROUP:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_GROUP:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_GROUP:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_GROUP:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_GROUP:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_GROUP:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_GROUP:OnEventScore(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_GROUP:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_GROUP:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_GROUP:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_GROUP:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_GROUP:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_GROUP.Scheduler

    		 - -

    MENU_GROUP:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_GROUP:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_GROUP:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_GROUP:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_GROUP:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_GROUP:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_GROUP:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_GROUP:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_GROUP:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_GROUP:TraceOff()

    		 -

    Set trace off.

    -

    MENU_GROUP:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_GROUP:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_GROUP._

    		 - -

    MENU_GROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_GROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_GROUP.__

    		 - -

    MENU_GROUP:onEvent(event)

    		 -
    @@ -5208,8 +2204,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    MENU_GROUP_COMMAND , extends Core.Menu#MENU_COMMAND_BASE -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -5262,7 +2256,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - + @@ -5285,618 +2279,10 @@ If the arguments change, no new menu needs to be generated if the menu text is t - -
    Description

    MENU_GROUP_COMMAND.MenuCallHandler

    MENU_GROUP_COMMAND.MenuCallHandler()

    MENU_GROUP_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    		 -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_GROUP_COMMAND:ClearParentMenu(MenuText)

    		 - -

    MENU_GROUP_COMMAND:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_GROUP_COMMAND:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP_COMMAND.MenuRemoveParent

    		 - -

    MENU_GROUP_COMMAND.MenuStamp

    		 - -

    MENU_GROUP_COMMAND.MenuTag

    		 - -

    MENU_GROUP_COMMAND:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_GROUP_COMMAND:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_GROUP_COMMAND:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_GROUP_COMMAND:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP_COMMAND:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_GROUP_COMMAND:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_GROUP_COMMAND.ClassID

    		 -

    The ID number of the class.

    -

    MENU_GROUP_COMMAND.ClassName

    		 -

    The name of the class.

    -

    MENU_GROUP_COMMAND.ClassNameAndID

    		 -

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

    -

    MENU_GROUP_COMMAND:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_GROUP_COMMAND:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_GROUP_COMMAND:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_GROUP_COMMAND:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_GROUP_COMMAND:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_GROUP_COMMAND:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_GROUP_COMMAND:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_GROUP_COMMAND:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_GROUP_COMMAND:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_GROUP_COMMAND:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_GROUP_COMMAND:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_GROUP_COMMAND:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_GROUP_COMMAND:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_GROUP_COMMAND:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_GROUP_COMMAND:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_GROUP_COMMAND:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_GROUP_COMMAND:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_GROUP_COMMAND:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_GROUP_COMMAND:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_GROUP_COMMAND:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_GROUP_COMMAND:Inherit(Child, Parent)

    		 -

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

    -

    MENU_GROUP_COMMAND:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_GROUP_COMMAND:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_GROUP_COMMAND:New()

    		 -

    BASE constructor.

    -

    MENU_GROUP_COMMAND:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_GROUP_COMMAND:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_GROUP_COMMAND:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_GROUP_COMMAND:OnEventCrash(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_GROUP_COMMAND:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_GROUP_COMMAND:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_GROUP_COMMAND:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_GROUP_COMMAND:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_GROUP_COMMAND:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_GROUP_COMMAND:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_GROUP_COMMAND:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_GROUP_COMMAND:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_GROUP_COMMAND:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_GROUP_COMMAND:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_GROUP_COMMAND:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_GROUP_COMMAND:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_GROUP_COMMAND:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_GROUP_COMMAND:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_GROUP_COMMAND:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_GROUP_COMMAND:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_GROUP_COMMAND:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_GROUP_COMMAND:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_GROUP_COMMAND:OnEventScore(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_GROUP_COMMAND:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_GROUP_COMMAND:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_GROUP_COMMAND:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_GROUP_COMMAND:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_GROUP_COMMAND.Scheduler

    		 - -

    MENU_GROUP_COMMAND:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_GROUP_COMMAND:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_GROUP_COMMAND:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_GROUP_COMMAND:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_GROUP_COMMAND:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_GROUP_COMMAND:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_GROUP_COMMAND:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_GROUP_COMMAND:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_GROUP_COMMAND:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_GROUP_COMMAND:TraceOff()

    		 -

    Set trace off.

    -

    MENU_GROUP_COMMAND:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_GROUP_COMMAND:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_GROUP_COMMAND._

    		 - -

    MENU_GROUP_COMMAND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_GROUP_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_GROUP_COMMAND.__

    		 - -

    MENU_GROUP_COMMAND:onEvent(event)

    		 -
    @@ -5906,8 +2292,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    MENU_GROUP_COMMAND_DELAYED , extends Core.Menu#MENU_COMMAND_BASE -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -5972,7 +2356,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - + @@ -5995,618 +2379,10 @@ If the arguments change, no new menu needs to be generated if the menu text is t - -
    Description

    MENU_GROUP_COMMAND_DELAYED.MenuCallHandler

    MENU_GROUP_COMMAND_DELAYED.MenuCallHandler()

    MENU_GROUP_COMMAND_DELAYED:SetCommandMenuFunction(CommandMenuFunction)

    		 -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_GROUP_COMMAND_DELAYED:ClearParentMenu(MenuText)

    		 - -

    MENU_GROUP_COMMAND_DELAYED:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_GROUP_COMMAND_DELAYED:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP_COMMAND_DELAYED.MenuRemoveParent

    		 - -

    MENU_GROUP_COMMAND_DELAYED.MenuStamp

    		 - -

    MENU_GROUP_COMMAND_DELAYED.MenuTag

    		 - -

    MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_GROUP_COMMAND_DELAYED:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_GROUP_COMMAND_DELAYED:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_GROUP_COMMAND_DELAYED:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP_COMMAND_DELAYED:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_GROUP_COMMAND_DELAYED:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_GROUP_COMMAND_DELAYED.ClassID

    		 -

    The ID number of the class.

    -

    MENU_GROUP_COMMAND_DELAYED.ClassName

    		 -

    The name of the class.

    -

    MENU_GROUP_COMMAND_DELAYED.ClassNameAndID

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_GROUP_COMMAND_DELAYED:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_GROUP_COMMAND_DELAYED:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_GROUP_COMMAND_DELAYED:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_GROUP_COMMAND_DELAYED:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_GROUP_COMMAND_DELAYED:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_GROUP_COMMAND_DELAYED:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_GROUP_COMMAND_DELAYED:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_GROUP_COMMAND_DELAYED:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_GROUP_COMMAND_DELAYED:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_GROUP_COMMAND_DELAYED:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_GROUP_COMMAND_DELAYED:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_GROUP_COMMAND_DELAYED:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_GROUP_COMMAND_DELAYED:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_GROUP_COMMAND_DELAYED:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_GROUP_COMMAND_DELAYED:Inherit(Child, Parent)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_GROUP_COMMAND_DELAYED:New()

    		 -

    BASE constructor.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventCrash(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventScore(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_GROUP_COMMAND_DELAYED:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_GROUP_COMMAND_DELAYED:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_GROUP_COMMAND_DELAYED.Scheduler

    		 - -

    MENU_GROUP_COMMAND_DELAYED:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_GROUP_COMMAND_DELAYED:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_GROUP_COMMAND_DELAYED:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_GROUP_COMMAND_DELAYED:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_GROUP_COMMAND_DELAYED:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_GROUP_COMMAND_DELAYED:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_GROUP_COMMAND_DELAYED:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_GROUP_COMMAND_DELAYED:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_GROUP_COMMAND_DELAYED:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_GROUP_COMMAND_DELAYED:TraceOff()

    		 -

    Set trace off.

    -

    MENU_GROUP_COMMAND_DELAYED:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_GROUP_COMMAND_DELAYED:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_GROUP_COMMAND_DELAYED._

    		 - -

    MENU_GROUP_COMMAND_DELAYED:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_GROUP_COMMAND_DELAYED:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_GROUP_COMMAND_DELAYED.__

    		 - -

    MENU_GROUP_COMMAND_DELAYED:onEvent(event)

    		 -
    @@ -6616,7 +2392,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    MENU_GROUP_DELAYED , extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -6692,24 +2467,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASE Description

    MENU_GROUP_DELAYED:ClearParentMenu(MenuText)

    		 - -

    MENU_GROUP_DELAYED:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_GROUP_DELAYED:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP_DELAYED.MenuRemoveParent

    		 @@ -6726,570 +2483,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    MENU_GROUP_DELAYED.MenuTag

    		 -

    MENU_GROUP_DELAYED:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_GROUP_DELAYED:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_GROUP_DELAYED:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_GROUP_DELAYED:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_GROUP_DELAYED:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_GROUP_DELAYED:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_GROUP_DELAYED.ClassID

    		 -

    The ID number of the class.

    -

    MENU_GROUP_DELAYED.ClassName

    		 -

    The name of the class.

    -

    MENU_GROUP_DELAYED.ClassNameAndID

    		 -

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

    -

    MENU_GROUP_DELAYED:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_GROUP_DELAYED:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_GROUP_DELAYED:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_GROUP_DELAYED:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_GROUP_DELAYED:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_GROUP_DELAYED:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_GROUP_DELAYED:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_GROUP_DELAYED:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_GROUP_DELAYED:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_GROUP_DELAYED:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_GROUP_DELAYED:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_GROUP_DELAYED:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_GROUP_DELAYED:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_GROUP_DELAYED:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_GROUP_DELAYED:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_GROUP_DELAYED:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_GROUP_DELAYED:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_GROUP_DELAYED:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_GROUP_DELAYED:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_GROUP_DELAYED:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_GROUP_DELAYED:Inherit(Child, Parent)

    		 -

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

    -

    MENU_GROUP_DELAYED:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_GROUP_DELAYED:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_GROUP_DELAYED:New()

    		 -

    BASE constructor.

    -

    MENU_GROUP_DELAYED:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_GROUP_DELAYED:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_GROUP_DELAYED:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_GROUP_DELAYED:OnEventCrash(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_GROUP_DELAYED:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_GROUP_DELAYED:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_GROUP_DELAYED:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_GROUP_DELAYED:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_GROUP_DELAYED:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_GROUP_DELAYED:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_GROUP_DELAYED:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_GROUP_DELAYED:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_GROUP_DELAYED:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_GROUP_DELAYED:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_GROUP_DELAYED:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_GROUP_DELAYED:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_GROUP_DELAYED:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_GROUP_DELAYED:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_GROUP_DELAYED:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_GROUP_DELAYED:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_GROUP_DELAYED:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_GROUP_DELAYED:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_GROUP_DELAYED:OnEventScore(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_GROUP_DELAYED:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_GROUP_DELAYED:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_GROUP_DELAYED:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_GROUP_DELAYED:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_GROUP_DELAYED:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_GROUP_DELAYED.Scheduler

    		 - -

    MENU_GROUP_DELAYED:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_GROUP_DELAYED:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_GROUP_DELAYED:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_GROUP_DELAYED:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_GROUP_DELAYED:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_GROUP_DELAYED:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_GROUP_DELAYED:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_GROUP_DELAYED:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_GROUP_DELAYED:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_GROUP_DELAYED:TraceOff()

    		 -

    Set trace off.

    -

    MENU_GROUP_DELAYED:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_GROUP_DELAYED:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_GROUP_DELAYED._

    		 - -

    MENU_GROUP_DELAYED:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_GROUP_DELAYED:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_GROUP_DELAYED.__

    		 - -

    MENU_GROUP_DELAYED:onEvent(event)

    		 -
    @@ -7298,8 +2491,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Type MENU_MISSION

    MENU_MISSION -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -7317,638 +2508,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - - - - - - - - - - - - - - -

    MENU_MISSION.Menus

    		 -

    MENU_MISSION:New(MenuText, ParentMenu)

    		 -

    MENU_MISSION constructor.

    -

    MENU_MISSION:Refresh()

    		 -

    Refreshes a radio item for a mission

    -

    MENU_MISSION:Remove(MenuStamp, MenuTag)

    		 -

    Removes the main menu and the sub menus recursively of this MENU_MISSION.

    -

    MENU_MISSION:RemoveSubMenus()

    		 -

    Removes the sub menus recursively of this MENU_MISSION.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_MISSION:ClearParentMenu(MenuText)

    		 - -

    MENU_MISSION:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_MISSION:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_MISSION.MenuRemoveParent

    		 - -

    MENU_MISSION.MenuStamp

    		 - -

    MENU_MISSION.MenuTag

    		 - -

    MENU_MISSION:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_MISSION:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_MISSION:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_MISSION:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_MISSION:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_MISSION:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_MISSION.ClassID

    		 -

    The ID number of the class.

    -

    MENU_MISSION.ClassName

    		 -

    The name of the class.

    -

    MENU_MISSION.ClassNameAndID

    		 -

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

    -

    MENU_MISSION:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_MISSION:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_MISSION:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_MISSION:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_MISSION:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_MISSION:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_MISSION:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_MISSION:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_MISSION:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_MISSION:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_MISSION:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_MISSION:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_MISSION:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_MISSION:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_MISSION:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_MISSION:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_MISSION:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_MISSION:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_MISSION:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_MISSION:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_MISSION:Inherit(Child, Parent)

    		 -

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

    -

    MENU_MISSION:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_MISSION:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_MISSION:New()

    		 -

    BASE constructor.

    -

    MENU_MISSION:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_MISSION:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_MISSION:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_MISSION:OnEventCrash(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_MISSION:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_MISSION:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_MISSION:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_MISSION:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_MISSION:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_MISSION:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_MISSION:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_MISSION:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_MISSION:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_MISSION:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_MISSION:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_MISSION:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_MISSION:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_MISSION:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_MISSION:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_MISSION:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_MISSION:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_MISSION:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_MISSION:OnEventScore(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_MISSION:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_MISSION:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_MISSION:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_MISSION:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_MISSION:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_MISSION.Scheduler

    		 - -

    MENU_MISSION:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_MISSION:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_MISSION:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_MISSION:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_MISSION:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_MISSION:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_MISSION:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_MISSION:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_MISSION:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_MISSION:TraceOff()

    		 -

    Set trace off.

    -

    MENU_MISSION:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_MISSION:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_MISSION._

    		 - -

    MENU_MISSION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_MISSION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_MISSION.__

    		 - -

    MENU_MISSION:onEvent(event)

    		 -
    @@ -7958,8 +2517,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    MENU_MISSION_COMMAND , extends Core.Menu#MENU_COMMAND_BASE -, extends Core.Menu#MENU_BASE -, extends Core.Base#BASE
    @@ -7994,7 +2551,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - + @@ -8017,618 +2574,10 @@ If the arguments change, no new menu needs to be generated if the menu text is t - -
    Description

    MENU_MISSION_COMMAND.MenuCallHandler

    MENU_MISSION_COMMAND.MenuCallHandler()

    MENU_MISSION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    		 -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from MENU_BASEDescription

    MENU_MISSION_COMMAND:ClearParentMenu(MenuText)

    		 - -

    MENU_MISSION_COMMAND:GetMenu(MenuText)

    		 -

    Gets a Menu from a parent Menu

    -

    MENU_MISSION_COMMAND:GetStamp()

    		 -

    Gets a menu stamp for later prevention of menu removal.

    -

    MENU_MISSION_COMMAND.MenuRemoveParent

    		 - -

    MENU_MISSION_COMMAND.MenuStamp

    		 - -

    MENU_MISSION_COMMAND.MenuTag

    		 - -

    MENU_MISSION_COMMAND:New(MenuText, ParentMenu)

    		 -

    Constructor

    -

    MENU_MISSION_COMMAND:SetParentMenu(MenuText, Menu)

    		 - -

    MENU_MISSION_COMMAND:SetRemoveParent(RemoveParent)

    		 -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    -

    MENU_MISSION_COMMAND:SetStamp(MenuStamp)

    		 -

    Sets a menu stamp for later prevention of menu removal.

    -

    MENU_MISSION_COMMAND:SetTag(MenuTag)

    		 -

    Sets a tag for later selection of menu refresh.

    -

    MENU_MISSION_COMMAND:SetTime(MenuStamp)

    		 -

    Sets a time stamp for later prevention of menu removal.

    -
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Fields and Methods inherited from BASEDescription

    MENU_MISSION_COMMAND.ClassID

    		 -

    The ID number of the class.

    -

    MENU_MISSION_COMMAND.ClassName

    		 -

    The name of the class.

    -

    MENU_MISSION_COMMAND.ClassNameAndID

    		 -

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

    -

    MENU_MISSION_COMMAND:ClearState(Object, StateName)

    		 -

    Clear the state of an object.

    -

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

    		 -

    Creation of a Birth Event.

    -

    MENU_MISSION_COMMAND:CreateEventCrash(EventTime, Initiator)

    		 -

    Creation of a Crash Event.

    -

    MENU_MISSION_COMMAND:CreateEventDead(EventTime, Initiator)

    		 -

    Creation of a Dead Event.

    -

    MENU_MISSION_COMMAND:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 -

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    -

    MENU_MISSION_COMMAND:CreateEventRemoveUnit(EventTime, Initiator)

    		 -

    Creation of a Remove Unit Event.

    -

    MENU_MISSION_COMMAND:CreateEventTakeoff(EventTime, Initiator)

    		 -

    Creation of a Takeoff Event.

    -

    MENU_MISSION_COMMAND:E(Arguments)

    		 -

    Log an exception which will be traced always.

    -

    MENU_MISSION_COMMAND:EventDispatcher()

    		 -

    Returns the event dispatcher

    -

    MENU_MISSION_COMMAND:EventRemoveAll()

    		 -

    Remove all subscribed events

    -

    MENU_MISSION_COMMAND:F(Arguments)

    		 -

    Trace a function call.

    -

    MENU_MISSION_COMMAND:F2(Arguments)

    		 -

    Trace a function call level 2.

    -

    MENU_MISSION_COMMAND:F3(Arguments)

    		 -

    Trace a function call level 3.

    -

    MENU_MISSION_COMMAND:GetClassID()

    		 -

    Get the ClassID of the class instance.

    -

    MENU_MISSION_COMMAND:GetClassName()

    		 -

    Get the ClassName of the class instance.

    -

    MENU_MISSION_COMMAND:GetClassNameAndID()

    		 -

    Get the ClassName + ClassID of the class instance.

    -

    MENU_MISSION_COMMAND:GetEventPriority()

    		 -

    Get the Class Event processing Priority.

    -

    MENU_MISSION_COMMAND:GetParent(Child, FromClass)

    		 -

    This is the worker method to retrieve the Parent class.

    -

    MENU_MISSION_COMMAND:GetState(Object, Key)

    		 -

    Get a Value given a Key from the Object.

    -

    MENU_MISSION_COMMAND:HandleEvent(EventID, EventFunction)

    		 -

    Subscribe to a DCS Event.

    -

    MENU_MISSION_COMMAND:I(Arguments)

    		 -

    Log an information which will be traced always.

    -

    MENU_MISSION_COMMAND:Inherit(Child, Parent)

    		 -

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

    -

    MENU_MISSION_COMMAND:IsInstanceOf(ClassName)

    		 -

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

    -

    MENU_MISSION_COMMAND:IsTrace()

    		 -

    Enquires if tracing is on (for the class).

    -

    MENU_MISSION_COMMAND:New()

    		 -

    BASE constructor.

    -

    MENU_MISSION_COMMAND:OnEvent(EventData)

    		 -

    Occurs when an object is completely destroyed.

    -

    MENU_MISSION_COMMAND:OnEventBDA(EventData)

    		 -

    BDA.

    -

    MENU_MISSION_COMMAND:OnEventBaseCaptured(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventBirth(EventData)

    		 -

    Occurs when any object is spawned into the mission.

    -

    MENU_MISSION_COMMAND:OnEventCrash(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventDead(EventData)

    		 -

    Occurs when an object is dead.

    -

    MENU_MISSION_COMMAND:OnEventDetailedFailure(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventDiscardChairAfterEjection(EventData)

    		 -

    Discard chair after ejection.

    -

    MENU_MISSION_COMMAND:OnEventEjection(EventData)

    		 -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    -

    MENU_MISSION_COMMAND:OnEventEngineShutdown(EventData)

    		 -

    Occurs when any aircraft shuts down its engines.

    -

    MENU_MISSION_COMMAND:OnEventEngineStartup(EventData)

    		 -

    Occurs when any aircraft starts its engines.

    -

    MENU_MISSION_COMMAND:OnEventHit(EventData)

    		 -

    Occurs whenever an object is hit by a weapon.

    -

    MENU_MISSION_COMMAND:OnEventHumanFailure(EventData)

    		 -

    Occurs when any system fails on a human controlled aircraft.

    -

    MENU_MISSION_COMMAND:OnEventKill(EventData)

    		 -

    Occurs on the death of a unit.

    -

    MENU_MISSION_COMMAND:OnEventLand(EventData)

    		 -

    Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed.

    -

    MENU_MISSION_COMMAND:OnEventLandingAfterEjection(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventLandingQualityMark(EventData)

    		 -

    Landing quality mark.

    -

    MENU_MISSION_COMMAND:OnEventMarkAdded(EventData)

    		 -

    Occurs when a new mark was added.

    -

    MENU_MISSION_COMMAND:OnEventMarkChange(EventData)

    		 -

    Occurs when a mark text was changed.

    -

    MENU_MISSION_COMMAND:OnEventMarkRemoved(EventData)

    		 -

    Occurs when a mark was removed.

    -

    MENU_MISSION_COMMAND:OnEventMissionEnd(EventData)

    		 -

    Occurs when a mission ends.

    -

    MENU_MISSION_COMMAND:OnEventMissionStart(EventData)

    		 -

    Occurs when a mission starts.

    -

    MENU_MISSION_COMMAND:OnEventParatrooperLanding(EventData)

    		 -

    Weapon add.

    -

    MENU_MISSION_COMMAND:OnEventPilotDead(EventData)

    		 -

    Occurs when the pilot of an aircraft is killed.

    -

    MENU_MISSION_COMMAND:OnEventPlayerEnterAircraft(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventPlayerEnterUnit(EventData)

    		 -

    Occurs when any player assumes direct control of a unit.

    -

    MENU_MISSION_COMMAND:OnEventPlayerLeaveUnit(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventRefueling(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventRefuelingStop(EventData)

    		 -

    Occurs when an aircraft is finished taking fuel.

    -

    MENU_MISSION_COMMAND:OnEventScore(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventShootingEnd(EventData)

    		 -

    Occurs when any unit stops firing its weapon.

    -

    MENU_MISSION_COMMAND:OnEventShootingStart(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventShot(EventData)

    		 -

    Occurs whenever any unit in a mission fires a weapon.

    -

    MENU_MISSION_COMMAND:OnEventTakeoff(EventData)

    		 -

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

    -

    MENU_MISSION_COMMAND:OnEventTriggerZone(EventData)

    		 -

    Trigger zone.

    -

    MENU_MISSION_COMMAND:OnEventUnitLost(EventData)

    		 -

    Occurs when the game thinks an object is destroyed.

    -

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

    		 -

    Schedule a new time event.

    -

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

    		 -

    Schedule a new time event.

    -

    MENU_MISSION_COMMAND:ScheduleStop(SchedulerFunction)

    		 -

    Stops the Schedule.

    -

    MENU_MISSION_COMMAND.Scheduler

    		 - -

    MENU_MISSION_COMMAND:SetEventPriority(EventPriority)

    		 -

    Set the Class Event processing Priority.

    -

    MENU_MISSION_COMMAND:SetState(Object, Key, Value)

    		 -

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

    -

    MENU_MISSION_COMMAND:T(Arguments)

    		 -

    Trace a function logic level 1.

    -

    MENU_MISSION_COMMAND:T2(Arguments)

    		 -

    Trace a function logic level 2.

    -

    MENU_MISSION_COMMAND:T3(Arguments)

    		 -

    Trace a function logic level 3.

    -

    MENU_MISSION_COMMAND:TraceAll(TraceAll)

    		 -

    Trace all methods in MOOSE

    -

    MENU_MISSION_COMMAND:TraceClass(Class)

    		 -

    Set tracing for a class

    -

    MENU_MISSION_COMMAND:TraceClassMethod(Class, Method)

    		 -

    Set tracing for a specific method of class

    -

    MENU_MISSION_COMMAND:TraceLevel(Level)

    		 -

    Set trace level

    -

    MENU_MISSION_COMMAND:TraceOff()

    		 -

    Set trace off.

    -

    MENU_MISSION_COMMAND:TraceOn()

    		 -

    Set trace on.

    -

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

    -

    MENU_MISSION_COMMAND:UnHandleEvent(EventID)

    		 -

    UnSubscribe to a DCS event.

    -

    MENU_MISSION_COMMAND._

    		 - -

    MENU_MISSION_COMMAND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function call.

    -

    MENU_MISSION_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 -

    Trace a function logic.

    -

    MENU_MISSION_COMMAND.__

    		 - -

    MENU_MISSION_COMMAND:onEvent(event)

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

    self:F( { RemoveParent } )

    +

    self:F( { RemoveParent } )

    @@ -8685,3643 +2634,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Function(s)

    -
    - -
    -

    MENU_BASE:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_BASE:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

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

    MENU_BASE:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_BASE:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_BASE:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_BASE:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_BASE:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    Field(s)

    -
    -
    -
    - - -MENU_BASE.MenuRemoveParent - - - - -

    self:F( { RemoveParent } )

    - -
    - -
    -
    -
    - - -MENU_BASE.MenuStamp - - - -
    - -
    -
    -
    - - -MENU_BASE.MenuTag - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

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

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

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

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:CreateEventCrash(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.

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

    MENU_BASE:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

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

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

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

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

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

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

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

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

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

    MENU_BASE:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

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

    MENU_BASE:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

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

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

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

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

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

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

    MENU_BASE:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

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

    MENU_BASE:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

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

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

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

    MENU_BASE:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

    MENU_BASE:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

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

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

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

    MENU_BASE:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventBaseCaptured(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_BASE:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventCrash(EventData)

    -
    - -

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

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

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

    MENU_BASE:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

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

    MENU_BASE:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
      -
    • 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.

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

    MENU_BASE:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

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

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

    - -
      -
    • 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.

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

    MENU_BASE:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventPlayerEnterAircraft(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_BASE:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventPlayerLeaveUnit(EventData)

    -
    - -

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

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventRefueling(EventData)

    -
    - -

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

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventShootingStart(EventData)

    -
    - -

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

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

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

    MENU_BASE:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventTakeoff(EventData)

    -
    - -

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

    - - -

    initiator : The unit that took off. -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.

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

    MENU_BASE:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_BASE:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - -
      -
    • initiator: The unit that is was destroyed.
      • -
    - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

    MENU_BASE:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

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

    MENU_BASE:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

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

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

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

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

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

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

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

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

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

    MENU_BASE:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

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

    MENU_BASE:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_BASE:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_BASE: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_BASE:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

    MENU_BASE:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_BASE:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    -
    @@ -12521,3613 +2833,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
    -
    -

    Field(s)

    -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_COALITION:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

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

    MENU_COALITION:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    Field(s)

    -
    -
    -

    Function(s)

    -
    -
    - -
    -

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

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

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

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:CreateEventCrash(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.

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

    MENU_COALITION:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

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

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

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

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

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

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

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

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

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

    MENU_COALITION:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

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

    MENU_COALITION:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

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

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

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

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

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

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

    MENU_COALITION:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

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

    MENU_COALITION:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

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

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

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

    MENU_COALITION:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

    MENU_COALITION:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

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

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

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

    MENU_COALITION:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventBaseCaptured(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_COALITION:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventCrash(EventData)

    -
    - -

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

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

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

    MENU_COALITION:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

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

    MENU_COALITION:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
      -
    • 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.

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

    MENU_COALITION:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

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

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

    - -
      -
    • 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.

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

    MENU_COALITION:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventPlayerEnterAircraft(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_COALITION:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventPlayerLeaveUnit(EventData)

    -
    - -

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

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventRefueling(EventData)

    -
    - -

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

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventShootingStart(EventData)

    -
    - -

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

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

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

    MENU_COALITION:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventTakeoff(EventData)

    -
    - -

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

    - - -

    initiator : The unit that took off. -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.

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

    MENU_COALITION:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - -
      -
    • initiator: The unit that is was destroyed.
      • -
    - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

    MENU_COALITION:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

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

    MENU_COALITION:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

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

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

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

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

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

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

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

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

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

    MENU_COALITION:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

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

    MENU_COALITION:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_COALITION:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_COALITION: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

    MENU_COALITION:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    -
    @@ -16336,6 +3041,25 @@ When moose is loading dynamically (for moose class development), tracing is swit
    +
    +

    MENU_COALITION_COMMAND.MenuCallHandler()

    +
    + + + +
    +
    +

    Defined in:

    +
    +

    Core.Menu#MENU_COMMAND_BASE

    +
    +
    + +
    +
    + +
    +

    MENU_COALITION_COMMAND:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)

    @@ -16455,7 +3179,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_COALITION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -16493,3613 +3217,6 @@ If the function changes, no new menu needs to be generated if the menu text is t
    -
    -

    Field(s)

    -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_COALITION_COMMAND:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION_COMMAND:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

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

    MENU_COALITION_COMMAND:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION_COMMAND:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION_COMMAND:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION_COMMAND:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COALITION_COMMAND:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    Field(s)

    -
    -
    -

    Function(s)

    -
    -
    - -
    -

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

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

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

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:CreateEventCrash(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.

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

    MENU_COALITION_COMMAND:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

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

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

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

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

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

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

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

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

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

    MENU_COALITION_COMMAND:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

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

    MENU_COALITION_COMMAND:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

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

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

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

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

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

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

    MENU_COALITION_COMMAND:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

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

    MENU_COALITION_COMMAND:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

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

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

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

    MENU_COALITION_COMMAND:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

    MENU_COALITION_COMMAND:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

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

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

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

    MENU_COALITION_COMMAND:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventBaseCaptured(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_COALITION_COMMAND:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventCrash(EventData)

    -
    - -

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

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

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

    MENU_COALITION_COMMAND:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

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

    MENU_COALITION_COMMAND:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
      -
    • 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.

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

    MENU_COALITION_COMMAND:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

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

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

    - -
      -
    • 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.

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

    MENU_COALITION_COMMAND:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventPlayerEnterAircraft(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_COALITION_COMMAND:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventPlayerLeaveUnit(EventData)

    -
    - -

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

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventRefueling(EventData)

    -
    - -

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

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventShootingStart(EventData)

    -
    - -

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

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

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

    MENU_COALITION_COMMAND:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventTakeoff(EventData)

    -
    - -

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

    - - -

    initiator : The unit that took off. -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.

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

    MENU_COALITION_COMMAND:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COALITION_COMMAND:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - -
      -
    • initiator: The unit that is was destroyed.
      • -
    - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

    MENU_COALITION_COMMAND:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

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

    MENU_COALITION_COMMAND:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

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

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

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

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

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

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

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

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

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

    MENU_COALITION_COMMAND:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

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

    MENU_COALITION_COMMAND:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_COALITION_COMMAND:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_COALITION_COMMAND: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

    MENU_COALITION_COMMAND:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COALITION_COMMAND:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    -
    @@ -20109,22 +3226,30 @@ When moose is loading dynamically (for moose class development), tracing is swit

    Field(s)

    -
    -
    - - #function -MENU_COMMAND_BASE.MenuCallHandler - - - -
    - -

    Function(s)

    +
    +

    MENU_COMMAND_BASE.MenuCallHandler()

    +
    + + + +
    +
    +

    Defined in:

    +
    +

    MENU_COMMAND_BASE

    +
    +
    + +
    +
    + +
    +

    MENU_COMMAND_BASE:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)

    @@ -20244,7 +3369,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_COMMAND_BASE:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -20282,3635 +3407,6 @@ If the function changes, no new menu needs to be generated if the menu text is t
    -
    -

    Field(s)

    -
    -
    -
    - - #function -MENU_COMMAND_BASE.MenuCallHandler - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_COMMAND_BASE:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COMMAND_BASE:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

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

    MENU_COMMAND_BASE:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COMMAND_BASE:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COMMAND_BASE:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COMMAND_BASE:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_COMMAND_BASE:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    Field(s)

    -
    -
    -
    - - #function -MENU_COMMAND_BASE.MenuCallHandler - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

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

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

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

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:CreateEventCrash(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.

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

    MENU_COMMAND_BASE:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

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

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

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

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

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

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

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

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

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

    MENU_COMMAND_BASE:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

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

    MENU_COMMAND_BASE:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

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

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

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

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

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

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

    MENU_COMMAND_BASE:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

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

    MENU_COMMAND_BASE:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

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

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

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

    MENU_COMMAND_BASE:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

    MENU_COMMAND_BASE:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

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

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

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

    MENU_COMMAND_BASE:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventBaseCaptured(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_COMMAND_BASE:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventCrash(EventData)

    -
    - -

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

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

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

    MENU_COMMAND_BASE:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

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

    MENU_COMMAND_BASE:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
      -
    • 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.

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

    MENU_COMMAND_BASE:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

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

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

    - -
      -
    • 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.

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

    MENU_COMMAND_BASE:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventPlayerEnterAircraft(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_COMMAND_BASE:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventPlayerLeaveUnit(EventData)

    -
    - -

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

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventRefueling(EventData)

    -
    - -

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

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventShootingStart(EventData)

    -
    - -

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

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

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

    MENU_COMMAND_BASE:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventTakeoff(EventData)

    -
    - -

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

    - - -

    initiator : The unit that took off. -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.

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

    MENU_COMMAND_BASE:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_COMMAND_BASE:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - -
      -
    • initiator: The unit that is was destroyed.
      • -
    - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

    MENU_COMMAND_BASE:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

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

    MENU_COMMAND_BASE:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

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

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

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

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

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

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

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

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

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

    MENU_COMMAND_BASE:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

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

    MENU_COMMAND_BASE:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_COMMAND_BASE:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_COMMAND_BASE: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

    MENU_COMMAND_BASE:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_COMMAND_BASE:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    -
    @@ -24204,3640 +3700,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    Function(s)

    -
    - -
    -

    MENU_GROUP:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

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

    MENU_GROUP:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    Field(s)

    -
    -
    -
    - - -MENU_GROUP.Group - - - -
    - -
    -
    -
    - - -MENU_GROUP.GroupID - - - -
    - -
    -
    -
    - - -MENU_GROUP.MenuPath - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

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

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

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

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:CreateEventCrash(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.

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

    MENU_GROUP:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

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

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

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

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

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

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

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

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

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

    MENU_GROUP:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

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

    MENU_GROUP:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

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

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

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

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

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

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

    MENU_GROUP:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

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

    MENU_GROUP:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

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

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

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

    MENU_GROUP:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

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

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

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

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

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

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

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

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

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

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

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

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

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

    MENU_GROUP:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

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

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

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

    MENU_GROUP:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventBaseCaptured(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_GROUP:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventCrash(EventData)

    -
    - -

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

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

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

    MENU_GROUP:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

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

    MENU_GROUP:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
      -
    • 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.

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

    MENU_GROUP:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

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

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

    - -
      -
    • 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.

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

    MENU_GROUP:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventPlayerEnterAircraft(EventData)

    -
    - -

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

    - - -

    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.

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

    MENU_GROUP:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventPlayerLeaveUnit(EventData)

    -
    - -

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

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventRefueling(EventData)

    -
    - -

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

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventShootingStart(EventData)

    -
    - -

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

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

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

    MENU_GROUP:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventTakeoff(EventData)

    -
    - -

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

    - - -

    initiator : The unit that took off. -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.

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

    MENU_GROUP:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

    MENU_GROUP:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - -
      -
    • initiator: The unit that is was destroyed.
      • -
    - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

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

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

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

    MENU_GROUP:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

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

    MENU_GROUP:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

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

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

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

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

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

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

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

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

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

    MENU_GROUP:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

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

    MENU_GROUP:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_GROUP:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

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

    MENU_GROUP: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

    MENU_GROUP:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    -
    @@ -28109,6 +3971,25 @@ When moose is loading dynamically (for moose class development), tracing is swit
    +
    +

    MENU_GROUP_COMMAND.MenuCallHandler()

    +
    + + + +
    +
    +

    Defined in:

    +
    +

    Core.Menu#MENU_COMMAND_BASE

    +
    +
    + +
    +
    + +
    +

    MENU_GROUP_COMMAND:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)

    @@ -28228,7 +4109,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -28266,3679 +4147,6 @@ If the function changes, no new menu needs to be generated if the menu text is t
    -
    -

    Field(s)

    -
    -
    -
    - - -MENU_GROUP_COMMAND.Group - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND.GroupID - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND.MenuPath - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_GROUP_COMMAND:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP_COMMAND:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

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

    MENU_GROUP_COMMAND:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP_COMMAND:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP_COMMAND:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP_COMMAND:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    MENU_GROUP_COMMAND:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

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

    Field(s)

    -
    -
    -
    - - -MENU_GROUP_COMMAND.Group - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND.GroupID - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND.MenuPath - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

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

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

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

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:CreateEventCrash(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.

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

    MENU_GROUP_COMMAND:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

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

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

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

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

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

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

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

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

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

    MENU_GROUP_COMMAND:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

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

    MENU_GROUP_COMMAND:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

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

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

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

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

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

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

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

    MENU_GROUP_COMMAND:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

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

    MENU_GROUP_COMMAND:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

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

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

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventBaseCaptured(EventData)

    -
    - -

    Occurs when a ground unit captures either an airbase or a farp.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventCrash(EventData)

    -
    - -

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
      -
    • 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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
      -
    • 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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventPlayerEnterAircraft(EventData)

    -
    - -

    Occurs when a player enters a slot and takes control of an aircraft.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventPlayerLeaveUnit(EventData)

    -
    - -

    Occurs when any player relieves control of a unit to the AI.

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventRefueling(EventData)

    -
    - -

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventShootingStart(EventData)

    -
    - -

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventTakeoff(EventData)

    -
    - -

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    - - -

    initiator : The unit that took off. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - -
      -
    • initiator: The unit that is was destroyed.
      • -
    - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing Off
-BASE:TraceOff()
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing On
-BASE:TraceOn()
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    -
    @@ -32262,6 +4470,25 @@ When moose is loading dynamically (for moose class development), tracing is swit
    +
    +

    MENU_GROUP_COMMAND_DELAYED.MenuCallHandler()

    +
    + + + +
    +
    +

    Defined in:

    +
    +

    Core.Menu#MENU_COMMAND_BASE

    +
    +
    + +
    +
    + +
    +

    MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)

    @@ -32381,7 +4608,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_GROUP_COMMAND_DELAYED:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -32419,3701 +4646,6 @@ If the function changes, no new menu needs to be generated if the menu text is t -
    -

    Field(s)

    -
    -
    -
    - - -MENU_GROUP_COMMAND_DELAYED.Group - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND_DELAYED.GroupID - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND_DELAYED.MenuPath - - - -
    - -
    -
    -
    - - #boolean -MENU_GROUP_COMMAND_DELAYED.MenuSet - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    -

    Field(s)

    -
    -
    -
    - - -MENU_GROUP_COMMAND_DELAYED.Group - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND_DELAYED.GroupID - - - -
    - -
    -
    -
    - - -MENU_GROUP_COMMAND_DELAYED.MenuPath - - - -
    - -
    -
    -
    - - #boolean -MENU_GROUP_COMMAND_DELAYED.MenuSet - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventCrash(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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:IsInstanceOf(ClassName)

    -
    - -

    This is the worker method to check if an object is an (sub)instance of a class.

    - - - -

    Examples:

    - - - - -
    -
    -

    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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventBaseCaptured(EventData)

    -
    - -

    Occurs when a ground unit captures either an airbase or a farp.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventCrash(EventData)

    -
    - -

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventDetailedFailure(EventData)

    -
    - -

    Unknown precisely what creates this event, likely tied into newer damage model.

    - - -

    Will update this page when new information become available.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPlayerEnterAircraft(EventData)

    -
    - -

    Occurs when a player enters a slot and takes control of an aircraft.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventPlayerLeaveUnit(EventData)

    -
    - -

    Occurs when any player relieves control of a unit to the AI.

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventRefueling(EventData)

    -
    - -

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventShootingStart(EventData)

    -
    - -

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventTakeoff(EventData)

    -
    - -

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    - - -

    initiator : The unit that took off. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing Off
-BASE:TraceOff()
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing On
-BASE:TraceOn()
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_COMMAND_DELAYED:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    - @@ -36459,3651 +4991,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    Function(s)

    -
    - -
    -

    MENU_GROUP_DELAYED:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    -

    Field(s)

    -
    -
    -
    - - -MENU_GROUP_DELAYED.Group - - - -
    - -
    -
    -
    - - -MENU_GROUP_DELAYED.GroupID - - - -
    - -
    -
    -
    - - -MENU_GROUP_DELAYED.MenuPath - - - -
    - -
    -
    -
    - - #boolean -MENU_GROUP_DELAYED.MenuSet - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:CreateEventCrash(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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:IsInstanceOf(ClassName)

    -
    - -

    This is the worker method to check if an object is an (sub)instance of a class.

    - - - -

    Examples:

    - - - - -
    -
    -

    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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventBaseCaptured(EventData)

    -
    - -

    Occurs when a ground unit captures either an airbase or a farp.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventCrash(EventData)

    -
    - -

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventDetailedFailure(EventData)

    -
    - -

    Unknown precisely what creates this event, likely tied into newer damage model.

    - - -

    Will update this page when new information become available.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventPlayerEnterAircraft(EventData)

    -
    - -

    Occurs when a player enters a slot and takes control of an aircraft.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventPlayerLeaveUnit(EventData)

    -
    - -

    Occurs when any player relieves control of a unit to the AI.

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventRefueling(EventData)

    -
    - -

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventShootingStart(EventData)

    -
    - -

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventTakeoff(EventData)

    -
    - -

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    - - -

    initiator : The unit that took off. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing Off
-BASE:TraceOff()
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing On
-BASE:TraceOn()
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_GROUP_DELAYED:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    - @@ -40127,3809 +5014,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    Function(s)

    -
    - -
    -

    MENU_MISSION:New(MenuText, ParentMenu)

    -
    - -

    MENU_MISSION constructor.

    - - -

    Creates a new MENU_MISSION object and creates the menu for a complete mission file.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_MISSION

    -
    -

    Parameters:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text for the menu.

    - -
    -
    -
    -
    -

    - #table - ParentMenu -

    -
    -
    - -

    The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_MISSION:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:Refresh()

    -
    - -

    Refreshes a radio item for a mission

    - -
    -
    -

    Defined in:

    -
    -

    MENU_MISSION

    -
    -

    Return value:

    -
    -
    -

    #MENU_MISSION:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:Remove(MenuStamp, MenuTag)

    -
    - -

    Removes the main menu and the sub menus recursively of this MENU_MISSION.

    - -
    -
    -

    Defined in:

    -
    -

    MENU_MISSION

    -
    -

    Parameters:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -
    -
    -

    - MenuTag -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #nil:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:RemoveSubMenus()

    -
    - -

    Removes the sub menus recursively of this MENU_MISSION.

    - - -

    Note that the main menu is kept!

    - -
    -
    -

    Defined in:

    -
    -

    MENU_MISSION

    -
    -

    Return value:

    -
    -
    -

    #MENU_MISSION:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    -

    Field(s)

    -
    -
    -
    - - -MENU_MISSION.MenuPath - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_MISSION:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    -

    Field(s)

    -
    -
    -
    - - -MENU_MISSION.MenuPath - - - -
    - -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:CreateEventCrash(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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:IsInstanceOf(ClassName)

    -
    - -

    This is the worker method to check if an object is an (sub)instance of a class.

    - - - -

    Examples:

    - - - - -
    -
    -

    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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventBaseCaptured(EventData)

    -
    - -

    Occurs when a ground unit captures either an airbase or a farp.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventCrash(EventData)

    -
    - -

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventDetailedFailure(EventData)

    -
    - -

    Unknown precisely what creates this event, likely tied into newer damage model.

    - - -

    Will update this page when new information become available.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventPlayerEnterAircraft(EventData)

    -
    - -

    Occurs when a player enters a slot and takes control of an aircraft.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventPlayerLeaveUnit(EventData)

    -
    - -

    Occurs when any player relieves control of a unit to the AI.

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventRefueling(EventData)

    -
    - -

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventShootingStart(EventData)

    -
    - -

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventTakeoff(EventData)

    -
    - -

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    - - -

    initiator : The unit that took off. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing Off
-BASE:TraceOff()
    - -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing On
-BASE:TraceOn()
    - -
    - -
    -
    - -
    - -
    -

    MENU_MISSION: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    - @@ -44104,6 +5188,25 @@ When moose is loading dynamically (for moose class development), tracing is swit
    +
    +

    MENU_MISSION_COMMAND.MenuCallHandler()

    +
    + + + +
    +
    +

    Defined in:

    +
    +

    Core.Menu#MENU_COMMAND_BASE

    +
    +
    + +
    +
    + +
    +

    MENU_MISSION_COMMAND:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)

    @@ -44223,7 +5326,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t

    MENU_MISSION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)

    -

    This sets the new command function of a menu, +

    This sets the new command function of a menu, so that if a menu is regenerated, or if command function changes, that the function set for the menu is loosely coupled with the menu itself!!! If the function changes, no new menu needs to be generated if the menu text is the same!!!

    @@ -44261,3613 +5364,6 @@ If the function changes, no new menu needs to be generated if the menu text is t -
    -

    Field(s)

    -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_MISSION_COMMAND:ClearParentMenu(MenuText)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:GetMenu(MenuText)

    -
    - -

    Gets a Menu from a parent Menu

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuText -

    -
    -
    - -

    The text of the child menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:GetStamp()

    -
    - -

    Gets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Return value:

    -
    -
    -
    -
    - -

    MenuStamp

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:New(MenuText, ParentMenu)

    -
    - -

    Constructor

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - ParentMenu -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:SetParentMenu(MenuText, Menu)

    -
    - - - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameters:

    -
    -
    -

    - MenuText -

    -
    -
    -

    -
    -
    -
    -
    -

    - Menu -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:SetRemoveParent(RemoveParent)

    -
    - -

    Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - RemoveParent -

    -
    -
    - -

    If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:SetStamp(MenuStamp)

    -
    - -

    Sets a menu stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:SetTag(MenuTag)

    -
    - -

    Sets a tag for later selection of menu refresh.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - MenuTag -

    -
    -
    - -

    A Tag or Key that will filter only menu items set with this key.

    - -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:SetTime(MenuStamp)

    -
    - -

    Sets a time stamp for later prevention of menu removal.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Menu#MENU_BASE

    -
    -

    Parameter:

    -
    -
    -

    - MenuStamp -

    -
    -
    -

    -
    -
    -

    Return value:

    -
    -
    -

    #MENU_BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    -

    Field(s)

    -
    -
    -

    Function(s)

    -
    -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:CreateEventCrash(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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:CreateEventDead(EventTime, Initiator)

    -
    - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:EventDispatcher()

    -
    - -

    Returns the event dispatcher

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    Core.Event#EVENT:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:EventRemoveAll()

    -
    - -

    Remove all subscribed events

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:GetClassID()

    -
    - -

    Get the ClassID of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassID of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:GetClassName()

    -
    - -

    Get the ClassName of the class instance.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #string:

    -
    -
    - -

    The ClassName of the class instance.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:GetEventPriority()

    -
    - -

    Get the Class 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 Event processing Priority.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:IsInstanceOf(ClassName)

    -
    - -

    This is the worker method to check if an object is an (sub)instance of a class.

    - - - -

    Examples:

    - - - - -
    -
    -

    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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:IsTrace()

    -
    - -

    Enquires if tracing is on (for the class).

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Return value:

    -
    -
    -

    #boolean:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEvent(EventData)

    -
    - -

    Occurs when an object is completely destroyed.

    - - -

    initiator : The unit that is was destroyed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventBDA(EventData)

    -
    - -

    BDA.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventBaseCaptured(EventData)

    -
    - -

    Occurs when a ground unit captures either an airbase or a farp.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventBirth(EventData)

    -
    - -

    Occurs when any object is spawned into the mission.

    - - -

    initiator : The unit that was spawned.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventCrash(EventData)

    -
    - -

    Occurs when any aircraft crashes into the ground and is completely destroyed.

    - - -

    initiator : The unit that has crashed.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventDead(EventData)

    -
    - -

    Occurs when an object is dead.

    - - -

    initiator : The unit that is dead.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventDetailedFailure(EventData)

    -
    - -

    Unknown precisely what creates this event, likely tied into newer damage model.

    - - -

    Will update this page when new information become available.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventDiscardChairAfterEjection(EventData)

    -
    - -

    Discard chair after ejection.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventEjection(EventData)

    -
    - -

    Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventEngineShutdown(EventData)

    -
    - -

    Occurs when any aircraft shuts down its engines.

    - - -

    initiator : The unit that is stopping its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventEngineStartup(EventData)

    -
    - -

    Occurs when any aircraft starts its engines.

    - - -

    initiator : The unit that is starting its engines..

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventHit(EventData)

    -
    - -

    Occurs whenever an object is hit by a weapon.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventHumanFailure(EventData)

    -
    - -

    Occurs when any system fails on a human controlled aircraft.

    - - -

    initiator : The unit that had the failure.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventLand(EventData)

    -
    - -

    Occurs when an aircraft lands at an airbase, farp or ship -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventLandingQualityMark(EventData)

    -
    - -

    Landing quality mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventMarkAdded(EventData)

    -
    - -

    Occurs when a new mark was added.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventMarkChange(EventData)

    -
    - -

    Occurs when a mark text was changed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventMarkRemoved(EventData)

    -
    - -

    Occurs when a mark was removed.

    - - -

    MarkID: ID of the mark.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventMissionEnd(EventData)

    -
    - -

    Occurs when a mission ends.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventMissionStart(EventData)

    -
    - -

    Occurs when a mission starts.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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. -initiator : The unit that the pilot has died in.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventPlayerEnterAircraft(EventData)

    -
    - -

    Occurs when a player enters a slot and takes control of an aircraft.

    - - -

    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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventPlayerEnterUnit(EventData)

    -
    - -

    Occurs when any player assumes direct control of a unit.

    - - -

    initiator : The unit that is being taken control of.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventPlayerLeaveUnit(EventData)

    -
    - -

    Occurs when any player relieves control of a unit to the AI.

    - - -

    initiator : The unit that the player left.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventRefueling(EventData)

    -
    - -

    Occurs when an aircraft connects with a tanker and begins taking on fuel.

    - - -

    initiator : The unit that is receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventRefuelingStop(EventData)

    -
    - -

    Occurs when an aircraft is finished taking fuel.

    - - -

    initiator : The unit that was receiving fuel.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventShootingEnd(EventData)

    -
    - -

    Occurs when any unit stops firing its weapon.

    - - -

    Event will always correspond with a shooting start event. -initiator : The unit that was doing the shooting.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventShootingStart(EventData)

    -
    - -

    Occurs when any unit begins firing a weapon that has a high rate of fire.

    - - -

    Most common with aircraft cannons (GAU-8), auto cannons, and machine guns. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventShot(EventData)

    -
    - -

    Occurs whenever any unit in a mission fires a weapon.

    - - -

    But not any machine gun or auto cannon based weapon, those are handled by EVENT.ShootingStart.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventTakeoff(EventData)

    -
    - -

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    - - -

    initiator : The unit that took off. -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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventTriggerZone(EventData)

    -
    - -

    Trigger zone.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:OnEventUnitLost(EventData)

    -
    - -

    Occurs when the game thinks an object is destroyed.

    - - - - - - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTDATA - EventData -

    -
    -
    - -

    The EventData structure.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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:

    -
    -
    -

    #number:

    -
    -
    - -

    The ScheduleID of the planned schedule.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:ScheduleStop(SchedulerFunction)

    -
    - -

    Stops the Schedule.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #function - SchedulerFunction -

    -
    -
    - -

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:SetEventPriority(EventPriority)

    -
    - -

    Set the Class 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 Event processing Priority.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - -

    self

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:TraceAll(TraceAll)

    -
    - -

    Trace all methods in MOOSE

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #boolean - TraceAll -

    -
    -
    - -

    true = trace all methods in MOOSE.

    - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:TraceClass(Class)

    -
    - -

    Set tracing for a class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:TraceClassMethod(Class, Method)

    -
    - -

    Set tracing for a specific method of class

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - #string - Class -

    -
    -
    -

    -
    -
    -
    -
    -

    - #string - Method -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:TraceLevel(Level)

    -
    - -

    Set trace level

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - #number - Level -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:TraceOff()

    -
    - -

    Set trace off.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing Off
-BASE:TraceOff()
    - -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:TraceOn()

    -
    - -

    Set trace on.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Usage:

    - 
    -- Switch the tracing On
-BASE:TraceOn()
    - -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND: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 )
-
    - -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:UnHandleEvent(EventID)

    -
    - -

    UnSubscribe to a DCS event.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - Core.Event#EVENTS - EventID -

    -
    -
    - -

    Event ID.

    - -
    -
    -

    Return value:

    -
    -
    -

    #BASE:

    -
    -
    - - - -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:_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 -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    -
    - -

    Trace a function logic.

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameters:

    -
    -
    -

    - Arguments -

    -
    -
    - -

    A #table or any field.

    - -
    -
    -
    -
    -

    - DebugInfoCurrentParam -

    -
    -
    -

    -
    -
    -
    -
    -

    - DebugInfoFromParam -

    -
    -
    -

    -
    -
    -
    - -
    -
    - -
    - -
    -

    MENU_MISSION_COMMAND:onEvent(event)

    -
    - - - - -

    TODO: Complete DCS#Event structure. -- The main event handling function... This function captures all events generated for the class. - @param #BASE self - @param DCS#Event event

    - -
    -
    -

    Defined in:

    -
    -

    Core.Base#BASE

    -
    -

    Parameter:

    -
    -
    -

    - event -

    -
    -
    -

    -
    -
    -
    - -
    -
    - diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index bd3e77e93..d1c66c9f5 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2714,7 +2714,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #string SETTINGS.A2ASystem @@ -4808,7 +4808,7 @@ It is advised to use this method at the start of the mission.

    - + #string SETTINGS.A2ASystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 1ff3c4e67..c07492ba1 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2729,36 +2729,6 @@ and any spaces before and after the resulting name are removed.

    SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

    - - - -

    SPAWN.communication

    - - - - - -

    SPAWN.frequency

    - - - - - -

    SPAWN.livery_id

    - - - - - -

    SPAWN.modulation

    - - - - - -

    SPAWN.uncontrolled

    - - @@ -3310,11 +3280,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean SPAWN.AIOnOff + +

    The AI is on by default when spawning a group.

    +
    @@ -3387,6 +3360,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

    Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

    +
    @@ -3478,17 +3454,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
    - -
    -
    -
    - - -SPAWN.SpawnGrouping - - -
    @@ -3613,6 +3578,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.

    +
    @@ -3624,27 +3603,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - -SPAWN.SpawnInitModex - - - -
    - -
    -
    -
    - - #string -SPAWN.SpawnInitSkill - - +

    By default, no InitLimit

    @@ -3677,7 +3637,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #number SPAWN.SpawnMaxGroups @@ -3691,7 +3651,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #number SPAWN.SpawnMaxUnitsAlive @@ -3837,6 +3797,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
    + +
    +
    +
    + + #boolean +SPAWN.SpawnUnControlled + + +
    @@ -3901,61 +3872,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

    -
    - -
    -
    -
    - - -SPAWN.communication - - - -
    - -
    -
    -
    - - -SPAWN.frequency - - - -
    - -
    -
    -
    - - -SPAWN.livery_id - - - -
    - -
    -
    -
    - - -SPAWN.modulation - - - -
    - -
    -
    -
    - - -SPAWN.uncontrolled - - -
    @@ -8721,11 +8637,14 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - + #boolean SPAWN.AIOnOff + +

    The AI is on by default when spawning a group.

    +
    @@ -8798,6 +8717,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

    + @@ -8889,17 +8811,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - - -
    -
    - - -SPAWN.SpawnGrouping - - -
    @@ -9024,6 +8935,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.

    +
    @@ -9035,27 +8960,8 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - - -
    -
    - -SPAWN.SpawnInitModex - - - -
    - -
    -
    -
    - - #string -SPAWN.SpawnInitSkill - - +

    By default, no InitLimit

    @@ -9088,7 +8994,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - + #number SPAWN.SpawnMaxGroups @@ -9102,7 +9008,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - + #number SPAWN.SpawnMaxUnitsAlive @@ -9248,6 +9154,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    + +
    +
    +
    + + #boolean +SPAWN.SpawnUnControlled + + +
    @@ -9312,61 +9229,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

    -
    - -
    -
    -
    - - -SPAWN.communication - - - -
    - -
    -
    -
    - - -SPAWN.frequency - - - -
    - -
    -
    -
    - - -SPAWN.livery_id - - - -
    - -
    -
    -
    - - -SPAWN.modulation - - - -
    - -
    -
    -
    - - -SPAWN.uncontrolled - - -
    diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index a09822339..41988fee0 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2669,6 +2669,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPOT.ScheduleID + + + +
    + +
    +
    +
    + + +SPOT.SpotIR + + + +
    + +
    +
    +
    + + +SPOT.SpotLaser + + +
    @@ -3882,6 +3915,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPOT.ScheduleID + + + +
    + +
    +
    +
    + + +SPOT.SpotIR + + + +
    + +
    +
    +
    + + +SPOT.SpotLaser + + +
    @@ -5386,6 +5452,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPOT.ScheduleID + + + +
    + +
    +
    +
    + + +SPOT.SpotIR + + + +
    + +
    +
    +
    + + +SPOT.SpotLaser + + +
    diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 7b6d1f800..faf978bb7 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18890,6 +18890,28 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
    +
    + + #number +DETECTION_BASE.DetectedItemCount + + + +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemMax + + +
    @@ -19039,7 +19061,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
    - #number + DETECTION_BASE.RefreshTimeInterval @@ -23581,6 +23603,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemCount + + + +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemMax + + +
    @@ -23730,7 +23774,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    - #number + DETECTION_BASE.RefreshTimeInterval @@ -25327,6 +25371,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemCount + + + +
    + +
    +
    +
    + + #number +DETECTION_BASE.DetectedItemMax + + +
    @@ -25476,7 +25542,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    - #number + DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index 5ac6964ed..20e252425 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -3334,9 +3334,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

    switch alarm state RED

    -
    @@ -6988,9 +6985,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` - -

    switch alarm state RED

    - diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index c766a47ad..618db0df7 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -2147,6 +2147,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Field(s)

    +
    +
    + + #number +MOVEMENT.AliveUnits + + + + +

    Contains the counter how many units are currently alive

    + +
    + +
    @@ -2377,6 +2391,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Field(s)

    +
    +
    + + #number +MOVEMENT.AliveUnits + + + + +

    Contains the counter how many units are currently alive

    + +
    + +
    diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index 79859788c..a88353b22 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -3358,6 +3358,12 @@ manager:Stop(7200)

    RAT.termtype

    Type of terminal to be used when spawning at an airbase.

    + + + +

    RAT.type

    + + @@ -4319,36 +4325,6 @@ and any spaces before and after the resulting name are removed.

    RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

    - - - -

    RAT.communication

    - - - - - -

    RAT.frequency

    - - - - - -

    RAT.livery_id

    - - - - - -

    RAT.modulation

    - - - - - -

    RAT.uncontrolled

    - - @@ -6718,6 +6694,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Type of terminal to be used when spawning at an airbase.

    +
    + +
    +
    +
    + + +RAT.type + + +
    @@ -14598,6 +14585,17 @@ Initializes the ratcraft array and group menu.

    Type of terminal to be used when spawning at an airbase.

    +
    + +
    +
    +
    + + +RAT.type + + +
    @@ -20559,6 +20557,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    Type of terminal to be used when spawning at an airbase.

    + + + +
    +
    + + +RAT.type + + +
    diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index d7fa0c75e..41ae0a770 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -38755,7 +38755,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

    Set case of f

    +

    Set case to that of lead.

    @@ -38824,7 +38824,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.

    @@ -38837,17 +38837,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    Data table at each position in the groove. Elements are of type AIRBOSS.GrooveData.

    - - - -
    -
    - - #boolean -AIRBOSS.PlayerData.holding - - -
    @@ -38983,9 +38972,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

    Set section lead of player flight.

    - @@ -39008,9 +38994,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

    Set Stable Hover

    - @@ -39044,6 +39027,9 @@ When moose is loading dynamically (for moose class development), tracing is swit + +

    Set new time stamp.

    + diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 9faed9d2a..fd35f2030 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2292,12 +2292,6 @@ Create a late-activated single infantry unit as template in the mission editor a

    CSAR.inTransitGroups

    - - - -

    CSAR.index

    - - @@ -3695,11 +3689,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.allheligroupset + +

    GROUP_SET of all helis

    +
    @@ -3905,11 +3902,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.csarUnits + +

    table of CSAR unit names

    +
    @@ -3930,11 +3930,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.downedPilots + +

    Replacement woundedGroups

    + +
    + +
    +
    +
    + + #number +CSAR.downedpilotcounter + + +
    @@ -4033,17 +4047,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 - - -
    @@ -4241,6 +4244,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
    +
    + + #number +CSAR.rescuedpilots + + + + +

    counter for saved pilots

    + +
    +
    @@ -4266,6 +4283,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescues + + + + +

    counter for successful rescue landings at FARP/AFB/MASH

    + +
    +
    @@ -8501,11 +8532,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.allheligroupset + +

    GROUP_SET of all helis

    +
    @@ -8711,11 +8745,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.csarUnits + +

    table of CSAR unit names

    +
    @@ -8736,11 +8773,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.downedPilots + +

    Replacement woundedGroups

    + +
    + +
    +
    +
    + + #number +CSAR.downedpilotcounter + + +
    @@ -8839,17 +8890,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 - - -
    @@ -9047,6 +9087,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
    +
    + + #number +CSAR.rescuedpilots + + + + +

    counter for saved pilots

    + +
    +
    @@ -9072,6 +9126,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescues + + + + +

    counter for successful rescue landings at FARP/AFB/MASH

    + +
    +
    @@ -10800,11 +10868,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.allheligroupset + +

    GROUP_SET of all helis

    +
    @@ -11010,11 +11081,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.csarUnits + +

    table of CSAR unit names

    +
    @@ -11035,11 +11109,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.downedPilots + +

    Replacement woundedGroups

    + +
    + +
    +
    +
    + + #number +CSAR.downedpilotcounter + + +
    @@ -11138,17 +11226,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 - - -
    @@ -11346,6 +11423,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
    +
    + + #number +CSAR.rescuedpilots + + + + +

    counter for saved pilots

    + +
    +
    @@ -11371,6 +11462,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescues + + + + +

    counter for successful rescue landings at FARP/AFB/MASH

    + +
    +
    diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 5f05ab389..1b616b136 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -6948,7 +6948,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.CtldUnits @@ -7031,7 +7031,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.FreeFMFrequencies @@ -14472,7 +14472,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.CtldUnits @@ -14555,7 +14555,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.FreeFMFrequencies @@ -16837,7 +16837,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.CtldUnits @@ -16920,7 +16920,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.FreeFMFrequencies @@ -29238,17 +29238,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

    template for a group of 10 paratroopers

    -
    - -
    -
    -
    - - #number -CTLD_HERCULES.j - - -
    @@ -30485,17 +30474,6 @@ Expected template names are the ones in the rounded brackets.

    template for a group of 10 paratroopers

    -
    - -
    -
    -
    - - #number -CTLD_HERCULES.j - - -
    diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index b008311e8..4a6038ba4 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2820,6 +2820,17 @@ but can separately be modified later in your mission using the +
    + +
    +
    +
    + + +TASK.TaskControlMenu + + +
    @@ -7456,6 +7467,17 @@ If the Unit is part of the Task, true is returned.

    +
    + +
    +
    +
    + + +TASK.TaskControlMenu + + +
    diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 0a4ca9a12..a4ec41421 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2813,7 +2813,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -3538,7 +3538,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    - + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -4714,7 +4714,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    - + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -6196,7 +6196,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    - + #boolean TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index 3706ef23d..9d0f09a1e 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -3083,11 +3083,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    @@ -3660,11 +3663,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    @@ -4847,11 +4853,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    @@ -6340,11 +6349,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    diff --git a/Documentation/Tasking.Task_Cargo.html b/Documentation/Tasking.Task_Cargo.html index bf7f9d8cc..bca37a61e 100644 --- a/Documentation/Tasking.Task_Cargo.html +++ b/Documentation/Tasking.Task_Cargo.html @@ -3113,22 +3113,11 @@ based on the tasking capabilities defined in
    - Cargo.Cargo#CARGO + FSM_PROCESS.Cargo -
    - -
    -
    -
    - - -FSM_PROCESS.DeployZone - - -
    @@ -3161,7 +3150,7 @@ based on the tasking capabilities defined in
    - + #number TASK_CARGO.CargoLimit @@ -4583,7 +4572,7 @@ based on the tasking capabilities defined in
    - + #number TASK_CARGO.CargoLimit @@ -9115,7 +9104,7 @@ If the Unit is part of the Task, true is returned.

    - + #number TASK_CARGO.CargoLimit diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index f7a0fc7f0..143ad93b3 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3091,54 +3091,21 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -TASK_CARGO_DISPATCHER.CSARBriefing - - - -
    - -
    - - -
    -
    - - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
    - -
    - + @@ -4203,54 +4170,21 @@ This method can only be used once!

    -TASK_CARGO_DISPATCHER.CSARBriefing - - - -
    - -
    - - -
    -
    - - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
    - -
    - + @@ -5094,54 +5028,21 @@ This method can only be used once!

    -TASK_CARGO_DISPATCHER.CSARBriefing - - - -
    - -
    - - -
    -
    - - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
    - -
    - + @@ -6620,54 +6521,21 @@ This method can only be used once!

    -TASK_CARGO_DISPATCHER.CSARBriefing - - - -
    - -
    - - -
    -
    - - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
    - -
    - + diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 441a7b527..c5cdda6ed 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4243,7 +4243,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    Alive2.

    +

    Alive.

    @@ -5357,7 +5357,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    Alive2.

    +

    Alive.

    @@ -7621,7 +7621,7 @@ If the Unit is alive but not active, false is returned.

    -

    Alive2.

    +

    Alive.

    @@ -16310,7 +16310,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of -

    Alive2.

    +

    Alive.

    @@ -19969,7 +19969,7 @@ Coordinates are dependent on the position of the maps origin.

    -

    Alive2.

    +

    Alive.

    @@ -20643,7 +20643,7 @@ If the Identifiable is alive, true is returned.

    -

    Alive2.

    +

    Alive.

    @@ -20923,7 +20923,7 @@ If the Identifiable is alive, true is returned.

    -

    Alive2.

    +

    Alive.

    diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index fbab0cfe3..1ab53e1ee 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -4775,18 +4775,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    -GROUP.InitRespawnRandomizePositionInner - - - -
    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -8975,18 +8964,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
    -GROUP.InitRespawnRandomizePositionInner - - - -
    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -17655,18 +17633,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
    -GROUP.InitRespawnRandomizePositionInner - - - -
    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21305,18 +21272,7 @@ Coordinates are dependent on the position of the maps origin.

    -GROUP.InitRespawnRandomizePositionInner - - - -
    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -21970,18 +21926,7 @@ If the Identifiable is alive, true is returned.

    -GROUP.InitRespawnRandomizePositionInner - - - -
    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone @@ -22241,18 +22186,7 @@ If the Identifiable is alive, true is returned.

    -GROUP.InitRespawnRandomizePositionInner - - - -
    - -
    -
    -
    - - -GROUP.InitRespawnRandomizePositionOuter +GROUP.InitRespawnRandomizePositionZone diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 64ca99d84..29be84504 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -2897,6 +2897,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Coordinate of the mark.

    +
    + +
    +
    +
    + + +MARKER.groupid + + + +
    + +
    +
    +
    + + +MARKER.groupname + + +
    @@ -2974,28 +2996,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Text displayed in the mark panel.

    -
    - -
    -
    -
    - - #boolean -MARKER.toall - - - -
    - -
    -
    -
    - - #boolean -MARKER.tocoalition - - -
    @@ -5003,6 +5003,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Coordinate of the mark.

    +
    + +
    +
    +
    + + +MARKER.groupid + + + +
    + +
    +
    +
    + + +MARKER.groupname + + +
    @@ -5080,28 +5102,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Text displayed in the mark panel.

    -
    - -
    -
    -
    - - #boolean -MARKER.toall - - - -
    - -
    -
    -
    - - #boolean -MARKER.tocoalition - - -
    @@ -6617,6 +6617,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Coordinate of the mark.

    +
    + +
    +
    +
    + + +MARKER.groupid + + + +
    + +
    +
    +
    + + +MARKER.groupname + + +
    @@ -6694,28 +6716,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Text displayed in the mark panel.

    -
    - -
    -
    -
    - - #boolean -MARKER.toall - - - -
    - -
    -
    -
    - - #boolean -MARKER.tocoalition - - -
    diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index a83daeb86..f3544e87e 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3515,6 +3515,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + Core.Spot#SPOT +POSITIONABLE.Spot + + +
    @@ -7077,6 +7088,17 @@ Coordinates are dependent on the position of the maps origin.

    + + + +
    +
    + + Core.Spot#SPOT +POSITIONABLE.Spot + + +
    @@ -7654,6 +7676,17 @@ If the Identifiable is alive, true is returned.

    + + + +
    +
    + + Core.Spot#SPOT +POSITIONABLE.Spot + + +
    @@ -7837,6 +7870,17 @@ If the Identifiable is alive, true is returned.

    + + + +
    +
    + + Core.Spot#SPOT +POSITIONABLE.Spot + + +