The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +The Defender Default Settings over all Squadrons.
+ + + +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.self.CargoObject:Destroy()
- -self.CargoObject:Destroy()
- -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-
+-
Defines the main MENU class where other MENU classes are derived from.
+Defines the main MENU class where other MENU classes are derived from.
- -This is an abstract class, so don't use it.
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.
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 remoManages the main menus for a complete 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.
| Fields and Methods inherited from MENU_BASE | Description | -||
|---|---|---|---|
| - | - - | -||
| - | - - | -||
| - |
- Gets a menu stamp for later prevention of menu removal. - |
- ||
| @@ -1978,570 +1951,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde | - | -||
| - |
- Constructor - |
- ||
| - | - - | -||
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
- ||
| - |
- Sets a menu stamp for later prevention of menu removal. - |
- ||
| - |
- Sets a tag for later selection of menu refresh. - |
- ||
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
| - |
- Creation of a |
-
| - |
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
| - |
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- Occurs when the game thinks an object is destroyed. - |
-
| - |
- Schedule a new time event. - |
-
MENU_BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
-
- Schedule a new time event. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
|
Removes the sub menus recursively of this MENU_COALITION. - |
-
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_COALITION:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
| - |
- Creation of a |
-
| - |
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
| - |
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- Occurs when the game thinks an object is destroyed. - |
-
| - |
- Schedule a new time event. - |
-
MENU_COALITION:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
-
- Schedule a new time event. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_COALITION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_COALITION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Description | ||
|---|---|---|
| + | @@ -3263,618 +2060,10 @@ 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!!! - |
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- 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 |
-
MENU_COALITION_COMMAND:CreateEventRemoveUnit(EventTime, Initiator) |
-
- Creation of a Remove Unit Event. - |
-
MENU_COALITION_COMMAND:CreateEventTakeoff(EventTime, Initiator) |
-
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
MENU_COALITION_COMMAND:OnEventDiscardChairAfterEjection(EventData) |
-
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- 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. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- 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. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- 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. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_COALITION_COMMAND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_COALITION_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Description | ||
|---|---|---|
| + | @@ -3916,618 +2103,10 @@ 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!!! - |
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_COMMAND_BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
MENU_COMMAND_BASE:CreateEventPlayerEnterAircraft(PlayerUnit) |
-
- Creation of a |
-
MENU_COMMAND_BASE:CreateEventRemoveUnit(EventTime, Initiator) |
-
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
MENU_COMMAND_BASE:OnEventDiscardChairAfterEjection(EventData) |
-
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- 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. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_COMMAND_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_COMMAND_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Fields and Methods inherited from MENU_BASE | Description | -||
|---|---|---|---|
| - | - - | -||
| - | - - | -||
| - |
- Gets a menu stamp for later prevention of menu removal. - |
- ||
| @@ -4635,570 +2195,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau | - | -||
| - |
- Constructor - |
- ||
| - | - - | -||
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
- ||
| - |
- Sets a menu stamp for later prevention of menu removal. - |
- ||
| - |
- Sets a tag for later selection of menu refresh. - |
- ||
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_GROUP:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
| - |
- Creation of a |
-
| - |
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
| - |
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- Occurs when the game thinks an object is destroyed. - |
-
| - |
- Schedule a new time event. - |
-
MENU_GROUP:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
-
- Schedule a new time event. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_GROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_GROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Description | ||
|---|---|---|
| + | @@ -5285,618 +2279,10 @@ 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!!! - |
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_GROUP_COMMAND:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
MENU_GROUP_COMMAND:CreateEventPlayerEnterAircraft(PlayerUnit) |
-
- Creation of a |
-
MENU_GROUP_COMMAND:CreateEventRemoveUnit(EventTime, Initiator) |
-
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
MENU_GROUP_COMMAND:OnEventDiscardChairAfterEjection(EventData) |
-
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- 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. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_GROUP_COMMAND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_GROUP_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Description | ||
|---|---|---|
| + | @@ -5995,618 +2379,10 @@ 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!!! - |
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- 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 |
-
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. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
MENU_GROUP_COMMAND_DELAYED:HandleEvent(EventID, EventFunction) |
-
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- 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. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- 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. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
MENU_GROUP_COMMAND_DELAYED:OnEventParatrooperLanding(EventData) |
-
- Weapon add. - |
-
| - |
- 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. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- Occurs when the game thinks an object is destroyed. - |
-
MENU_GROUP_COMMAND_DELAYED:ScheduleOnce(Start, SchedulerFunction, ...) |
-
- Schedule a new time event. - |
-
| - |
- Schedule a new time event. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_GROUP_COMMAND_DELAYED:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_GROUP_COMMAND_DELAYED:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Fields and Methods inherited from MENU_BASE | Description | -||
|---|---|---|---|
| - | - - | -||
| - | - - | -||
| - |
- Gets a menu stamp for later prevention of menu removal. - |
- ||
| @@ -6726,570 +2483,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau | - | -||
| - |
- Constructor - |
- ||
| - | - - | -||
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
- ||
| - |
- Sets a menu stamp for later prevention of menu removal. - |
- ||
| - |
- Sets a tag for later selection of menu refresh. - |
- ||
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_GROUP_DELAYED:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
MENU_GROUP_DELAYED:CreateEventPlayerEnterAircraft(PlayerUnit) |
-
- Creation of a |
-
MENU_GROUP_DELAYED:CreateEventRemoveUnit(EventTime, Initiator) |
-
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
MENU_GROUP_DELAYED:OnEventDiscardChairAfterEjection(EventData) |
-
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- 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. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_GROUP_DELAYED:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_GROUP_DELAYED:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| - | - -|
| - |
- MENU_MISSION constructor. - |
-
| - |
- Refreshes a radio item for a mission - |
-
| - |
- Removes the main menu and the sub menus recursively of this MENU_MISSION. - |
-
| - |
- Removes the sub menus recursively of this MENU_MISSION. - |
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_MISSION:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
| - |
- Creation of a |
-
| - |
- Creation of a Remove Unit Event. - |
-
| - |
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
| - |
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- Occurs when the game thinks an object is destroyed. - |
-
| - |
- Schedule a new time event. - |
-
MENU_MISSION:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
-
- Schedule a new time event. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_MISSION:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_MISSION:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
| Description | ||
|---|---|---|
| + | @@ -8017,618 +2574,10 @@ 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!!! - |
-
| Fields and Methods inherited from MENU_BASE | -Description | -
|---|---|
| - | - - | -
| - | - - | -
| - |
- Gets a menu stamp for later prevention of menu removal. - |
-
| - | - - | -
| - | - - | -
| - | - - | -
| - |
- Constructor - |
-
| - | - - | -
| - |
- Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu. - |
-
| - |
- Sets a menu stamp for later prevention of menu removal. - |
-
| - |
- Sets a tag for later selection of menu refresh. - |
-
| - |
- Sets a time stamp for later prevention of menu removal. - |
-
| Fields and Methods inherited from BASE | -Description | -
|---|---|
| - |
- The ID number of the class. - |
-
| - |
- The name of the class. - |
-
| - |
- The name of the class concatenated with the ID number of the class. - |
-
| - |
- Clear the state of an object. - |
-
MENU_MISSION_COMMAND:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
-
- Creation of a Birth Event. - |
-
| - |
- Creation of a Crash Event. - |
-
| - |
- Creation of a Dead Event. - |
-
MENU_MISSION_COMMAND:CreateEventPlayerEnterAircraft(PlayerUnit) |
-
- Creation of a |
-
MENU_MISSION_COMMAND:CreateEventRemoveUnit(EventTime, Initiator) |
-
- Creation of a Remove Unit Event. - |
-
MENU_MISSION_COMMAND:CreateEventTakeoff(EventTime, Initiator) |
-
- Creation of a Takeoff Event. - |
-
| - |
- Log an exception which will be traced always. - |
-
| - |
- Returns the event dispatcher - |
-
| - |
- Remove all subscribed events - |
-
| - |
- Trace a function call. - |
-
| - |
- Trace a function call level 2. - |
-
| - |
- Trace a function call level 3. - |
-
| - |
- Get the ClassID of the class instance. - |
-
| - |
- Get the ClassName of the class instance. - |
-
| - |
- Get the ClassName + ClassID of the class instance. - |
-
| - |
- Get the Class Event processing Priority. - |
-
| - |
- This is the worker method to retrieve the Parent class. - |
-
| - |
- Get a Value given a Key from the Object. - |
-
| - |
- Subscribe to a DCS Event. - |
-
| - |
- Log an information which will be traced always. - |
-
| - |
- This is the worker method to inherit from a parent class. - |
-
| - |
- This is the worker method to check if an object is an (sub)instance of a class. - |
-
| - |
- Enquires if tracing is on (for the class). - |
-
| - |
- BASE constructor. - |
-
| - |
- Occurs when an object is completely destroyed. - |
-
| - |
- BDA. - |
-
| - |
- Occurs when a ground unit captures either an airbase or a farp. - |
-
| - |
- Occurs when any object is spawned into the mission. - |
-
| - |
- Occurs when any aircraft crashes into the ground and is completely destroyed. - |
-
| - |
- Occurs when an object is dead. - |
-
| - |
- Unknown precisely what creates this event, likely tied into newer damage model. - |
-
MENU_MISSION_COMMAND:OnEventDiscardChairAfterEjection(EventData) |
-
- Discard chair after ejection. - |
-
| - |
- Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected - |
-
| - |
- Occurs when any aircraft shuts down its engines. - |
-
| - |
- Occurs when any aircraft starts its engines. - |
-
| - |
- Occurs whenever an object is hit by a weapon. - |
-
| - |
- Occurs when any system fails on a human controlled aircraft. - |
-
| - |
- Occurs on the death of a unit. - |
-
| - |
- Occurs when an aircraft lands at an airbase, farp or ship -initiator : The unit that has landed. - |
-
| - |
- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. - |
-
| - |
- Landing quality mark. - |
-
| - |
- Occurs when a new mark was added. - |
-
| - |
- Occurs when a mark text was changed. - |
-
| - |
- Occurs when a mark was removed. - |
-
| - |
- Occurs when a mission ends. - |
-
| - |
- Occurs when a mission starts. - |
-
| - |
- Weapon add. - |
-
| - |
- Occurs when the pilot of an aircraft is killed. - |
-
| - |
- Occurs when a player enters a slot and takes control of an aircraft. - |
-
| - |
- Occurs when any player assumes direct control of a unit. - |
-
| - |
- Occurs when any player relieves control of a unit to the AI. - |
-
| - |
- Occurs when an aircraft connects with a tanker and begins taking on fuel. - |
-
| - |
- Occurs when an aircraft is finished taking fuel. - |
-
| - |
- Occurs when any modification to the "Score" as seen on the debrief menu would occur. - |
-
| - |
- Occurs when any unit stops firing its weapon. - |
-
| - |
- Occurs when any unit begins firing a weapon that has a high rate of fire. - |
-
| - |
- Occurs whenever any unit in a mission fires a weapon. - |
-
| - |
- Occurs when an aircraft takes off from an airbase, farp, or ship. - |
-
| - |
- Trigger zone. - |
-
| - |
- 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. - |
-
| - |
- Stops the Schedule. - |
-
| - | - - | -
| - |
- Set the Class Event processing Priority. - |
-
| - |
- Set a state or property of the Object given a Key and a Value. - |
-
| - |
- Trace a function logic level 1. - |
-
| - |
- Trace a function logic level 2. - |
-
| - |
- Trace a function logic level 3. - |
-
| - |
- Trace all methods in MOOSE - |
-
| - |
- Set tracing for a class - |
-
| - |
- Set tracing for a specific method of class - |
-
| - |
- Set trace level - |
-
| - |
- Set trace off. - |
-
| - |
- Set trace on. - |
-
| - |
- 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. - |
-
| - |
- UnSubscribe to a DCS event. - |
-
| - | - - | -
MENU_MISSION_COMMAND:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function call. - |
-
MENU_MISSION_COMMAND:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
-
- Trace a function logic. - |
-
| - | - - | -
| - | - |
self:F( { RemoveParent } )
+self:F( { RemoveParent } )
MENU_BASE
-- MenuText -
-Gets a Menu from a parent Menu
- -MENU_BASE
-- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -MENU_BASE
-MenuStamp
- -Constructor
- -MENU_BASE
-- MenuText -
-- ParentMenu -
-MENU_BASE
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -MENU_BASE
-- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -MENU_BASE
-- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -MENU_BASE
-- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -MENU_BASE
-- MenuStamp -
-self:F( { RemoveParent } )
- -Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -Gets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -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 tGets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -MENU_COMMAND_BASE
+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 tGets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -Gets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -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 tGets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -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 -Gets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -Gets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -MENU_MISSION constructor.
- - -Creates a new MENU_MISSION object and creates the menu for a complete mission file.
- -MENU_MISSION
-- #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).
- -Refreshes a radio item for a mission
- -Removes the main menu and the sub menus recursively of this MENU_MISSION.
- -MENU_MISSION
-- MenuStamp -
-- MenuTag -
-#nil:
-Removes the sub menus recursively of this MENU_MISSION.
- - -Note that the main menu is kept!
- -Gets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -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 -Gets a Menu from a parent Menu
- -- #string - MenuText -
-The text of the child menu.
- -Gets a menu stamp for later prevention of menu removal.
- -Constructor
- -- MenuText -
-- ParentMenu -
-- MenuText -
-- Menu -
-Sets a Menu to remove automatically the parent menu when the menu removed is the last child menu of that parent Menu.
- -- #boolean - RemoveParent -
-If true, the parent menu is automatically removed when this menu is the last child menu of that parent Menu.
- -Sets a menu stamp for later prevention of menu removal.
- -- MenuStamp -
-Sets a tag for later selection of menu refresh.
- -- #string - MenuTag -
-A Tag or Key that will filter only menu items set with this key.
- -Sets a time stamp for later prevention of menu removal.
- -- MenuStamp -
-Clear the state of an object.
- -- Object -
-The object that holds the Value set by the Key.
- -- StateName -
-The key that is should be cleared.
- -Creation of a Birth Event.
- -- 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 -
-Creation of a Crash Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Dead Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
- Wrapper.Unit#UNIT - PlayerUnit -
-The aircraft unit the player entered.
- -Creation of a Remove Unit Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Creation of a Takeoff Event.
- -- DCS#Time - EventTime -
-The time stamp of the event.
- -- DCS#Object - Initiator -
-The initiating object of the event.
- -Log an exception which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Returns the event dispatcher
- -Remove all subscribed events
- -Trace a function call.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 2.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function call level 3.
- - -Must be at the beginning of the function logic.
- -- Arguments -
-A #table or any field.
- -Get the ClassID of the class instance.
- -#string:
-The ClassID of the class instance.
- -Get the ClassName of the class instance.
- -#string:
-The ClassName of the class instance.
- -Get the ClassName + ClassID of the class instance.
- - -The ClassName + ClassID is formatted as '%s#%09d'.
- -#string:
-The ClassName + ClassID of the class instance.
- -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.
- -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()
-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.
- -- 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!
- -The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
- -Subscribe to a DCS Event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -- #function - EventFunction -
-(optional) The function to be called when the event occurs for the unit.
- -Log an information which will be traced always.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -This is the worker method to inherit from a parent class.
- -- Child -
-is the Child class that inherits.
- -- #BASE - Parent -
-is the Parent class that the Child inherits from.
- -Child
- -This is the worker method to check if an object is an (sub)instance of a class.
- - - -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
- ClassName -
-is the name of the class or the class itself to run the check against
- -#boolean:
-Enquires if tracing is on (for the class).
- -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
-Occurs when an object is completely destroyed.
- - -initiator : The unit that is was destroyed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -BDA.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any object is spawned into the mission.
- - -initiator : The unit that was spawned.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft crashes into the ground and is completely destroyed.
- - -initiator : The unit that has crashed.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an object is dead.
- - -initiator : The unit that is dead.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Unknown precisely what creates this event, likely tied into newer damage model.
- - -Will update this page when new information become available.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Discard chair after ejection.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a pilot ejects from an aircraft -initiator : The unit that has ejected
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft shuts down its engines.
- - -initiator : The unit that is stopping its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any aircraft starts its engines.
- - -initiator : The unit that is starting its engines..
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any system fails on a human controlled aircraft.
- - -initiator : The unit that had the failure.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Landing quality mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a new mark was added.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark text was changed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mark was removed.
- - -MarkID: ID of the mark.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission ends.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when a mission starts.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Weapon add.
- - -Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player assumes direct control of a unit.
- - -initiator : The unit that is being taken control of.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when any player relieves control of a unit to the AI.
- - -initiator : The unit that the player left.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft connects with a tanker and begins taking on fuel.
- - -initiator : The unit that is receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when an aircraft is finished taking fuel.
- - -initiator : The unit that was receiving fuel.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Trigger zone.
- -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -Occurs when the game thinks an object is destroyed.
- - - -- Core.Event#EVENTDATA - EventData -
-The EventData structure.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -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.
- -- #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, ... }.
- -#number:
-The ScheduleID of the planned schedule.
- -Stops the Schedule.
- -- #function - SchedulerFunction -
-The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
- -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.
- -- #number - EventPriority -
-The Event processing Priority.
- -self
- -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.
- -- 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.
- -The Value set.
- -Trace a function logic level 1.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 2.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace a function logic level 3.
- - -Can be anywhere within the function logic.
- -- Arguments -
-A #table or any field.
- -Trace all methods in MOOSE
- -- #boolean - TraceAll -
-true = trace all methods in MOOSE.
- -Set tracing for a class
- -Set tracing for a specific method of class
- -- #string - Class -
-- #string - Method -
-Set trace level
- -Set trace off.
- -Set trace on.
- -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.
- -- #boolean - TraceOnOff -
-Switch the tracing on or off.
- -
- -- Switch the tracing On
- BASE:TraceOnOff( true )
-
- -- Switch the tracing Off
- BASE:TraceOnOff( false )
-UnSubscribe to a DCS event.
- -- Core.Event#EVENTS - EventID -
-Event ID.
- -Trace a function call.
- - -This function is private.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-Trace a function logic.
- -- Arguments -
-A #table or any field.
- -- DebugInfoCurrentParam -
-- DebugInfoFromParam -
-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
- -SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)
The AI is on by default when spawning a group.
+Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.
+Overwrite unit names by default with group name.
+By default, no InitLimit
When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.
-The AI is on by default when spawning a group.
+Overwrite unit names by default with group name.
+By default, no InitLimit
switch alarm state RED
-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 defauContains the counter how many units are currently alive
+ +Contains the counter how many units are currently alive
+ +Type of terminal to be used when spawning at an airbase.
+RAT:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)
Type of terminal to be used when spawning at an airbase.
+Type of terminal to be used when spawning at an airbase.
+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 switData table at each position in the groove. Elements are of type AIRBOSS.GrooveData.
- - - -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 aGROUP_SET of all helis
+table of CSAR unit names
+Replacement woundedGroups
+ +contain a table for each SAR with all units he has with the original names
- - - -counter for saved pilots
+ +counter for successful rescue landings at FARP/AFB/MASH
+ +GROUP_SET of all helis
+table of CSAR unit names
+Replacement woundedGroups
+ +contain a table for each SAR with all units he has with the original names
-counter for saved pilots
+ +counter for successful rescue landings at FARP/AFB/MASH
+ +GROUP_SET of all helis
+table of CSAR unit names
+Replacement woundedGroups
+ +contain a table for each SAR with all units he has with the original names
-counter for saved pilots
+ +counter for successful rescue landings at FARP/AFB/MASH
+ +template for a group of 10 paratroopers
-template for a group of 10 paratroopers
-set to false to suppress flash messages
+set to false to suppress flash messages
+set to false to suppress flash messages
+set to false to suppress flash messages
+Alive2.
+Alive.
Alive2.
+Alive.
Alive2.
+Alive.
Alive2.
+Alive.
Alive2.
+Alive.
Alive2.
+Alive.
Alive2.
+Alive.
Coordinate of the mark.
+Text displayed in the mark panel.
-Coordinate of the mark.
+Text displayed in the mark panel.
-Coordinate of the mark.
+Text displayed in the mark panel.
-