Module Core.RadioQueue

self The RADIOQUEUE object.

RADIOQUEUE:Broadcast(transmission)

Broadcast radio message.

Defined in:

RADIOQUEUE

Parameter:

#RADIOQUEUE.Transmission transmission

The transmission.

RADIOQUEUE:New(frequency, modulation, alias)

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.

RADIOQUEUE:NewTransmission(filename, duration, path, tstart, interval, subtitle, subduration)

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.

RADIOQUEUE:Number2Transmission(number, delay, interval)

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.

RADIOQUEUE:SetDigit(digit, filename, duration, path, subtitle, subduration)

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.

RADIOQUEUE:SetRadioPower(power)

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.

RADIOQUEUE:SetSenderCoordinate(coordinate)

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.

RADIOQUEUE:SetSenderUnitName(name)

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.

RADIOQUEUE:Start(delay, dt)

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.

RADIOQUEUE:Stop()

Stop the radio queue.

Stop scheduler and delete queue.

Defined in:

RADIOQUEUE

Return value:

self The RADIOQUEUE object.

RADIOQUEUE:_CheckRadioQueue()

Check radio queue for transmissions to be broadcasted.

Defined in:

RADIOQUEUE

RADIOQUEUE:_CheckRadioQueueDelayed(delay)

Start checking the radio queue.

Defined in:

RADIOQUEUE

Parameter:

#number delay

Delay in seconds before checking.

RADIOQUEUE:_GetRadioSender()

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:

Wrapper.Unit#UNIT:

Sending aircraft unit or nil if was not setup, is not an aircraft or is not alive.

RADIOQUEUE:_GetRadioSenderCoord()

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:

Core.Point#COORDINATE:

Coordinate of the sender unit.

Field(s)

#string RADIOQUEUE.ClassName

Name of the class "RADIOQUEUE".

#boolean RADIOQUEUE.Debug

Debug mode. More info.

#string RADIOQUEUE.RQid

The radio queue scheduler ID.

#number RADIOQUEUE.Tlast

Time (abs) when the last transmission finished.

#string RADIOQUEUE.alias

Name of the radio.

#boolean RADIOQUEUE.checking

Scheduler is checking the radio queue.

#number RADIOQUEUE.delay

Time delay before starting the radio queue.

#number RADIOQUEUE.dt

Time interval in seconds for checking the radio queue.

#number RADIOQUEUE.frequency

The radio frequency in Hz.

#string RADIOQUEUE.lid

ID for dcs.log.

#number RADIOQUEUE.modulation

The radio modulation. Either radio.modulation.AM or radio.modulation.FM.

#table RADIOQUEUE.numbers

Table of number transmission parameters.

#number RADIOQUEUE.power

Power of radio station in Watts. Default 100 W.

#table RADIOQUEUE.queue

The queue of transmissions.

#boolean RADIOQUEUE.schedonce

Call ScheduleOnce instead of normal scheduler.

Core.Scheduler#SCHEDULER RADIOQUEUE.scheduler

The scheduler.

Core.Point#COORDINATE RADIOQUEUE.sendercoord

Coordinate from where transmissions are broadcasted.

#boolean RADIOQUEUE.senderinit

Set frequency was initialized.

#number RADIOQUEUE.sendername

Name of the sending unit or static.

Function(s)

RADIOQUEUE:ClearState(Object, StateName)

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.

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

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

RADIOQUEUE:CreateEventCrash(EventTime, Initiator)

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.

RADIOQUEUE:CreateEventDead(EventTime, Initiator)

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.

RADIOQUEUE:CreateEventRemoveUnit(EventTime, Initiator)

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.

RADIOQUEUE:CreateEventTakeoff(EventTime, Initiator)

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.

RADIOQUEUE:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

RADIOQUEUE:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

RADIOQUEUE:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

RADIOQUEUE:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

RADIOQUEUE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

RADIOQUEUE:GetEventPriority()

Get the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Event processing Priority.

RADIOQUEUE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

RADIOQUEUE:GetState(Object, Key)

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.

RADIOQUEUE:HandleEvent(Event, EventFunction)

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:

RADIOQUEUE:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:Inherit(Child, Parent)

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

RADIOQUEUE:IsInstanceOf(ClassName)

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

Examples:

ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

RADIOQUEUE:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

RADIOQUEUE:New()

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end

Defined in:

Return value:

RADIOQUEUE:OnEvent(EventData)

Occurs when an object is completely destroyed.

initiator : The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventBaseCaptured(EventData)

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

initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

initiator : The unit that was spawned

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventCrash(EventData)

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

initiator : The unit that has crashed

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventDead(EventData)

Occurs when an object is dead.

initiator : The unit that is dead.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventEjection(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

initiator : The unit that had the failure

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.

Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventMissionEnd(EventData)

Occurs when a mission ends

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventMissionStart(EventData)

Occurs when a mission starts

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventPlayerLeaveUnit(EventData)

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

initiator : The unit that the player left.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventRefueling(EventData)

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

initiator : The unit that is receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

initiator : The unit that was receiving fuel.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventShootingStart(EventData)

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

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

RADIOQUEUE:OnEventTakeoff(EventData)

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

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

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

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.

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

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

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.

RADIOQUEUE:ScheduleStop(SchedulerFunction)

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.

RADIOQUEUE:SetEventPriority(EventPriority)

Set the Class Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Event processing Priority.

Return value:

self

RADIOQUEUE:SetState(Object, Key, Value)

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

Note that if the Object is destroyed, 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.

RADIOQUEUE:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

RADIOQUEUE:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

RADIOQUEUE:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

RADIOQUEUE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

#string Method

RADIOQUEUE:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

RADIOQUEUE:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

RADIOQUEUE:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

RADIOQUEUE:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:

-- Switch the tracing On
BASE:TraceOnOff( true )

-- Switch the tracing Off
BASE:TraceOnOff( false )

RADIOQUEUE:UnHandleEvent(Event)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS Event

Return value:

RADIOQUEUE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

RADIOQUEUE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in: