Module Core.RadioQueue
Core - Queues Radio Transmissions.
Features:
- Managed Radio Transmissions.
Authors: funkyfranky
Global(s)
Global RADIOQUEUE |
Type(s)
| Fields and Methods inherited from RADIOQUEUE | Description |
|---|---|
|
Add a transmission to the radio queue. |
|
|
Broadcast radio message. |
|
|
Name of the class "RADIOQUEUE". |
|
|
Debug mode. More info. |
|
|
Create a new RADIOQUEUE object for a given radio frequency/modulation. |
|
RADIOQUEUE:NewTransmission(filename, duration, path, tstart, interval, subtitle, subduration) |
Add a transmission to the radio queue. |
|
Convert a number (as string) into a radio transmission. |
|
|
The radio queue scheduler ID. |
|
RADIOQUEUE:SetDigit(digit, filename, duration, path, subtitle, subduration) |
Set parameters of a digit. |
|
Set radio power. |
|
|
Set coordinate from where the transmission is broadcasted. |
|
|
Set name of unit or static from which transmissions are made. |
|
|
Start the radio queue. |
|
|
Stop the radio queue. |
|
|
Time (abs) when the last transmission finished. |
|
|
Check radio queue for transmissions to be broadcasted. |
|
|
Start checking the radio queue. |
|
|
Get unit from which we want to transmit a radio message. |
|
|
Get unit from which we want to transmit a radio message. |
|
|
Name of the radio. |
|
|
Scheduler is checking the radio queue. |
|
|
Time delay before starting the radio queue. |
|
|
Time interval in seconds for checking the radio queue. |
|
|
The radio frequency in Hz. |
|
|
ID for dcs.log. |
|
|
The radio modulation. Either radio.modulation.AM or radio.modulation.FM. |
|
|
Table of number transmission parameters. |
|
|
Power of radio station in Watts. Default 100 W. |
|
|
The queue of transmissions. |
|
|
Call ScheduleOnce instead of normal scheduler. |
|
|
The scheduler. |
|
|
Coordinate from where transmissions are broadcasted. |
|
|
Set frequency was initialized. |
|
|
Name of the sending unit or static. |
| 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. |
|
RADIOQUEUE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) |
Creation of a Birth Event. |
|
Creation of a Crash Event. |
|
|
Creation of a Dead Event. |
|
|
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. |
|
|
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. |
|
|
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 place: Object that the unit landed on. |
|
|
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. |
|
|
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 |
|
|
Occurs when the pilot of an aircraft is killed. |
|
|
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. |
|
|
Occurs when the game thinks an object is destroyed. |
|
|
Schedule a new time event. |
|
RADIOQUEUE: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. |
|
RADIOQUEUE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function call. |
RADIOQUEUE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam) |
Trace a function logic. |
| Fields and Methods inherited from RADIOQUEUE.Transmission | Description |
|---|---|
|
Mission time (abs) in seconds when the transmission should be played. |
|
|
Mission time (abs) in seconds when the transmission started. |
|
|
Duration in seconds. |
|
|
Name of the file to be transmitted. |
|
|
Interval in seconds before next transmission. |
|
|
If true, transmission is currently playing. |
|
|
Path in miz file where the file is located. |
|
|
Duration of the subtitle being displayed. |
|
|
Subtitle of the transmission. |
Manages radio transmissions.
Field(s)
Name of the class "RADIOQUEUE".
Debug mode. More info.
The radio queue scheduler ID.
Time (abs) when the last transmission finished.
Name of the radio.
Scheduler is checking the radio queue.
Time delay before starting the radio queue.
Time interval in seconds for checking the radio queue.
The radio frequency in Hz.
ID for dcs.log.
The radio modulation. Either radio.modulation.AM or radio.modulation.FM.
Table of number transmission parameters.
Power of radio station in Watts. Default 100 W.
The queue of transmissions.
Call ScheduleOnce instead of normal scheduler.
Set frequency was initialized.
Name of the sending unit or static.
Function(s)
Add a transmission to the radio queue.
Defined in:
RADIOQUEUE
Parameter:
#RADIOQUEUE.Transmission transmission
The transmission data table.
Return value:
self The RADIOQUEUE object.
Broadcast radio message.
Create a new RADIOQUEUE object for a given radio frequency/modulation.
Defined in:
RADIOQUEUE
Parameters:
#number frequency
The radio frequency in MHz.
#number modulation
(Optional) The radio modulation. Default radio.modulation.AM.
#string alias
(Optional) Name of the radio queue.
Return value:
self The RADIOQUEUE object.
Add a transmission to the radio queue.
Defined in:
RADIOQUEUE
Parameters:
#string filename
Name of the sound file. Usually an ogg or wav file type.
#number duration
Duration in seconds the file lasts.
#number path
Directory path inside the miz file where the sound file is located. Default "l10n/DEFAULT/".
#number tstart
Start time (abs) seconds. Default now.
#number interval
Interval in seconds after the last transmission finished.
#string subtitle
Subtitle of the transmission.
#number subduration
Duration [sec] of the subtitle being displayed. Default 5 sec.
Return value:
self The RADIOQUEUE object.
Convert a number (as string) into a radio transmission.
E.g. for board number or headings.
Defined in:
RADIOQUEUE
Parameters:
#string number
Number string, e.g. "032" or "183".
#number delay
Delay before transmission in seconds.
#number interval
Interval between the next call.
Return value:
#number:
Duration of the call in seconds.
Set parameters of a digit.
Defined in:
RADIOQUEUE
Parameters:
#number digit
The digit 0-9.
#string filename
The name of the sound file.
#number duration
The duration of the sound file in seconds.
#string path
The directory within the miz file where the sound is located. Default "l10n/DEFAULT/".
#string subtitle
Subtitle of the transmission.
#number subduration
Duration [sec] of the subtitle being displayed. Default 5 sec.
Return value:
self The RADIOQUEUE object.
Set radio power.
Note that this only applies if no relay unit is used.
Defined in:
RADIOQUEUE
Parameter:
#number power
Radio power in Watts. Default 100 W.
Return value:
self The RADIOQUEUE object.
Set coordinate from where the transmission is broadcasted.
Defined in:
RADIOQUEUE
Parameter:
Core.Point#COORDINATE coordinate
Coordinate of the sender.
Return value:
self The RADIOQUEUE object.
Set name of unit or static from which transmissions are made.
Defined in:
RADIOQUEUE
Parameter:
#string name
Name of the unit or static used for transmissions.
Return value:
self The RADIOQUEUE object.
Start the radio queue.
Defined in:
RADIOQUEUE
Parameters:
#number delay
(Optional) Delay in seconds, before the radio queue is started. Default 1 sec.
#number dt
(Optional) Time step in seconds for checking the queue. Default 0.01 sec.
Return value:
self The RADIOQUEUE object.
Stop the radio queue.
Stop scheduler and delete queue.
Check radio queue for transmissions to be broadcasted.
Defined in:
RADIOQUEUE
Start checking the radio queue.
Defined in:
RADIOQUEUE
Parameter:
#number delay
Delay in seconds before checking.
Get unit from which we want to transmit a radio message.
This has to be an aircraft for subtitles to work.
Defined in:
RADIOQUEUE
Return value:
Sending aircraft unit or nil if was not setup, is not an aircraft or is not alive.
Get unit from which we want to transmit a radio message.
This has to be an aircraft for subtitles to work.
Field(s)
Name of the class "RADIOQUEUE".
Debug mode. More info.
The radio queue scheduler ID.
Time (abs) when the last transmission finished.
Name of the radio.
Scheduler is checking the radio queue.
Time delay before starting the radio queue.
Time interval in seconds for checking the radio queue.
The radio frequency in Hz.
ID for dcs.log.
The radio modulation. Either radio.modulation.AM or radio.modulation.FM.
Table of number transmission parameters.
Power of radio station in Watts. Default 100 W.
The queue of transmissions.
Call ScheduleOnce instead of normal scheduler.
Set frequency was initialized.
Name of the sending unit or static.
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.
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.
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.
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 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, nillified 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 Event
#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 object is completely destroyed.
initiator : The unit that is was destroyed.
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.
Occurs when any object is spawned into the mission.
initiator : The unit that was spawned
Occurs when any aircraft crashes into the ground and is completely destroyed.
initiator : The unit that has crashed
Occurs when an object is dead.
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.
Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
Occurs when any aircraft shuts down its engines.
initiator : The unit that is stopping its engines.
Occurs when any aircraft starts its engines.
initiator : The unit that is starting its engines.
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.
Occurs when any system fails on a human controlled aircraft.
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.
- initiator: The unit that killed the target
- target: Target Object
- weapon: Weapon Object
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
Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
- initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
- place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
- subplace: is always 0 for unknown reasons.
Occurs when a new mark was added.
MarkID: ID of the mark.
Occurs when a mark text was changed.
MarkID: ID of the mark.
Occurs when a mark was removed.
MarkID: ID of the mark.
Occurs when a mission ends
Occurs when a mission starts
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.
Occurs when any player assumes direct control of a unit.
initiator : The unit that is being taken control of.
Occurs when any player relieves control of a unit to the AI.
initiator : The unit that the player left.
Occurs when an aircraft connects with a tanker and begins taking on fuel.
initiator : The unit that is receiving fuel.
Occurs when an aircraft is finished taking fuel.
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.
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.
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. 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.
Occurs when an aircraft takes off from an airbase, farp, or ship.
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.
- 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:
#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.
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:
#number:
The ScheduleID of the planned schedule.
Stops the Schedule.
Defined in:
Parameter:
#function SchedulerFunction
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
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.
Set a state or property of the Object given a Key and a Value.
Note that if the Object is destroyed, nillified 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
Trace a function logic.
Defined in:
Parameters:
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
Radio queue transmission data.
Field(s)
Mission time (abs) in seconds when the transmission should be played.
Mission time (abs) in seconds when the transmission started.
Duration in seconds.
Name of the file to be transmitted.
Interval in seconds before next transmission.
If true, transmission is currently playing.
Path in miz file where the file is located.
Duration of the subtitle being displayed.
Subtitle of the transmission.