Module Functional.PseudoATC
Functional - Basic ATC.
The pseudo ATC enhances the standard DCS ATC functions.
In particular, a menu entry "Pseudo ATC" is created in the "F10 Other..." radiomenu.
Features:
- Weather report at nearby airbases and mission waypoints.
- Report absolute bearing and range to nearest airports and mission waypoints.
- Report current altitude AGL of own aircraft.
- Upon request, ATC reports altitude until touchdown.
- Works with static and dynamic weather.
- Player can select the unit system (metric or imperial) in which information is reported.
- All maps supported (Caucasus, NTTR, Normandy, Persian Gulf and all future maps).
YouTube Channel
MOOSE YouTube Channel
Author: funkyfranky
Contributions: FlightControl, Applevangelist
Global(s)
Global PSEUDOATC |
Adds some rudimentary ATC functionality via the radio menu. |
Adds some rudimentary ATC functionality via the radio menu.
Local weather reports can be requested for nearby airports and player's mission waypoints. The weather report includes
- QFE and QNH pressures,
- Temperature,
- Wind direction and strength.
The list of airports is updated every 60 seconds. This interval can be adjusted by the function PSEUDOATC.SetMenuRefresh(interval).
Likewise, absolute bearing and range to the close by airports and mission waypoints can be requested.
The player can switch the unit system in which all information is displayed during the mission with the MOOSE settings radio menu. The unit system can be set to either imperial or metric. Altitudes are reported in feet or meter, distances in kilometers or nautical miles, temperatures in degrees Fahrenheit or Celsius and QFE/QNH pressues in inHg or mmHg. Note that the pressures are also reported in hPa independent of the unit system setting.
In bad weather conditions, the ATC can "talk you down", i.e. will continuously report your altitude on the final approach. Default reporting time interval is 3 seconds. This can be adjusted via the PSEUDOATC.SetReportAltInterval(interval) function. The reporting stops automatically when the player lands or can be stopped manually by clicking on the radio menu item again. So the radio menu item acts as a toggle to switch the reporting on and off.
Scripting
Scripting is almost trivial. Just add the following two lines to your script:
pseudoATC=PSEUDOATC:New()
pseudoATC:Start()
Type(s)
| Fields and Methods inherited from PSEUDOATC | Description |
|---|---|
|
Toggle report altitude reporting on/off. |
|
|
Start altitude reporting scheduler. |
|
|
Stop/destroy DCS scheduler function for reporting altitude. |
|
|
Chatty mode off. |
|
|
Chatty mode on. |
|
|
Name of the Class. |
|
|
If true, print debug info to dcs.log file. |
|
|
Debug mode off. |
|
|
Debug mode on. |
|
|
Create list of nearby airports sorted by distance to player unit. |
|
|
Create "F10/Pseudo ATC/Local Airports/Airport Name/" menu items each containing weather report and BR request. |
|
|
Clear player menus. |
|
|
Create player menus. |
|
|
Refreshes all player menues. |
|
|
Create "F10/Pseudo ATC/Waypoints/ |
|
|
PSEUDOATC contructor. |
|
|
Function called when a player enters a unit. |
|
|
Function called when a player has landed. |
|
|
Function called when a player leaves a unit or dies. |
|
|
Function called when a player took off. |
|
|
Report absolute bearing and range form player unit to airport. |
|
|
Report altitude above ground level of player unit. |
|
|
Weather Report. |
|
|
[Deprecated] Enable/disable event handling by MOOSE or DCS. |
|
|
Set time interval after which the F10 radio menu is refreshed. |
|
|
Set duration how long messages are displayed. |
|
|
Set time interval for reporting altitude until touchdown. |
|
|
Use player name, not call sign, in callouts |
|
|
Starts the PseudoATC event handlers. |
|
PSEUDOATC:_DisplayMessageToGroup(_unit, _text, _time, _clear) |
Display message to group. |
|
Returns the unit of a player and the player name. |
|
|
Function called my MOOSE event handler when a player enters a unit. |
|
|
Function called by MOOSE event handler when a player landed. |
|
|
Function called by MOOSE event handler when a player leaves a unit or dies. |
|
|
Function called by MOOSE/DCS event handler when a player took off. |
|
|
Returns a string which consits of this callsign and the player name. |
|
|
Display some messages on events like take-off and touchdown. |
|
|
[Deprecated] If true, events are handled by MOOSE. If false, events are handled directly by DCS eventhandler. |
|
|
Some ID to identify who we are in output of the DCS.log file. |
|
|
Duration in seconds how low messages to the player are displayed. |
|
|
Interval in seconds after which the F10 menu is refreshed. E.g. by the closest airports. Default is 120 sec. |
|
|
Table comprising each player info. |
|
|
If true, use playername not callsign on callouts |
|
|
Interval in seconds between reporting altitude until touchdown. Default 3 sec. |
|
|
PSEUDOATC version. |
| 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. |
|
PSEUDOATC:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
PSEUDOATC:CreateEventCrash(EventTime, Initiator, IniObjectCategory) |
Creation of a Crash Event. |
PSEUDOATC:CreateEventDead(EventTime, Initiator, IniObjectCategory) |
Creation of a Dead Event. |
|
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event. |
|
|
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event. |
|
|
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event. |
|
|
Creation of a |
|
|
Creation of a Remove Unit Event. |
|
|
Creation of a Takeoff Event. |
|
|
Creation of a Crash 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 Core.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 Event for an object is triggered. |
|
|
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 player loads a dynamic cargo object with the F8 ground crew menu into a helo. |
|
|
Occurs when a dynamic cargo crate is removed. |
|
|
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo. |
|
|
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
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 Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
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 Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes. |
|
|
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu. |
|
|
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. |
|
PSEUDOATC:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...) |
Schedule a new time event. |
|
Stops the Schedule. |
|
|
Set the Class Core.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. |
|
PSEUDOATC:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
|
(Internal) Serialize arguments |
|
PSEUDOATC:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
|
The main event handling function... |
- PSEUDOATC class
Field(s)
Name of the Class.
If true, print debug info to dcs.log file.
Display some messages on events like take-off and touchdown.
[Deprecated] If true, events are handled by MOOSE. If false, events are handled directly by DCS eventhandler.
Some ID to identify who we are in output of the DCS.log file.
Duration in seconds how low messages to the player are displayed.
Interval in seconds after which the F10 menu is refreshed. E.g. by the closest airports. Default is 120 sec.
Table comprising each player info.
If true, use playername not callsign on callouts
Interval in seconds between reporting altitude until touchdown. Default 3 sec.
PSEUDOATC version.
Function(s)
Toggle report altitude reporting on/off.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Start altitude reporting scheduler.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Stop/destroy DCS scheduler function for reporting altitude.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Chatty mode off.
Don't display some messages on take-off and touchdown.
Defined in:
PSEUDOATC
Chatty mode on.
Display some messages on take-off and touchdown.
Defined in:
PSEUDOATC
Create list of nearby airports sorted by distance to player unit.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Create "F10/Pseudo ATC/Local Airports/Airport Name/" menu items each containing weather report and BR request.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Clear player menus.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Create player menus.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Refreshes all player menues.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Create "F10/Pseudo ATC/Waypoints/
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
PSEUDOATC contructor.
Function called when a player enters a unit.
Function called when a player has landed.
Defined in:
PSEUDOATC
Parameters:
Wrapper.Unit#UNIT unit
Unit of player which has landed.
#string place
Name of the place the player landed at.
Function called when a player leaves a unit or dies.
Function called when a player took off.
Defined in:
PSEUDOATC
Parameters:
Wrapper.Unit#UNIT unit
Unit of player which has landed.
#string place
Name of the place the player landed at.
Report absolute bearing and range form player unit to airport.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Core.Point#COORDINATE position
Coordinates at which the pressure is measured.
#string location
Name of the location at which the pressure is measured.
Report altitude above ground level of player unit.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
#number dt
(Optional) Duration the message is displayed.
#boolean _clear
(Optional) Clear previouse messages.
Return value:
#number:
Altitude above ground.
Weather Report.
Report pressure QFE/QNH, temperature, wind at certain location.
Defined in:
PSEUDOATC
Parameters:
#number GID
Group id of player unit.
#number UID
Unit id of player.
Core.Point#COORDINATE position
Coordinates at which the pressure is measured.
#string location
Name of the location at which the pressure is measured.
[Deprecated] Enable/disable event handling by MOOSE or DCS.
Defined in:
PSEUDOATC
Parameter:
#boolean switch
If true, events are handled by MOOSE (default). If false, events are handled directly by DCS.
Set time interval after which the F10 radio menu is refreshed.
Defined in:
PSEUDOATC
Parameter:
#number interval
Interval in seconds. Default is every 120 sec.
Set duration how long messages are displayed.
Defined in:
PSEUDOATC
Parameter:
#number duration
Time in seconds. Default is 30 sec.
Set time interval for reporting altitude until touchdown.
Defined in:
PSEUDOATC
Parameter:
#number interval
Interval in seconds. Default is every 3 sec.
Display message to group.
Defined in:
PSEUDOATC
Parameters:
Wrapper.Unit#UNIT _unit
Player unit.
#string _text
Message text.
#number _time
Duration how long the message is displayed.
#boolean _clear
Clear up old messages.
Returns the unit of a player and the player name.
If the unit does not belong to a player, nil is returned.
Defined in:
PSEUDOATC
Parameter:
#string _unitName
Name of the player unit.
Return values:
Function called my MOOSE event handler when a player enters a unit.
Function called by MOOSE event handler when a player landed.
Function called by MOOSE event handler when a player leaves a unit or dies.
Function called by MOOSE/DCS event handler when a player took off.
Returns a string which consits of this callsign and the player name.
Defined in:
PSEUDOATC
Parameter:
#string unitname
Name of the player unit.
Field(s)
Name of the Class.
If true, print debug info to dcs.log file.
Display some messages on events like take-off and touchdown.
[Deprecated] If true, events are handled by MOOSE. If false, events are handled directly by DCS eventhandler.
Some ID to identify who we are in output of the DCS.log file.
Duration in seconds how low messages to the player are displayed.
Interval in seconds after which the F10 menu is refreshed. E.g. by the closest airports. Default is 120 sec.
Table comprising each player info.
If true, use playername not callsign on callouts
Interval in seconds between reporting altitude until touchdown. Default 3 sec.
PSEUDOATC version.
Function(s)
Clear the state of an object.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
StateName
The key that is should be cleared.
Creation of a Birth Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
#string IniUnitName
The initiating unit name.
place
subplace
Creation of a Crash Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a Dead Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
IniObjectCategory
Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.
Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.
Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.
Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.
Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.
Creation of a Remove Unit Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Takeoff Event.
Defined in:
Parameters:
DCS#Time EventTime
The time stamp of the event.
DCS#Object Initiator
The initiating object of the event.
Creation of a Crash Event.
Defined in:
Parameters:
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.
Returns the event dispatcher
Remove all subscribed events
Trace a function call.
Must be at the beginning of the function logic.
Trace a function call level 2.
Must be at the beginning of the function logic.
Trace a function call level 3.
Must be at the beginning of the function logic.
Get the ClassID of the class instance.
Get the ClassName of the class instance.
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Get the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
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.
Defined in:
Parameters:
Object
The object that holds the Value set by the Key.
Key
The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
Return value:
The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
Subscribe to a DCS Event.
Defined in:
Parameters:
Core.Event#EVENTS EventID
Event ID.
#function EventFunction
(optional) The function to be called when the event occurs for the unit.
Return value:
Log an information which will be traced always.
Can be anywhere within the function logic.
This is the worker method to inherit from a parent class.
Defined in:
Parameters:
Child
is the Child class that inherits.
#BASE Parent
is the Parent class that the Child inherits from.
Return value:
Child
This is the worker method to check if an object is an (sub)instance of a class.
Examples:
ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false
Defined in:
Parameter:
ClassName
is the name of the class or the class itself to run the check against
Return value:
#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 Event for an object is triggered.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.
Occurs when a ground unit captures either an airbase or a farp.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.
Occurs when any object is spawned into the mission.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed
Occurs when an object is dead.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.
Unknown precisely what creates this event, likely tied into newer damage model.
Will update this page when new information become available.
- initiator: The unit that had the failure.
Discard chair after ejection.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a dynamic cargo crate is removed.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.
Occurs whenever an object is hit by a weapon.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.
Occurs when any system fails on a human controlled aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure
Occurs on the death of a unit.
Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.
initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark text was changed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mark was removed.
Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.
Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.
* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.
Weapon add.
Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when the pilot of an aircraft is killed.
Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.
Occurs when a player enters a slot and takes control of an aircraft.
Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.
Occurs when any player assumes direct control of a unit.
Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.
Occurs when any modification to the "Score" as seen on the debrief menu would occur.
There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when any unit stops firing its weapon.
Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.
Occurs when any unit begins firing a weapon that has a high rate of fire.
Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.
Occurs whenever any unit in a mission fires a weapon.
But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.
Occurs when an aircraft takes off from an airbase, farp, or ship.
Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships
Occurs when the game thinks an object is destroyed.
Have a look at the class Core.Event#EVENT as these are just the prototypes.
- initiator: The unit that is was destroyed.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Schedule a new time event.
Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.
Defined in:
Parameters:
#number Start
Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
#number Repeat
Specifies the interval in seconds when the scheduler will call the event function.
#number RandomizeFactor
Specifies a randomization factor between 0 and 1 to randomize the Repeat.
#number Stop
Specifies the amount of seconds when the scheduler will be stopped.
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
#table ...
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
Return value:
#string:
The Schedule ID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#string SchedulerID
(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
Set the Class Core.Event processing Priority.
The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
Defined in:
Parameters:
Object
The object that will hold the Value set by the Key.
Key
The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
Value
The value to is stored in the object.
Return value:
The Value set.
Trace a function logic level 1.
Can be anywhere within the function logic.
Trace a function logic level 2.
Can be anywhere within the function logic.
Trace a function logic level 3.
Can be anywhere within the function logic.
Trace all methods in MOOSE
Set tracing for a class
Set tracing for a specific method of class
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.
Defined in:
Parameter:
#boolean TraceOnOff
Switch the tracing on or off.
Usage:
-- Switch the tracing On
BASE:TraceOnOff( true )
-- Switch the tracing Off
BASE:TraceOnOff( false )
UnSubscribe to a DCS event.
Trace a function call.
This function is private.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
(Internal) Serialize arguments
Trace a function logic.
Defined in:
Parameters:
Arguments
A #table or any field.
DebugInfoCurrentParam
DebugInfoFromParam
The main event handling function...
This function captures all events generated for the class.