Laying the groundwork for the RADIO class

With a special emphasis on LDT Documentation
This commit is contained in:
Grey-Echo 2017-03-10 23:31:32 +01:00
parent 343de7fe69
commit ad0cac8356

View File

@ -0,0 +1,15 @@
--- 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
-- To actually broadcast your transmission, you need to use @{Radio#RADIO.Broadcast}
--
-- @module Radio
-- @author Grey-Echo