diff --git a/MOOSE b/MOOSE
new file mode 160000
index 000000000..841e611e3
--- /dev/null
+++ b/MOOSE
@@ -0,0 +1 @@
+Subproject commit 841e611e3c685eb6b223370b42042726546e806e
diff --git a/Moose Development/Moose/Core/Radio.lua b/Moose Development/Moose/Core/Radio.lua
index 890474ed3..540c57fc9 100644
--- a/Moose Development/Moose/Core/Radio.lua
+++ b/Moose Development/Moose/Core/Radio.lua
@@ -1,9 +1,11 @@
---- **Core** - The RADIO class is responsible for **transmitting radio communications**.
---
+--- **Core** - The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...
+--
-- 
--
-- ===
--
+-- The Radio contains 2 classes : RADIO and BEACON
+--
-- What are radio communications in DCS ?
--
-- * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
@@ -23,7 +25,8 @@
--
-- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
-- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
--- If a FC3 airacraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to.
+-- If a FC3 airacraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircaft isn't compatible,
+-- you won't hear/be able to use the TACAN beacon informations.
--
-- ===
--
@@ -32,9 +35,9 @@
-- @module Radio
---- # 1) RADIO class, extends @{Base#BASE}
+--- # RADIO class, extends @{Base#BASE}
--
--- ## 1.1) RADIO usage
+-- ## RADIO usage
--
-- There are 3 steps to a successful radio transmission.
--
@@ -45,12 +48,12 @@
-- Methods to set relevant parameters for both a @{Unit#UNIT} or a @{Group#GROUP} or any other @{Positionable#POSITIONABLE}
--
-- * @{#RADIO.SetFileName}() : Sets the file name of your sound file (e.g. "Noise.ogg"),
--- * @{#RADIO.SetFrequency}() : Sets the frequency of your transmission,
+-- * @{#RADIO.SetFrequency}() : Sets the frequency of your transmission.
-- * @{#RADIO.SetModulation}() : Sets the modulation of your transmission.
+-- * @{#RADIO.SetLoop}() : Choose if you want the transmission to be looped. If you need your transmission to be looped, you might need a @{#BEACON} instead...
--
-- Additional Methods to set relevant parameters if the transmiter is a @{Unit#UNIT} or a @{Group#GROUP}
--
--- * @{#RADIO.SetLoop}() : Choose if you want the transmission to be looped,
-- * @{#RADIO.SetSubtitle}() : Set both the subtitle and its duration,
-- * @{#RADIO.NewUnitTransmission}() : Shortcut to set all the relevant parameters in one method call
--
@@ -90,12 +93,11 @@ RADIO = {
}
--- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast
+-- If you want to create a RADIO, you probably should use @{Positionable#POSITIONABLE.GetRadio}() instead
-- @param #RADIO self
-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
-- @return #RADIO Radio
-- @return #nil If Positionable is invalid
--- @usage
--- -- If you want to create a RADIO, you probably should use @{Positionable#POSITIONABLE.GetRadio}() instead
function RADIO:New(Positionable)
local self = BASE:Inherit( self, BASE:New() ) -- Core.Radio#RADIO
@@ -204,12 +206,18 @@ function RADIO:SetLoop(Loop)
end
--- Check validity of the subtitle and the subtitleDuration passed and sets RADIO.subtitle and RADIO.subtitleDuration
+-- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
-- @param #RADIO self
-- @param #string Subtitle
-- @param #number SubtitleDuration in s
-- @return #RADIO self
-- @usage
--- -- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
+-- -- create the broadcaster and attaches it a RADIO
+-- local MyUnit = UNIT:FindByName("MyUnit")
+-- local MyUnitRadio = MyUnit:GetRadio()
+--
+-- -- add a subtitle for the next transmission, which will be up for 10s
+-- MyUnitRadio:SetSubtitle("My Subtitle, 10)
function RADIO:SetSubtitle(Subtitle, SubtitleDuration)
self:F2({Subtitle, SubtitleDuration})
if type(Subtitle) == "string" then
@@ -229,29 +237,32 @@ function RADIO:SetSubtitle(Subtitle, SubtitleDuration)
end
--- Create a new transmission, that is to say, populate the RADIO with relevant data
+-- In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP,
+-- but it will work with a UNIT or a GROUP anyway.
+-- Only the #RADIO and the Filename are mandatory
-- @param #RADIO self
-- @param #string FileName
-- @param #number Frequency in MHz
-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
-- @param #number Power in W
-- @return #RADIO self
--- @usage
--- -- In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP,
--- but it will work with a UNIT or a GROUP anyway
--- -- Only the RADIO and the Filename are mandatory
-function RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power)
+function RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)
self:F({FileName, Frequency, Modulation, Power})
self:SetFileName(FileName)
if Frequency then self:SetFrequency(Frequency) end
if Modulation then self:SetModulation(Modulation) end
if Power then self:SetPower(Power) end
+ if Loop then self:SetLoop(Loop) end
return self
end
--- Create a new transmission, that is to say, populate the RADIO with relevant data
+-- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
+-- but it will work for any @{Positionable#POSITIONABLE}.
+-- Only the RADIO and the Filename are mandatory.
-- @param #RADIO self
-- @param #string FileName
-- @param #string Subtitle
@@ -260,10 +271,6 @@ end
-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
-- @param #boolean Loop
-- @return #RADIO self
--- @usage
--- -- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
--- but it will work for any POSITIONABLE
--- -- Only the RADIO and the Filename are mandatory
function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop)
self:F({FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop})
@@ -278,16 +285,15 @@ function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequen
end
--- Actually Broadcast the transmission
+-- * The Radio has to be populated with the new transmission before broadcasting.
+-- * Please use RADIO setters or either @{Radio#RADIO.NewGenericTransmission} or @{Radio#RADIO.NewUnitTransmission}
+-- * This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
+-- * If the POSITIONABLE is not a UNIT or a GROUP, we use the generic (but limited) trigger.action.radioTransmission()
+-- * If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
+-- * If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
+-- * If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration are ignored
-- @param #RADIO self
-- @return #RADIO self
--- @usage
--- -- The Radio has to be populated with the new transmission before broadcasting.
--- -- Please use RADIO setters or either @{Radio#RADIO.NewGenericTransmission} or @{Radio#RADIO.NewUnitTransmission}
--- -- This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
--- -- If the POSITIONABLE is not a UNIT or a GROUP, we use the generic (but limited) trigger.action.radioTransmission()
--- -- If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
--- -- If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
--- -- If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration and Loop are ignored
function RADIO:Broadcast()
self:F()
-- If the POSITIONABLE is actually a UNIT or a GROUP, use the more complicated DCS command system
@@ -304,18 +310,17 @@ function RADIO:Broadcast()
})
else
-- If the POSITIONABLE is anything else, we revert to the general singleton function
+ -- I need to give it a unique name, so that the transmission can be stopped later. I use the class ID
self:T2("Broadcasting from a POSITIONABLE")
- trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, false, self.Frequency, self.Power)
+ trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, self.Loop, self.Frequency, self.Power, tostring(self.ID))
end
return self
end
--- Stops a transmission
+-- This function is especially usefull to stop the broadcast of looped transmissions
-- @param #RADIO self
-- @return #RADIO self
--- @usage
--- -- Especially usefull to stop the broadcast of looped transmissions
--- -- Only works with broadcasts from UNIT or GROUP
function RADIO:StopBroadcast()
self:F()
-- If the POSITIONABLE is a UNIT or a GROUP, stop the transmission with the DCS "StopTransmission" command
@@ -325,7 +330,257 @@ function RADIO:StopBroadcast()
params = {}
})
else
- self:E("This broadcast can't be stopped. It's not looped either, so please wait for the end of the sound file playback")
+ -- Else, we use the appropriate singleton funciton
+ trigger.action.stopRadioTransmission(tostring(self.ID))
end
return self
+end
+
+
+--- # BEACON class, extends @{Base#BASE}
+--
+-- After attaching a @{#BEACON} to your @{Positionable#POSITIONABLE}, you need to select the right function to activate the kind of beacon you want.
+-- There are two types of BEACONs available : the AA TACAN Beacon and the general purpose Radio Beacon.
+-- Note that in both case, you can set an optional parameter : the `BeaconDuration`. This can be very usefull to simulate the battery time if your BEACON is
+-- attach to a cargo crate, for exemple.
+--
+-- ## AA TACAN Beacon usage
+--
+-- This beacon only works with airborne @{Unit#UNIT} or a @{Group#GROUP}. Use @{#BEACON:AATACAN}() to set the beacon parameters and start the beacon.
+-- Use @#BEACON:StopAATACAN}() to stop it.
+--
+-- ## General Purpose Radio Beacon usage
+--
+-- This beacon will work with any @{Positionable#POSITIONABLE}, but **it won't follow the @{Positionable#POSITIONABLE}** ! This means that you should only use it with
+-- @{Positionable#POSITIONABLE} that don't move, or move very slowly. Use @{#BEACON:RadioBeacon}() to set the beacon parameters and start the beacon.
+-- Use @{#BEACON:StopRadioBeacon}() to stop it.
+--
+-- @type BEACON
+-- @extends Core.Base#BASE
+BEACON = {
+ ClassName = "BEACON",
+}
+
+--- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.AATACAN} or @{#BEACON.Generic}
+-- If you want to create a BEACON, you probably should use @{Positionable#POSITIONABLE.GetBeacon}() instead.
+-- @param #BEACON self
+-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
+-- @return #BEACON Beacon
+-- @return #nil If Positionable is invalid
+function BEACON:New(Positionable)
+ local self = BASE:Inherit(self, BASE:New())
+
+ self:F(Positionable)
+
+ if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
+ self.Positionable = Positionable
+ return self
+ end
+
+ self:E({"The passed positionable is invalid, no BEACON created", Positionable})
+ return nil
+end
+
+
+--- Converts a TACAN Channel/Mode couple into a frequency in Hz
+-- @param #BEACON self
+-- @param #number TACANChannel
+-- @param #string TACANMode
+-- @return #number Frequecy
+-- @return #nil if parameters are invalid
+function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
+ self:F3({TACANChannel, TACANMode})
+
+ if type(TACANChannel) ~= "number" then
+ if TACANMode ~= "X" and TACANMode ~= "Y" then
+ return nil -- error in arguments
+ end
+ end
+
+-- This code is largely based on ED's code, in DCS World\Scripts\World\Radio\BeaconTypes.lua, line 137.
+-- I have no idea what it does but it seems to work
+ local A = 1151 -- 'X', channel >= 64
+ local B = 64 -- channel >= 64
+
+ if TACANChannel < 64 then
+ B = 1
+ end
+
+ if TACANMode == 'Y' then
+ A = 1025
+ if TACANChannel < 64 then
+ A = 1088
+ end
+ else -- 'X'
+ if TACANChannel < 64 then
+ A = 962
+ end
+ end
+
+ return (A + TACANChannel - B) * 1000000
+end
+
+
+--- Activates a TACAN BEACON on an Aircraft.
+-- @param #BEACON self
+-- @param #number TACANChannel (the "10" part in "10Y"). Note that AA TACAN are only available on Y Channels
+-- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon
+-- @param #boolean Bearing Can the BEACON be homed on ?
+-- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a TACAN Beacon for a tanker
+-- local myUnit = UNIT:FindByName("MyUnit")
+-- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
+--
+-- myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
+function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
+ self:F({TACANChannel, Message, Bearing, BeaconDuration})
+
+ local IsValid = true
+
+ if not self.Positionable:IsAir() then
+ self:E({"The POSITIONABLE you want to attach the AA Tacan Beacon is not an aircraft ! The BEACON is not emitting", self.Positionable})
+ IsValid = false
+ end
+
+ local Frequency = self:_TACANToFrequency(TACANChannel, "Y")
+ if not Frequency then
+ self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
+ IsValid = false
+ end
+
+ -- I'm using the beacon type 4 (BEACON_TYPE_TACAN). For System, I'm using 5 (TACAN_TANKER_MODE_Y) if the bearing shows its bearing
+ -- or 14 (TACAN_AA_MODE_Y) if it does not
+ local System
+ if Bearing then
+ System = 5
+ else
+ System = 14
+ end
+
+ if IsValid then -- Starts the BEACON
+ self:T2({"AA TACAN BEACON started !"})
+ self.Positionable:SetCommand({
+ id = "ActivateBeacon",
+ params = {
+ type = 4,
+ system = System,
+ callsign = Message,
+ frequency = Frequency,
+ }
+ })
+
+ if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
+ SCHEDULER:New( nil,
+ function()
+ self:StopAATACAN()
+ end, {}, BeaconDuration)
+ end
+ end
+
+ return self
+end
+
+--- Stops the AA TACAN BEACON
+-- @param #BEACON self
+-- @return #BEACON self
+function BEACON:StopAATACAN()
+ self:F()
+ if not self.Positionable then
+ self:E({"Start the beacon first before stoping it !"})
+ else
+ self.Positionable:SetCommand({
+ id = 'DeactivateBeacon',
+ params = {
+ }
+ })
+ end
+end
+
+
+--- Activates a general pupose Radio Beacon
+-- This uses the very generic singleton function "trigger.action.radioTransmission()" provided by DCS to broadcast a sound file on a specific frequency.
+-- Although any frequency could be used, only 2 DCS Modules can home on radio beacons at the time of writing : the Huey and the Mi-8.
+-- They can home in on these specific frequencies :
+-- * **Mi8**
+-- * R-828 -> 20-60MHz
+-- * ARKUD -> 100-150MHz (canal 1 : 114166, canal 2 : 114333, canal 3 : 114583, canal 4 : 121500, canal 5 : 123100, canal 6 : 124100) AM
+-- * ARK9 -> 150-1300KHz
+-- * **Huey**
+-- * AN/ARC-131 -> 30-76 Mhz FM
+-- @param #BEACON self
+-- @param #string FileName The name of the audio file
+-- @param #number Frequency in MHz
+-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @param #number Power in W
+-- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a beacon for a unit in distress.
+-- -- Frequency will be 40MHz FM (home-able by a Huey's AN/ARC-131)
+-- -- The beacon they use is battery-powered, and only lasts for 5 min
+-- local UnitInDistress = UNIT:FindByName("Unit1")
+-- local UnitBeacon = UnitInDistress:GetBeacon()
+--
+-- -- Set the beacon and start it
+-- UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)
+function BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDuration)
+ self:F({FileName, Frequency, Modulation, Power, BeaconDuration})
+ local IsValid = false
+
+ -- Check the filename
+ if type(FileName) == "string" then
+ if FileName:find(".ogg") or FileName:find(".wav") then
+ if not FileName:find("l10n/DEFAULT/") then
+ FileName = "l10n/DEFAULT/" .. FileName
+ end
+ IsValid = true
+ end
+ end
+ if not IsValid then
+ self:E({"File name invalid. Maybe something wrong with the extension ? ", FileName})
+ end
+
+ -- Check the Frequency
+ if type(Frequency) ~= "number" and IsValid then
+ self:E({"Frequency invalid. ", Frequency})
+ IsValid = false
+ end
+ Frequency = Frequency * 1000000 -- Conversion to Hz
+
+ -- Check the modulation
+ if Modulation ~= radio.modulation.AM and Modulation ~= radio.modulation.FM and IsValid then --TODO Maybe make this future proof if ED decides to add an other modulation ?
+ self:E({"Modulation is invalid. Use DCS's enum radio.modulation.", Modulation})
+ IsValid = false
+ end
+
+ -- Check the Power
+ if type(Power) ~= "number" and IsValid then
+ self:E({"Power is invalid. ", Power})
+ IsValid = false
+ end
+ Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
+
+ if IsValid then
+ self:T2({"Activating Beacon on ", Frequency, Modulation})
+ -- Note that this is looped. I have to give this transmission a unique name, I use the class ID
+ trigger.action.radioTransmission(FileName, self.Positionable:GetPositionVec3(), Modulation, true, Frequency, Power, tostring(self.ID))
+
+ if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
+ SCHEDULER:New( nil,
+ function()
+ self:StopRadioBeacon()
+ end, {}, BeaconDuration)
+ end
+ end
+end
+
+--- Stops the AA TACAN BEACON
+-- @param #BEACON self
+-- @return #BEACON self
+function BEACON:StopRadioBeacon()
+ self:F()
+ -- The unique name of the transmission is the class ID
+ trigger.action.stopRadioTransmission(tostring(self.ID))
end
\ No newline at end of file
diff --git a/Moose Development/Moose/Wrapper/Positionable.lua b/Moose Development/Moose/Wrapper/Positionable.lua
index 270677ddb..8b4cc21f4 100644
--- a/Moose Development/Moose/Wrapper/Positionable.lua
+++ b/Moose Development/Moose/Wrapper/Positionable.lua
@@ -452,6 +452,14 @@ function POSITIONABLE:GetRadio()
return RADIO:New(self)
end
+--- Create a @{Radio#BEACON}, to allow this POSITIONABLE to broadcast beacon signals
+-- @param #POSITIONABLE self
+-- @return #RADIO Radio
+function POSITIONABLE:GetBeacon()
+ self:F2(self)
+ return BEACON:New(self)
+
+
--- Start Lasing a POSITIONABLE
-- @param #POSITIONABLE self
-- @param #POSITIONABLE Target
diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html
index d17c8e59a..5fa4419fa 100644
--- a/docs/Documentation/AI_Balancer.html
+++ b/docs/Documentation/AI_Balancer.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html
index 9a258b212..35b84c019 100644
--- a/docs/Documentation/AI_Cap.html
+++ b/docs/Documentation/AI_Cap.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html
index 277ff5e1c..7c46b6a45 100644
--- a/docs/Documentation/AI_Cas.html
+++ b/docs/Documentation/AI_Cas.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/AI_Designate.html b/docs/Documentation/AI_Designate.html
index df1b0359e..1815698ac 100644
--- a/docs/Documentation/AI_Designate.html
+++ b/docs/Documentation/AI_Designate.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html
index 3f3376551..f253cbe2e 100644
--- a/docs/Documentation/AI_Patrol.html
+++ b/docs/Documentation/AI_Patrol.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html
index 3f83cf7ca..3387edef3 100644
--- a/docs/Documentation/Account.html
+++ b/docs/Documentation/Account.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html
index 406aef9d1..630e0918b 100644
--- a/docs/Documentation/Airbase.html
+++ b/docs/Documentation/Airbase.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html
index 8f5a5788d..3d3b3ceeb 100644
--- a/docs/Documentation/AirbasePolice.html
+++ b/docs/Documentation/AirbasePolice.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html
index 7f0d5c263..0579f26f6 100644
--- a/docs/Documentation/Assign.html
+++ b/docs/Documentation/Assign.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html
index 30a860472..dcf9e813a 100644
--- a/docs/Documentation/Base.html
+++ b/docs/Documentation/Base.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html
index 2b21da531..ef9c1c937 100644
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html
index 6bceadbdd..01aae3068 100644
--- a/docs/Documentation/CleanUp.html
+++ b/docs/Documentation/CleanUp.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html
index a16ba5843..9635a22a1 100644
--- a/docs/Documentation/Client.html
+++ b/docs/Documentation/Client.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html
index 92d92cdc9..a0e8a7ae3 100644
--- a/docs/Documentation/CommandCenter.html
+++ b/docs/Documentation/CommandCenter.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html
index 97059f927..92bf16c73 100644
--- a/docs/Documentation/Controllable.html
+++ b/docs/Documentation/Controllable.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html
index a17c268a8..da829d646 100644
--- a/docs/Documentation/DCSAirbase.html
+++ b/docs/Documentation/DCSAirbase.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html
index 169eae7a3..07b526621 100644
--- a/docs/Documentation/DCSCoalitionObject.html
+++ b/docs/Documentation/DCSCoalitionObject.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html
index e376d7140..743f700be 100644
--- a/docs/Documentation/DCSCommand.html
+++ b/docs/Documentation/DCSCommand.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html
index 8fbfebdc6..483c298cb 100644
--- a/docs/Documentation/DCSController.html
+++ b/docs/Documentation/DCSController.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html
index ab68bb9f9..dbe661784 100644
--- a/docs/Documentation/DCSGroup.html
+++ b/docs/Documentation/DCSGroup.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html
index cb8f9511a..049c50fa6 100644
--- a/docs/Documentation/DCSObject.html
+++ b/docs/Documentation/DCSObject.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html
index dafc82daa..1d4bb4bc9 100644
--- a/docs/Documentation/DCSTask.html
+++ b/docs/Documentation/DCSTask.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html
index 4c6af5412..ceb462542 100644
--- a/docs/Documentation/DCSTypes.html
+++ b/docs/Documentation/DCSTypes.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html
index 217c9e4db..ea339ecfc 100644
--- a/docs/Documentation/DCSUnit.html
+++ b/docs/Documentation/DCSUnit.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html
index 053d821be..e85c51339 100644
--- a/docs/Documentation/DCSVec3.html
+++ b/docs/Documentation/DCSVec3.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html
index 67919a39e..5b681ec81 100644
--- a/docs/Documentation/DCSWorld.html
+++ b/docs/Documentation/DCSWorld.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html
index b8de6f70b..6212e6774 100644
--- a/docs/Documentation/DCSZone.html
+++ b/docs/Documentation/DCSZone.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html
index 7f906db86..6650c383d 100644
--- a/docs/Documentation/DCScountry.html
+++ b/docs/Documentation/DCScountry.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html
index cccf1a281..0b04715a8 100644
--- a/docs/Documentation/DCStimer.html
+++ b/docs/Documentation/DCStimer.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html
index 559b4a938..7d937a1cc 100644
--- a/docs/Documentation/DCStrigger.html
+++ b/docs/Documentation/DCStrigger.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html
index 42683bd36..56aa6d742 100644
--- a/docs/Documentation/Database.html
+++ b/docs/Documentation/Database.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html
index f5ebc18d1..c3dc0d729 100644
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html
index 41aa256ff..fa62fdd5b 100644
--- a/docs/Documentation/DetectionManager.html
+++ b/docs/Documentation/DetectionManager.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html
index d2c9807af..414abb60c 100644
--- a/docs/Documentation/Escort.html
+++ b/docs/Documentation/Escort.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html
index 5c5843e5a..700756bad 100644
--- a/docs/Documentation/Event.html
+++ b/docs/Documentation/Event.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html
index 9b6918395..e01356242 100644
--- a/docs/Documentation/Fsm.html
+++ b/docs/Documentation/Fsm.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html
index 7404cd7ba..ef518add8 100644
--- a/docs/Documentation/Group.html
+++ b/docs/Documentation/Group.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html
index 42ccbca59..e28701a7d 100644
--- a/docs/Documentation/Identifiable.html
+++ b/docs/Documentation/Identifiable.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html
index ec7099fe7..8ffae99b0 100644
--- a/docs/Documentation/Menu.html
+++ b/docs/Documentation/Menu.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html
index b85ad5af2..f79b7989d 100644
--- a/docs/Documentation/Message.html
+++ b/docs/Documentation/Message.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html
index 599c08c33..d51deb05b 100644
--- a/docs/Documentation/MissileTrainer.html
+++ b/docs/Documentation/MissileTrainer.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html
index e26e2d679..3fd0ce54a 100644
--- a/docs/Documentation/Mission.html
+++ b/docs/Documentation/Mission.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html
index 6c410e890..4df691742 100644
--- a/docs/Documentation/Movement.html
+++ b/docs/Documentation/Movement.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html
index 8d18b31f7..1e95fab2b 100644
--- a/docs/Documentation/Object.html
+++ b/docs/Documentation/Object.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html
index 44e1d0d90..f242af7ec 100644
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html
index 87cc09ff3..e208166ff 100644
--- a/docs/Documentation/Process_JTAC.html
+++ b/docs/Documentation/Process_JTAC.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html
index 883d39fb0..d3bd792b5 100644
--- a/docs/Documentation/Process_Pickup.html
+++ b/docs/Documentation/Process_Pickup.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html
index 81eb3f9a4..1a6575f42 100644
--- a/docs/Documentation/Radio.html
+++ b/docs/Documentation/Radio.html
@@ -62,7 +62,6 @@
Movement
Object
Point
- Positionable
Process_JTAC
Process_Pickup
Radio
@@ -95,7 +94,7 @@
Module Radio
-
Core - The RADIO class is responsible for transmitting radio communications.
+
Core - The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...
@@ -103,6 +102,8 @@
+
The Radio contains 2 classes : RADIO and BEACON
+
What are radio communications in DCS ?
@@ -128,7 +129,8 @@
Note that obviously, the frequency and the modulation of the transmission are important only if the players are piloting an Advanced System Modelling enabled aircraft,
like the A10C or the Mirage 2000C. They will hear the transmission if they are tuned on the right frequency and modulation (and if they are close enough - more on that below).
-If a FC3 airacraft is used, it will hear every communication, whatever the frequency and the modulation is set to.
+If a FC3 airacraft is used, it will hear every communication, whatever the frequency and the modulation is set to. The same is true for TACAN beacons. If your aircaft isn't compatible,
+you won't hear/be able to use the TACAN beacon informations.
@@ -137,6 +139,12 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
Global(s)
+
+ | BEACON |
+
+
+ |
+
| RADIO |
@@ -144,12 +152,60 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
|
+
+
+
| RADIO:Broadcast() |
- Actually Broadcast the transmission
+Actually Broadcast the transmission
+* The Radio has to be populated with the new transmission before broadcasting.
|
@@ -189,15 +245,19 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
- | RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power) |
+ RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop) |
- Create a new transmission, that is to say, populate the RADIO with relevant data
+Create a new transmission, that is to say, populate the RADIO with relevant data
+In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP,
+but it will work with a UNIT or a GROUP anyway.
|
| RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop) |
- Create a new transmission, that is to say, populate the RADIO with relevant data
+Create a new transmission, that is to say, populate the RADIO with relevant data
+In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
+but it will work for any Positionable#POSITIONABLE.
|
@@ -245,13 +305,15 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
| RADIO:SetSubtitle(Subtitle, SubtitleDuration) |
- Check validity of the subtitle and the subtitleDuration passed and sets RADIO.subtitle and RADIO.subtitleDuration
+Check validity of the subtitle and the subtitleDuration passed and sets RADIO.subtitle and RADIO.subtitleDuration
+Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
|
| RADIO:StopBroadcast() |
- Stops a transmission
+Stops a transmission
+This function is especially usefull to stop the broadcast of looped transmissions
|
@@ -272,6 +334,20 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
-
+ #BEACON
+
+BEACON
+
+
+-
+
+
+
+
+
+
+-
+
#RADIO
RADIO
@@ -285,11 +361,292 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
+
+
+BEACON class, extends Base#BASE
+
+After attaching a #BEACON to your Positionable#POSITIONABLE, you need to select the right function to activate the kind of beacon you want.
+
+
+There are two types of BEACONs available : the AA TACAN Beacon and the general purpose Radio Beacon.
+Note that in both case, you can set an optional parameter : the BeaconDuration. This can be very usefull to simulate the battery time if your BEACON is
+attach to a cargo crate, for exemple.
+
+AA TACAN Beacon usage
+
+This beacon only works with airborne Unit#UNIT or a Group#GROUP. Use #BEACON() to set the beacon parameters and start the beacon.
+Use @#BEACON:StopAATACAN}() to stop it.
+
+General Purpose Radio Beacon usage
+
+This beacon will work with any Positionable#POSITIONABLE, but **it won't follow the Positionable#POSITIONABLE** ! This means that you should only use it with
+Positionable#POSITIONABLE that don't move, or move very slowly. Use #BEACON() to set the beacon parameters and start the beacon.
+Use #BEACON() to stop it.
+
+
+ Field(s)
+
+-
+
+
+BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
+
+
+-
+
+
Activates a TACAN BEACON on an Aircraft.
+
+ Parameters
+
+ -
+
+
#number TACANChannel :
+(the "10" part in "10Y"). Note that AA TACAN are only available on Y Channels
+
+
+ -
+
+
#string Message :
+The Message that is going to be coded in Morse and broadcasted by the beacon
+
+
+ -
+
+
#boolean Bearing :
+Can the BEACON be homed on ?
+
+
+ -
+
+
#number BeaconDuration :
+How long will the beacon last in seconds. Omit for forever.
+
+
+
+ Return value
+
+#BEACON:
+self
+
+ Usage:
+ -- Let's create a TACAN Beacon for a tanker
+local myUnit = UNIT:FindByName("MyUnit")
+local myBeacon = myUnit:GetBeacon() -- Creates the beacon
+
+myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
+
+
+
+
+-
+
+ #string
+
+BEACON.ClassName
+
+
+-
+
+
+
+
+
+
+-
+
+
+BEACON:New(Positionable)
+
+
+-
+
+
Create a new BEACON Object.
+
+
+This doesn't activate the beacon, though, use BEACON.AATACAN or BEACON.Generic
+If you want to create a BEACON, you probably should use Positionable#POSITIONABLE.GetBeacon() instead.
+
+ Parameter
+
+ Return values
+
+ -
+
+
#BEACON:
+Beacon
+
+
+ -
+
+
#nil:
+If Positionable is invalid
+
+
+
+
+
+
+-
+
+
+BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDuration)
+
+
+-
+
+
Activates a general pupose Radio Beacon
+This uses the very generic singleton function "trigger.action.radioTransmission()" provided by DCS to broadcast a sound file on a specific frequency.
+
+
+Although any frequency could be used, only 2 DCS Modules can home on radio beacons at the time of writing : the Huey and the Mi-8.
+They can home in on these specific frequencies :
+ Mi8
+ R-828 -> 20-60MHz
+* ARKUD -> 100-150MHz (canal 1 : 114166, canal 2 : 114333, canal 3 : 114583, canal 4 : 121500, canal 5 : 123100, canal 6 : 124100) AM
+* ARK9 -> 150-1300KHz
+ Huey
+ AN/ARC-131 -> 30-76 Mhz FM
+
+ Parameters
+
+ -
+
+
#string FileName :
+The name of the audio file
+
+
+ -
+
+
#number Frequency :
+in MHz
+
+
+ -
+
+
#number Modulation :
+either radio.modulation.AM or radio.modulation.FM
+
+
+ -
+
+
#number Power :
+in W
+
+
+ -
+
+
#number BeaconDuration :
+How long will the beacon last in seconds. Omit for forever.
+
+
+
+ Return value
+
+#BEACON:
+self
+
+ Usage:
+ -- Let's create a beacon for a unit in distress.
+-- Frequency will be 40MHz FM (home-able by a Huey's AN/ARC-131)
+-- The beacon they use is battery-powered, and only lasts for 5 min
+local UnitInDistress = UNIT:FindByName("Unit1")
+local UnitBeacon = UnitInDistress:GetBeacon()
+
+-- Set the beacon and start it
+UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)
+
+
+
+
+-
+
+
+BEACON:StopAATACAN()
+
+
+-
+
+
Stops the AA TACAN BEACON
+
+ Return value
+
+#BEACON:
+self
+
+
+
+
+-
+
+
+BEACON:StopRadioBeacon()
+
+
+-
+
+
Stops the AA TACAN BEACON
+
+ Return value
+
+#BEACON:
+self
+
+
+
+
+-
+
+
+BEACON:_TACANToFrequency(TACANChannel, TACANMode)
+
+
+-
+
+
Converts a TACAN Channel/Mode couple into a frequency in Hz
+
+ Parameters
+
+ -
+
+
#number TACANChannel :
+
+
+ -
+
+
#string TACANMode :
+
+
+
+ Return values
+
+ -
+
+
#number:
+Frequecy
+
+
+ -
+
+
#nil:
+if parameters are invalid
+
+
+
+
+
+
-1) RADIO class, extends Base#BASE
+RADIO class, extends Base#BASE
-1.1) RADIO usage
+RADIO usage
There are 3 steps to a successful radio transmission.
@@ -305,14 +662,14 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
Additional Methods to set relevant parameters if the transmiter is a Unit#UNIT or a Group#GROUP
@@ -346,22 +703,24 @@ If a FC3 airacraft is used, it will hear every communication, whatever t
-
-
Actually Broadcast the transmission
+Actually Broadcast the transmission
+* The Radio has to be populated with the new transmission before broadcasting.
+
+
+
+ - Please use RADIO setters or either Radio#RADIO.NewGenericTransmission or Radio#RADIO.NewUnitTransmission
+ - This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
+ - If the POSITIONABLE is not a UNIT or a GROUP, we use the generic (but limited) trigger.action.radioTransmission()
+ - If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
+ - If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
+ - If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration are ignored
+
Return value
#RADIO:
self
- Usage:
- -- The Radio has to be populated with the new transmission before broadcasting.
--- Please use RADIO setters or either @{Radio#RADIO.NewGenericTransmission} or @{Radio#RADIO.NewUnitTransmission}
--- This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
--- If the POSITIONABLE is not a UNIT or a GROUP, we use the generic (but limited) trigger.action.radioTransmission()
--- If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
--- If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
--- If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration and Loop are ignored
-
@@ -446,7 +805,8 @@ self
Create a new RADIO Object.
-This doesn't broadcast a transmission, though, use RADIO.Broadcast to actually broadcast
+This doesn't broadcast a transmission, though, use RADIO.Broadcast to actually broadcast
+If you want to create a RADIO, you probably should use Positionable#POSITIONABLE.GetRadio() instead
Parameter
@@ -472,21 +832,23 @@ If Positionable is invalid
- Usage:
-
-- If you want to create a RADIO, you probably should use @{Positionable#POSITIONABLE.GetRadio}() instead
-
-
-RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power)
+RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)
-
-
Create a new transmission, that is to say, populate the RADIO with relevant data
+Create a new transmission, that is to say, populate the RADIO with relevant data
+In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP,
+but it will work with a UNIT or a GROUP anyway.
+
+
+Only the #RADIO and the Filename are mandatory
Parameters
@@ -512,6 +874,11 @@ either radio.modulation.AM or radio.modulation.FM
#number Power :
in W
+
+ -
+
+
Loop :
+
Return value
@@ -519,11 +886,6 @@ in W
#RADIO:
self
- Usage:
- -- In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP,
-but it will work with a UNIT or a GROUP anyway
--- Only the RADIO and the Filename are mandatory
-
@@ -535,7 +897,12 @@ but it will work with a UNIT or a GROUP anyway
-
-
Create a new transmission, that is to say, populate the RADIO with relevant data
+Create a new transmission, that is to say, populate the RADIO with relevant data
+In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
+but it will work for any Positionable#POSITIONABLE.
+
+
+Only the RADIO and the Filename are mandatory.
Parameters
@@ -578,11 +945,6 @@ either radio.modulation.AM or radio.modulation.FM
#RADIO:
self
- Usage:
-
-- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
-but it will work for any POSITIONABLE
--- Only the RADIO and the Filename are mandatory
-
@@ -759,7 +1121,8 @@ self
-
-
Check validity of the subtitle and the subtitleDuration passed and sets RADIO.subtitle and RADIO.subtitleDuration
+Check validity of the subtitle and the subtitleDuration passed and sets RADIO.subtitle and RADIO.subtitleDuration
+Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
Parameters
@@ -781,7 +1144,12 @@ in s
self
Usage:
-
-- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
+ -- create the broadcaster and attaches it a RADIO
+local MyUnit = UNIT:FindByName("MyUnit")
+local MyUnitRadio = MyUnit:GetRadio()
+
+-- add a subtitle for the next transmission, which will be up for 10s
+MyUnitRadio:SetSubtitle("My Subtitle, 10)
@@ -794,17 +1162,14 @@ self
-
-
Stops a transmission
+Stops a transmission
+This function is especially usefull to stop the broadcast of looped transmissions
Return value
#RADIO:
self
- Usage:
- -- Especially usefull to stop the broadcast of looped transmissions
--- Only works with broadcasts from UNIT or GROUP
-
diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html
index d8cee89d9..fd8564a6f 100644
--- a/docs/Documentation/Route.html
+++ b/docs/Documentation/Route.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html
index b574ee5e8..befe15421 100644
--- a/docs/Documentation/Scenery.html
+++ b/docs/Documentation/Scenery.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html
index a6c841425..9871c732b 100644
--- a/docs/Documentation/ScheduleDispatcher.html
+++ b/docs/Documentation/ScheduleDispatcher.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html
index b0e07d4a5..2344a52b8 100644
--- a/docs/Documentation/Scheduler.html
+++ b/docs/Documentation/Scheduler.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html
index eca127f05..7e5366752 100644
--- a/docs/Documentation/Scoring.html
+++ b/docs/Documentation/Scoring.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html
index 067d5c8f2..c7be240e7 100644
--- a/docs/Documentation/Sead.html
+++ b/docs/Documentation/Sead.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html
index a74f207e9..994c1fe35 100644
--- a/docs/Documentation/Set.html
+++ b/docs/Documentation/Set.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html
index 1daebbfe7..0e78290e4 100644
--- a/docs/Documentation/Smoke.html
+++ b/docs/Documentation/Smoke.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index 96abcc5f4..fc425af73 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html
index 50d0ec61a..dc1525554 100644
--- a/docs/Documentation/SpawnStatic.html
+++ b/docs/Documentation/SpawnStatic.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
@@ -444,6 +443,7 @@ ptional) The name of the new static.
-
+ #number
SPAWNSTATIC.SpawnIndex
diff --git a/docs/Documentation/Spot.html b/docs/Documentation/Spot.html
index 97013cc71..2a621520a 100644
--- a/docs/Documentation/Spot.html
+++ b/docs/Documentation/Spot.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
@@ -323,6 +322,7 @@ true if it is lasing
-
+
SPOT.ScheduleID
@@ -336,6 +336,7 @@ true if it is lasing
-
+
SPOT.Spot
diff --git a/docs/Documentation/Static.html b/docs/Documentation/Static.html
index 969de0fe0..449ae254b 100644
--- a/docs/Documentation/Static.html
+++ b/docs/Documentation/Static.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/StaticObject.html b/docs/Documentation/StaticObject.html
index 7648af701..79106ac1f 100644
--- a/docs/Documentation/StaticObject.html
+++ b/docs/Documentation/StaticObject.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Task.html b/docs/Documentation/Task.html
index 745408ed1..909924fdb 100644
--- a/docs/Documentation/Task.html
+++ b/docs/Documentation/Task.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Task_A2G.html b/docs/Documentation/Task_A2G.html
index e69ed8a75..e229ef3bd 100644
--- a/docs/Documentation/Task_A2G.html
+++ b/docs/Documentation/Task_A2G.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Task_A2G_Dispatcher.html b/docs/Documentation/Task_A2G_Dispatcher.html
index 56199fde1..181598508 100644
--- a/docs/Documentation/Task_A2G_Dispatcher.html
+++ b/docs/Documentation/Task_A2G_Dispatcher.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html
index 73897fb41..a8a39f7aa 100644
--- a/docs/Documentation/Task_Cargo.html
+++ b/docs/Documentation/Task_Cargo.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Task_PICKUP.html b/docs/Documentation/Task_PICKUP.html
index a5e5d70b1..d5ad2b0d0 100644
--- a/docs/Documentation/Task_PICKUP.html
+++ b/docs/Documentation/Task_PICKUP.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Unit.html b/docs/Documentation/Unit.html
index 33927e5d5..9f2bcf22d 100644
--- a/docs/Documentation/Unit.html
+++ b/docs/Documentation/Unit.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Utils.html b/docs/Documentation/Utils.html
index 088bf9bbf..1f689e540 100644
--- a/docs/Documentation/Utils.html
+++ b/docs/Documentation/Utils.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/Zone.html b/docs/Documentation/Zone.html
index 893b7d773..baee4a865 100644
--- a/docs/Documentation/Zone.html
+++ b/docs/Documentation/Zone.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/env.html b/docs/Documentation/env.html
index f56af08b7..ad4cc7f87 100644
--- a/docs/Documentation/env.html
+++ b/docs/Documentation/env.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/index.html b/docs/Documentation/index.html
index d651ef88a..97d2bbdfa 100644
--- a/docs/Documentation/index.html
+++ b/docs/Documentation/index.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
@@ -408,12 +407,6 @@ are design patterns allowing efficient (long-lasting) processes and workflows.
Point |
Core - POINT_VEC classes define an extensive API to manage 3D points in the simulation space.
- |
-
-
- | Positionable |
-
- This module contains the POSITIONABLE class.
|
@@ -431,7 +424,7 @@ are design patterns allowing efficient (long-lasting) processes and workflows.
| Radio |
- Core - The RADIO class is responsible for transmitting radio communications.
+Core - The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...
|
diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html
index e7e0a1632..8f6b05546 100644
--- a/docs/Documentation/land.html
+++ b/docs/Documentation/land.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio
diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html
index 1db62f852..89fac4048 100644
--- a/docs/Documentation/routines.html
+++ b/docs/Documentation/routines.html
@@ -62,7 +62,6 @@
- Movement
- Object
- Point
- - Positionable
- Process_JTAC
- Process_Pickup
- Radio