Add details in RAD-002 and small corrections to LDoc

This commit is contained in:
Grey-Echo 2017-03-19 21:56:19 +01:00
parent 4c7e839ef8
commit 817274aa01
2 changed files with 15 additions and 10 deletions

View File

@ -51,7 +51,7 @@ end
--- Check validity of the filename passed and sets RADIO.FileName --- Check validity of the filename passed and sets RADIO.FileName
-- @param #RADIO self -- @param #RADIO self
-- @param #string fileName of the sound -- @param #string fileName of the sound
-- @return self -- @return #RADIO self
-- @usage -- @usage
function RADIO:SetFileName(filename) function RADIO:SetFileName(filename)
self:F2(filename) self:F2(filename)
@ -71,7 +71,7 @@ end
--- Check validity of the frequency passed and sets RADIO.Frequency --- Check validity of the frequency passed and sets RADIO.Frequency
-- @param #RADIO self -- @param #RADIO self
-- @param #number frequency in MHz -- @param #number frequency in MHz
-- @return self -- @return #RADIO self
-- @usage -- @usage
function RADIO:SetFrequency(frequency) function RADIO:SetFrequency(frequency)
self:F2(frequency) self:F2(frequency)
@ -99,7 +99,7 @@ end
--- Check validity of the frequency passed and sets RADIO.Modulation --- Check validity of the frequency passed and sets RADIO.Modulation
-- @param #RADIO self -- @param #RADIO self
-- @param #number modulation -- @param #number modulation
-- @return #self -- @return #RADIO self
-- @usage -- @usage
function RADIO:SetModulation(modulation) function RADIO:SetModulation(modulation)
self:F2(modulation) self:F2(modulation)
@ -116,7 +116,7 @@ end
--- Check validity of the power passed and sets RADIO.Power --- Check validity of the power passed and sets RADIO.Power
-- @param #RADIO self -- @param #RADIO self
-- @param #number Power -- @param #number Power
-- @return #self -- @return #RADIO self
-- @usage -- @usage
function RADIO:SetPower(power) function RADIO:SetPower(power)
self:F2(power) self:F2(power)
@ -131,7 +131,7 @@ end
--- Check validity of the loop passed and sets RADIO.Loop --- Check validity of the loop passed and sets RADIO.Loop
-- @param #RADIO self -- @param #RADIO self
-- @param #bool Loop -- @param #bool Loop
-- @return #self -- @return #RADIO self
-- @usage -- @usage
function RADIO:SetLoop(loop) function RADIO:SetLoop(loop)
self:F2(loop) self:F2(loop)
@ -147,7 +147,7 @@ end
-- @param #RADIO self -- @param #RADIO self
-- @param #string Subtitle -- @param #string Subtitle
-- @param #number SubtitleDuration in s -- @param #number SubtitleDuration in s
-- @return #self -- @return #RADIO self
-- @usage -- @usage
-- -- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration -- -- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
function RADIO:SetSubtitle(subtitle, subtitleDuration) function RADIO:SetSubtitle(subtitle, subtitleDuration)
@ -174,7 +174,7 @@ end
-- @param #number Frequency in MHz -- @param #number Frequency in MHz
-- @param #number Modulation -- @param #number Modulation
-- @param #number Power in W -- @param #number Power in W
-- @return self -- @return #RADIO self
-- @usage -- @usage
-- -- In this function the data is especially relevant if the broadcaster is anything but a UNIT or a GROUP, -- -- 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 -- but it will work with a UNIT or a GROUP anyway
@ -199,7 +199,7 @@ end
-- @param #number Frequency in MHz -- @param #number Frequency in MHz
-- @param #number Modulation -- @param #number Modulation
-- @param #bool Loop -- @param #bool Loop
-- @return self -- @return #RADIO self
-- @usage -- @usage
-- -- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP, -- -- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
-- but it will work for any POSITIONABLE -- but it will work for any POSITIONABLE
@ -219,7 +219,7 @@ end
--- Actually Broadcast the transmission --- Actually Broadcast the transmission
-- @param #RADIO self -- @param #RADIO self
-- @return self -- @return #RADIO self
-- @usage -- @usage
-- -- The Radio has to be populated with the new transmission before broadcasting. -- -- 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} -- Please use RADIO setters or either @{Radio#RADIO.NewGenericTransmission} or @{Radio#RADIO.NewUnitTransmission}

View File

@ -1,8 +1,13 @@
-- This test mission demonstrates the RADIO class in a practical scenario. -- This test mission demonstrates the RADIO class in a practical scenario.
-- It also focuses on how to create transmissions faster and more efficiently -- It also focuses on how to create transmissions faster and more efficiently
-- Please Read both RAD-000 and RAD-001, as well as SCH-000 code first. -- Please Read both RAD-000 and RAD-001, as well as SCH-000 code first.
-- Note that if you are not using an ASM aircraft (a clickable cockpit aircraft), then the frequency and the modulation is not important.
-- If you want to test the mission fully, replance the SU25T by an ASM aircraft you own and tune to the right frequency (115AM here)
-- The Player is in a Su25T parked on Batumi, and a Russian command center named "Batumi Tower" placed near Batumi will act as Batumi's Radio Tower. -- The Player is in a Su25T parked on Batumi, and a Russian command center named "Batumi Tower" placed near Batumi will act as Batumi's Radio Tower.
-- This mission also features the "Viktor" flight, a Russian Su25, who is inbound for landing on Batumi. -- This mission also features the "Viktor" flight, a Russian Su25, who is inbound for landing on Batumi.
-- The goal of this script is to manage the dialog between Viktor and Batumi Tower.
-- The (short) conversation between Viktor and Batumi Tower will happen on 115 AM -- The (short) conversation between Viktor and Batumi Tower will happen on 115 AM
-- Time 0 : Batumi Tower "Viktor flight, this is Batumi Tower, enter left base runway one two five, report 5 kilometers final. Over." -- Time 0 : Batumi Tower "Viktor flight, this is Batumi Tower, enter left base runway one two five, report 5 kilometers final. Over."
@ -11,7 +16,7 @@
-- Time 154 : Batumi Tower "Viktor flight, you are claer to land, runway one two five. Check gear down." -- Time 154 : Batumi Tower "Viktor flight, you are claer to land, runway one two five. Check gear down."
-- Time 160 : Viktor "Clear to land, One two five, Viktor" -- Time 160 : Viktor "Clear to land, One two five, Viktor"
-- Time 210 : Viktor "Viktor, touchdown" -- Time 210 : Viktor "Viktor, touchdown"
-- Time 215 : Batumi Tower "Viktor, confirmed touchdown, taxi to parking area" -- Time 215 : Batumi Tower "Viktor, confirmed touchdown, taxi to parking area, Batumi Tower out."
BatumiRadio = STATIC:FindByName("Batumi Tower"):GetRadio() BatumiRadio = STATIC:FindByName("Batumi Tower"):GetRadio()