From 817274aa01aa83d7c679c940c00f10ff7165e4d9 Mon Sep 17 00:00:00 2001 From: Grey-Echo Date: Sun, 19 Mar 2017 21:56:19 +0100 Subject: [PATCH] Add details in RAD-002 and small corrections to LDoc --- Moose Development/Moose/Core/Radio.lua | 18 +++++++++--------- .../RAD-002 - Transmission Tips and Tricks.lua | 7 ++++++- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/Moose Development/Moose/Core/Radio.lua b/Moose Development/Moose/Core/Radio.lua index 1a8f4e77d..a9068274f 100644 --- a/Moose Development/Moose/Core/Radio.lua +++ b/Moose Development/Moose/Core/Radio.lua @@ -51,7 +51,7 @@ end --- Check validity of the filename passed and sets RADIO.FileName -- @param #RADIO self -- @param #string fileName of the sound --- @return self +-- @return #RADIO self -- @usage function RADIO:SetFileName(filename) self:F2(filename) @@ -71,7 +71,7 @@ end --- Check validity of the frequency passed and sets RADIO.Frequency -- @param #RADIO self -- @param #number frequency in MHz --- @return self +-- @return #RADIO self -- @usage function RADIO:SetFrequency(frequency) self:F2(frequency) @@ -99,7 +99,7 @@ end --- Check validity of the frequency passed and sets RADIO.Modulation -- @param #RADIO self -- @param #number modulation --- @return #self +-- @return #RADIO self -- @usage function RADIO:SetModulation(modulation) self:F2(modulation) @@ -116,7 +116,7 @@ end --- Check validity of the power passed and sets RADIO.Power -- @param #RADIO self -- @param #number Power --- @return #self +-- @return #RADIO self -- @usage function RADIO:SetPower(power) self:F2(power) @@ -131,7 +131,7 @@ end --- Check validity of the loop passed and sets RADIO.Loop -- @param #RADIO self -- @param #bool Loop --- @return #self +-- @return #RADIO self -- @usage function RADIO:SetLoop(loop) self:F2(loop) @@ -147,7 +147,7 @@ end -- @param #RADIO self -- @param #string Subtitle -- @param #number SubtitleDuration in s --- @return #self +-- @return #RADIO self -- @usage -- -- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration function RADIO:SetSubtitle(subtitle, subtitleDuration) @@ -174,7 +174,7 @@ end -- @param #number Frequency in MHz -- @param #number Modulation -- @param #number Power in W --- @return self +-- @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 @@ -199,7 +199,7 @@ end -- @param #number Frequency in MHz -- @param #number Modulation -- @param #bool Loop --- @return self +-- @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 @@ -219,7 +219,7 @@ end --- Actually Broadcast the transmission -- @param #RADIO self --- @return 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} diff --git a/Moose Test Missions/RAD - Radio/RAD-002 - Transmission Tips and Tricks/RAD-002 - Transmission Tips and Tricks.lua b/Moose Test Missions/RAD - Radio/RAD-002 - Transmission Tips and Tricks/RAD-002 - Transmission Tips and Tricks.lua index ee8581b55..600036db5 100644 --- a/Moose Test Missions/RAD - Radio/RAD-002 - Transmission Tips and Tricks/RAD-002 - Transmission Tips and Tricks.lua +++ b/Moose Test Missions/RAD - Radio/RAD-002 - Transmission Tips and Tricks/RAD-002 - Transmission Tips and Tricks.lua @@ -1,8 +1,13 @@ -- This test mission demonstrates the RADIO class in a practical scenario. -- 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. + +-- 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. -- 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 -- 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 160 : Viktor "Clear to land, One two five, Viktor" -- 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()