mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
921743bf20
the implementation made me realize the need for RADIO.VerifyFileName() and RADIO.ConvertFrequency(), so they are both implemented in this commit to.
96 lines
2.9 KiB
Lua
96 lines
2.9 KiB
Lua
--- This module contains the MESSAGE class.
|
|
--
|
|
-- 1) @{Radio#RADIO} class, extends @{Base#BASE}
|
|
-- =================================================
|
|
-- Radio system to manage radio communications
|
|
-- Radio transmissions consist of sound files that are broadcasted on a specific channel and modulation
|
|
-- If sent by a UNIT or a GROUP, Radio communications can be subtitled for a specific amount of time
|
|
--
|
|
-- 1.1) RADIO construction methods
|
|
-- -------------------------------
|
|
-- RADIO is created with @{Radio#RADIO.New}. This doesn't broadcast a transmission, but only create a RADIO object
|
|
-- It should only be used internally. To create a RADIO object, please use @{Identifiable#IDENIFIABLE.GetRadio}
|
|
-- To actually broadcast your transmission, you need to use @{Radio#RADIO.Broadcast}
|
|
--
|
|
-- @module Radio
|
|
-- @author Grey-Echo
|
|
|
|
--- The RADIO class
|
|
-- @type RADIO
|
|
-- @extends Core.Base#BASE
|
|
MESSAGE = {
|
|
ClassName = "RADIO",
|
|
Identifiable = IDENTIFIABLE:New(),
|
|
FileName = "",
|
|
Frequency = 255000,
|
|
Power = 100,
|
|
Modulation = 0,
|
|
Loop = 0,
|
|
Subtitle = "",
|
|
SubtitleDuration = ""
|
|
}
|
|
|
|
--- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{Radio#RADIO.Broadcast} to actually broadcast
|
|
-- @param self
|
|
-- @param
|
|
-- @return #RADIO
|
|
-- @usage
|
|
-- -- If you want to create a RADIO, you probably should use @{Identifiable#IDENIFIABLE.GetRadio}
|
|
function RADIO:New(identifiable)
|
|
local self = BASE:Inherit( self, BASE:New() )
|
|
self:F( { MessageText, MessageDuration, MessageCategory } )
|
|
|
|
self.Identifiable = identifiable
|
|
return self
|
|
end
|
|
|
|
--- Add the 'l10n/DEFAULT/' in the file name if necessary
|
|
-- @param #string File name
|
|
-- @return #string Corrected file name
|
|
-- @usage
|
|
-- -- internal use only
|
|
function RADIO.VerifyFileName(filename)
|
|
if filename:find("l10n/DEFAULT/") == nil then
|
|
filename = "l10n/DEFAULT/" .. filename
|
|
end
|
|
return filename
|
|
end
|
|
|
|
--- Whatever the Frequency's unit is, returns the frequency in Hz.
|
|
-- @param #number Frequency
|
|
-- @return #string Frequency in Hz
|
|
-- @usage
|
|
-- -- internal use only
|
|
-- -- Frequency has to be an integer.
|
|
function RADIO.ConvertFrequency(frequency)
|
|
local digitCount = 0
|
|
for i in string.gmatch(frequency, "%d") do
|
|
digitCount = digitCount + 1
|
|
end
|
|
for i = (9 - digitCount), 0, -1 do
|
|
frequency = frequency .. "0"
|
|
end
|
|
return frequency
|
|
end
|
|
|
|
--- Create a new transmission, that is to say, populate the RADIO with relevant data
|
|
-- @param #string Filename
|
|
-- @param #number Frequency
|
|
-- @param #number Modulation
|
|
-- @param #number Power
|
|
-- @return 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
|
|
function RADIO:NewTransmission(filename, frequency, mod, power)
|
|
self.FileName = RADIO.VerifyFile(filename)
|
|
self.Frequecy = RADIO.ConvertFrequency(frequency)
|
|
self.Modulation = mod
|
|
self.Power = power
|
|
end
|
|
|
|
|
|
|
|
|
|
|