Close ×

AI.AI_A2A_Cap

AI -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
AI.AI_A2A_Dispatcher

AI - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
AI.AI_A2A_GCI

AI -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
AI.AI_A2A_Patrol

AI -- (R2.2) - Models the process of air patrol of airplanes.
AI.AI_A2G_BAI

AI -- Models the process of air to ground BAI engagement for airplanes and helicopters.
AI.AI_A2G_CAS

AI -- Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_A2G_Dispatcher

AI - Create an automated A2G defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
AI.AI_A2G_SEAD

AI -- Models the process of air to ground SEAD engagement for airplanes and helicopters.
AI.AI_AIR_Dispatcher

AI - Create an automated AIR defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP operations.
AI.AI_Air

AI - Models the process of AI air operations.
AI.AI_Air_Engage

AI -- Models the process of air to ground engagement for airplanes and helicopters.
AI.AI_Air_Patrol

AI -- Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
AI.AI_Air_Squadron

AI - Models squadrons for airplanes and helicopters.
AI.AI_Bai

AI -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
AI.AI_Balancer

AI -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.
AI.AI_Cap

AI -- Perform Combat Air Patrolling (CAP) for airplanes.
AI.AI_Cargo

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_APC

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry (cargo).
AI.AI_Cargo_Dispatcher

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
AI.AI_Cargo_Dispatcher_APC

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.
AI.AI_Cargo_Dispatcher_Airplane

AI -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
AI.AI_Cargo_Dispatcher_Helicopter

AI -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
AI.AI_Cargo_Helicopter

AI -- (R2.4) - Models the intelligent transportation of infantry (cargo).
AI.AI_Cas

AI -- Perform Close Air Support (CAS) near friendlies.
AI.AI_ESCORT_DISPATCHER_REQUEST

AI - Models the assignment of AI escorts to player flights upon request using the radio menu.
AI.AI_Escort

Functional -- Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
AI.AI_Escort_Dispatcher

AI - Models the automatic assignment of AI escorts to player flights.
AI.AI_Formation

AI -- Build large airborne formations of aircraft.
AI.AI_Patrol

AI -- Perform Air Patrolling for airplanes.
Actions.Account

Actions - ACT_ACCOUNT_ classes account for (detect, count & report) various DCS events occuring on Wrapper.Units.
Actions.Assign

(SP) (MP) (FSM) Accept or reject process for player (task) assignments.
Actions.Assist

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Actions.Route

(SP) (MP) (FSM) Route AI or players through waypoints or to zones.
Cargo.Cargo

Core -- Management of CARGO logistics, that can be transported from and to transportation carriers.
Cargo.CargoCrate

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoGroup

Cargo -- Management of grouped cargo logistics, which are based on a Wrapper.Group object.
Cargo.CargoSlingload

Cargo -- Management of single cargo crates, which are based on a Static object.
Cargo.CargoUnit

Cargo -- Management of single cargo logistics, which are based on a Wrapper.Unit object.
Core.Astar

Core - A* Pathfinding.
Core.Base

Core - The base class within the framework.
Core.Database

Core - Manages several databases containing templates, mission objects, and mission information.
Core.Event

Core - Models DCS event dispatching using a publish-subscribe model.
Core.Fsm

Core - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
Core.Goal

Core - Models the process to achieve goal(s).
Core.Menu

Core - Manage hierarchical menu structures and commands for players within a mission.
Core.Message

Core - Informs the players using messages during a simulation.
Core.Point

Core - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
Core.Radio

Core - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
Core.RadioQueue

Core - Queues Radio Transmissions.
Core.RadioSpeech

Core - Makes the radio talk.
Core.Report

Core - Provides a handy means to create messages and reports.
Core.ScheduleDispatcher

Core -- SCHEDULEDISPATCHER dispatches the different schedules.
Core.Scheduler

Core - Prepares and handles the execution of functions over scheduled time (intervals).
Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.
Core.Settings

Core - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
Core.Spawn

Core - Spawn dynamically new groups of units in running missions.
Core.SpawnStatic

Core - Spawn statics.
Core.Spot

Core - Management of spotting logistics, that can be activated and deactivated upon command.
Core.Timer

Core - Timer scheduler.
Core.UserFlag

Core - Manage user flags to interact with the mission editor trigger system and server side scripts.
Core.UserSound

Core - Manage user sound.
Core.Velocity

Core - Models a velocity or speed, which can be expressed in various formats according the settings.
Core.Zone

Core - Define zones within your mission of various forms, with various capabilities.
DCS

DCS API Prototypes
See the Simulator Scripting Engine Documentation on Hoggit for further explanation and examples.
ENUMS

Utilities Enumerators.
Functional.ATC_Ground

Functional -- Monitor airbase traffic and regulate speed while taxiing.
Functional.Arty

Functional - Control artillery units.
Functional.CleanUp

Functional -- Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
Functional.Designate

Functional -- Management of target Designation.
Functional.Detection

Functional -- Models the detection of enemy units by FACs or RECCEs and group them according various methods.
Functional.Escort

Functional -- Taking the lead of AI escorting your flight.
Functional.FOX

Functional - (R2.5) - Yet Another Missile Trainer.
Functional.MissileTrainer

Functional -- Train missile defence and deflection.
Functional.Movement

Functional -- Limit the movement of simulaneous moving ground vehicles.
Functional.PseudoATC

Functional - Rudimentary ATC.
Functional.Range

Functional - Range Practice.
Functional.Rat

Functional - Create random airtraffic in your missions.
Functional.Scoring

Functional - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
Functional.Sead

Functional -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
Functional.Suppression

Functional - Suppress fire of ground units when they get hit.
Functional.Warehouse

Functional - Simulation of logistic operations.
Functional.ZoneCaptureCoalition

Functional -- Models the process to zone guarding and capturing.
Functional.ZoneGoal

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone.
Functional.ZoneGoalCargo

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone and Cargo.
Functional.ZoneGoalCoalition

Functional (WIP) -- Base class that models processes to achieve goals involving a Zone for a Coalition.
Ops.Airboss

Ops - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).
Ops.Airwing

Ops - Airwing Warehouse.
Ops.ArmyGroup

Ops - Enhanced Ground Group.
Ops.Atis

Ops - Automatic Terminal Information Service (ATIS).
Ops.Auftrag

Ops - Auftrag (mission) for Ops.
Ops.FlightGroup

Ops - Enhanced Airborne Group.
Ops.Intel

Ops - Office of Military Intelligence.
Ops.NavyGroup

Ops - Enhanced Naval Group.
Ops.OpsGroup

Ops - Generic group enhancement functions.
Ops.RecoveryTanker

Ops - Recovery tanker for carrier operations.
Ops.RescueHelo

Ops - Rescue helicopter for carrier operations.
Ops.Squadron

Ops - Airwing Squadron.
Ops.Target

Ops - Target.
Tasking.CommandCenter

Tasking -- A command center governs multiple missions, and takes care of the reporting and communications.
Tasking.DetectionManager

Tasking - This module contains the DETECTION_MANAGER class and derived classes.
Tasking.Mission

Tasking -- A mission models a goal to be achieved through the execution and completion of tasks by human players.
Tasking.Task

Tasking -- A task object governs the main engine to administer human taskings.
Tasking.TaskInfo

Tasking -- Controls the information of a Task.
Tasking.TaskZoneCapture

Tasking - The TASK_Protect models tasks for players to protect or capture specific zones.
Tasking.Task_A2A

Tasking - The TASK_A2A models tasks for players in Air to Air engagements.
Tasking.Task_A2A_Dispatcher

Tasking - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
Tasking.Task_A2G

Tasking - The TASK_A2G models tasks for players in Air to Ground engagements.
Tasking.Task_A2G_Dispatcher

Tasking -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.
Tasking.Task_Cargo

Tasking -- Base class to model tasks for players to transport cargo.
Tasking.Task_Cargo_CSAR

Tasking -- Orchestrates the task for players to execute CSAR for downed pilots.
Tasking.Task_Cargo_Dispatcher

Tasking - Creates and manages player TASK_CARGO tasks.
Tasking.Task_Cargo_Transport

Tasking -- Models tasks for players to transport cargo.
Tasking.Task_Manager

This module contains the TASK_MANAGER class and derived classes.
Tasking.Task_Zone_Capture_Dispatcher

Tasking - Creates and manages player TASK_ZONE_CAPTURE tasks.
Utilities.PROFILER

Utils - Lua Profiler.
Utils

This module contains derived utilities taken from the MIST framework, which are excellent tools to be reused in an OO environment.
Wrapper.Airbase

Wrapper -- AIRBASE is a wrapper class to handle the DCS Airbase objects.
Wrapper.Client

Wrapper -- CLIENT wraps DCS Unit objects acting as a Client or Player within a mission.
Wrapper.Controllable

Wrapper -- CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".
Wrapper.Group

Wrapper -- GROUP wraps the DCS Class Group objects.
Wrapper.Identifiable

Wrapper -- IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.
Wrapper.Marker

Wrapper - Markers On the F10 map.
Wrapper.Object

Wrapper -- OBJECT wraps the DCS Object derived objects.
Wrapper.Positionable

Wrapper -- POSITIONABLE wraps DCS classes that are "positionable".
Wrapper.Scenery

Wrapper -- SCENERY models scenery within the DCS simulator.
Wrapper.Static

Wrapper -- STATIC wraps the DCS StaticObject class.
Wrapper.Unit

Wrapper - UNIT is a wrapper class for the DCS Class Unit.
routines

Various routines

Module Core.Radio

Core - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.

Features:

Provide radio functionality to broadcast radio transmissions.
Provide beacon functionality to assist pilots.

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),
They can be subtitled for a specific duration, the power in Watts of the transmiter's antenna can be set, and the transmission can be looped.

How to supply DCS my own Sound Files?

Your sound files need to be encoded in .ogg or .wav,
Your sound files should be as tiny as possible. It is suggested you encode in .ogg with low bitrate and sampling settings,
They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
For simplicity sake, you can let DCS' Mission Editor add the file itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.

Due to weird DCS quirks, radio communications behave differently if sent by a Wrapper.Unit#UNIT or a Wrapper.Group#GROUP or by any other Wrapper.Positionable#POSITIONABLE

If the transmitter is a Wrapper.Unit#UNIT or a Wrapper.Group#GROUP, DCS will set the power of the transmission automatically,
If the transmitter is any other Wrapper.Positionable#POSITIONABLE, the transmisison can't be subtitled or looped.

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 an FC3 aircraft 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 aircraft isn't compatible, you won't hear/be able to use the TACAN beacon informations.

Authors: Hugues "Grey_Echo" Bousquet, funkyfranky

Global(s)

Global BEACON

#BEACON BEACON

Global RADIO

#RADIO RADIO

Type(s)

Type BEACON

BEACON , extends Core.Base#BASE

Fields and Methods inherited from BEACON	Description
BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)	Activates a TACAN BEACON on an Aircraft.
BEACON:ActivateICLS(Channel, Callsign, Duration)	Activates an ICLS BEACON.
BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)	Activates a TACAN BEACON.
BEACON.ClassName	Name of the class "BEACON".
BEACON:New(Positionable)	Create a new BEACON Object.
BEACON.Positionable	The #CONTROLLABLE that will receive radio capabilities.
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.
BEACON:StopAATACAN()	Stops the AA TACAN BEACON
BEACON:StopRadioBeacon()	Stops the AA TACAN BEACON
BEACON.System
BEACON.Type
BEACON:_TACANToFrequency(TACANChannel, TACANMode)	Converts a TACAN Channel/Mode couple into a frequency in Hz
BEACON.name

Fields and Methods inherited from BASE	Description
BEACON.ClassID	The ID number of the class.
BEACON.ClassName	The name of the class.
BEACON.ClassNameAndID	The name of the class concatenated with the ID number of the class.
BEACON:ClearState(Object, StateName)	Clear the state of an object.
BEACON:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)	Creation of a Birth Event.
BEACON:CreateEventCrash(EventTime, Initiator)	Creation of a Crash Event.
BEACON:CreateEventDead(EventTime, Initiator)	Creation of a Dead Event.
BEACON:CreateEventRemoveUnit(EventTime, Initiator)	Creation of a Remove Unit Event.
BEACON:CreateEventTakeoff(EventTime, Initiator)	Creation of a Takeoff Event.
BEACON:CreateEventUnitLost(EventTime, Initiator)	Creation of a Crash Event.
BEACON:E(Arguments)	Log an exception which will be traced always.
BEACON:EventDispatcher()	Returns the event dispatcher
BEACON:EventRemoveAll()	Remove all subscribed events
BEACON:F(Arguments)	Trace a function call.
BEACON:F2(Arguments)	Trace a function call level 2.
BEACON:F3(Arguments)	Trace a function call level 3.
BEACON:GetClassID()	Get the ClassID of the class instance.
BEACON:GetClassName()	Get the ClassName of the class instance.
BEACON:GetClassNameAndID()	Get the ClassName + ClassID of the class instance.
BEACON:GetEventPriority()	Get the Class Event processing Priority.
BEACON:GetParent(Child, FromClass)	This is the worker method to retrieve the Parent class.
BEACON:GetState(Object, Key)	Get a Value given a Key from the Object.
BEACON:HandleEvent(Event, EventFunction)	Subscribe to a DCS Event.
BEACON:I(Arguments)	Log an information which will be traced always.
BEACON:Inherit(Child, Parent)	This is the worker method to inherit from a parent class.
BEACON:IsInstanceOf(ClassName)	This is the worker method to check if an object is an (sub)instance of a class.
BEACON:IsTrace()	Enquires if tracing is on (for the class).
BEACON:New()	BASE constructor.
BEACON:OnEvent(EventData)	Occurs when an object is completely destroyed.
BEACON:OnEventBaseCaptured(EventData)	Occurs when a ground unit captures either an airbase or a farp.
BEACON:OnEventBirth(EventData)	Occurs when any object is spawned into the mission.
BEACON:OnEventCrash(EventData)	Occurs when any aircraft crashes into the ground and is completely destroyed.
BEACON:OnEventDead(EventData)	Occurs when an object is dead.
BEACON:OnEventDetailedFailure(EventData)	Unknown precisely what creates this event, likely tied into newer damage model.
BEACON:OnEventEjection(EventData)	Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
BEACON:OnEventEngineShutdown(EventData)	Occurs when any aircraft shuts down its engines.
BEACON:OnEventEngineStartup(EventData)	Occurs when any aircraft starts its engines.
BEACON:OnEventHit(EventData)	Occurs whenever an object is hit by a weapon.
BEACON:OnEventHumanFailure(EventData)	Occurs when any system fails on a human controlled aircraft.
BEACON:OnEventKill(EventData)	Occurs on the death of a unit.
BEACON:OnEventLand(EventData)	Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.
BEACON:OnEventLandingAfterEjection(EventData)	Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
BEACON:OnEventMarkAdded(EventData)	Occurs when a new mark was added.
BEACON:OnEventMarkChange(EventData)	Occurs when a mark text was changed.
BEACON:OnEventMarkRemoved(EventData)	Occurs when a mark was removed.
BEACON:OnEventMissionEnd(EventData)	Occurs when a mission ends
BEACON:OnEventMissionStart(EventData)	Occurs when a mission starts
BEACON:OnEventPilotDead(EventData)	Occurs when the pilot of an aircraft is killed.
BEACON:OnEventPlayerEnterUnit(EventData)	Occurs when any player assumes direct control of a unit.
BEACON:OnEventPlayerLeaveUnit(EventData)	Occurs when any player relieves control of a unit to the AI.
BEACON:OnEventRefueling(EventData)	Occurs when an aircraft connects with a tanker and begins taking on fuel.
BEACON:OnEventRefuelingStop(EventData)	Occurs when an aircraft is finished taking fuel.
BEACON:OnEventScore(EventData)	Occurs when any modification to the "Score" as seen on the debrief menu would occur.
BEACON:OnEventShootingEnd(EventData)	Occurs when any unit stops firing its weapon.
BEACON:OnEventShootingStart(EventData)	Occurs when any unit begins firing a weapon that has a high rate of fire.
BEACON:OnEventShot(EventData)	Occurs whenever any unit in a mission fires a weapon.
BEACON:OnEventTakeoff(EventData)	Occurs when an aircraft takes off from an airbase, farp, or ship.
BEACON:OnEventUnitLost(EventData)	Occurs when the game thinks an object is destroyed.
BEACON:ScheduleOnce(Start, SchedulerFunction, ...)	Schedule a new time event.
BEACON:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)	Schedule a new time event.
BEACON:ScheduleStop(SchedulerFunction)	Stops the Schedule.
BEACON.Scheduler
BEACON:SetEventPriority(EventPriority)	Set the Class Event processing Priority.
BEACON:SetState(Object, Key, Value)	Set a state or property of the Object given a Key and a Value.
BEACON:T(Arguments)	Trace a function logic level 1.
BEACON:T2(Arguments)	Trace a function logic level 2.
BEACON:T3(Arguments)	Trace a function logic level 3.
BEACON:TraceAll(TraceAll)	Trace all methods in MOOSE
BEACON:TraceClass(Class)	Set tracing for a class
BEACON:TraceClassMethod(Class, Method)	Set tracing for a specific method of class
BEACON:TraceLevel(Level)	Set trace level
BEACON:TraceOff()	Set trace off.
BEACON:TraceOn()	Set trace on.
BEACON:TraceOnOff(TraceOnOff)	Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
BEACON:UnHandleEvent(Event)	UnSubscribe to a DCS event.
BEACON._
BEACON:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function call.
BEACON:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function logic.
BEACON.__
BEACON:onEvent(event)

Type BEACON.System

BEACON.System

Fields and Methods inherited from BEACON.System	Description
BEACON.System.BROADCAST_STATION	Broadcast station.
BEACON.System.ICLS_GLIDESLOPE	Carrier landing system.
BEACON.System.ICLS_LOCALIZER	Carrier landing system.
BEACON.System.ILS_GLIDESLOPE	ILS glideslope.
BEACON.System.ILS_LOCALIZER	ILS localizer
BEACON.System.PAR_10	?
BEACON.System.PRGM_GLIDESLOPE	PRGM glideslope.
BEACON.System.PRGM_LOCALIZER	PRGM localizer.
BEACON.System.PRMG_GLIDESLOPE
BEACON.System.PRMG_LOCALIZER
BEACON.System.RSBN_5	Russian VOR/DME system.
BEACON.System.TACAN	TACtical Air Navigation system on ground.
BEACON.System.TACAN_AA_MODE_X	TACtical Air Navigation for aircraft on X band.
BEACON.System.TACAN_AA_MODE_Y	TACtical Air Navigation for aircraft on Y band.
BEACON.System.TACAN_TANKER_X	TACtical Air Navigation system for tankers on X band.
BEACON.System.TACAN_TANKER_Y	TACtical Air Navigation system for tankers on Y band.
BEACON.System.VOR	Very High Frequency Omni-Directional Range
BEACON.System.VORDME	Radio beacon that combines a VHF omnidirectional range (VOR) with a distance measuring equipment (DME).
BEACON.System.VORTAC	Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omnidirectional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.

Type BEACON.Type

BEACON.Type

Fields and Methods inherited from BEACON.Type	Description
BEACON.Type.AIRPORT_HOMER
BEACON.Type.AIRPORT_HOMER_WITH_MARKER
BEACON.Type.BROADCAST_STATION
BEACON.Type.DME
BEACON.Type.HOMER
BEACON.Type.ICLS	Same as ICLS glideslope.
BEACON.Type.ICLS_GLIDESLOPE
BEACON.Type.ICLS_LOCALIZER
BEACON.Type.ILS_FAR_HOMER
BEACON.Type.ILS_GLIDESLOPE
BEACON.Type.ILS_LOCALIZER
BEACON.Type.ILS_NEAR_HOMER
BEACON.Type.NAUTICAL_HOMER
BEACON.Type.NULL
BEACON.Type.PRMG_GLIDESLOPE
BEACON.Type.PRMG_LOCALIZER
BEACON.Type.RSBN
BEACON.Type.TACAN	TACtical Air Navigation system.
BEACON.Type.VOR
BEACON.Type.VORTAC
BEACON.Type.VOR_DME

Type RADIO

RADIO , extends Core.Base#BASE

Fields and Methods inherited from RADIO	Description
RADIO:Broadcast(viatrigger)	Broadcast the transmission.
RADIO.ClassName
RADIO.FileName	Name of the sound file played.
RADIO.Frequency	Frequency of the transmission in Hz.
RADIO:GetAlias()	Get alias of the transmitter.
RADIO.Loop	Transmission is repeated (default true).
RADIO.Modulation	Modulation of the transmission (either radio.modulation.AM or radio.modulation.FM).
RADIO:New(Positionable)	Create a new RADIO Object.
RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)	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 In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP, but it will work for any Wrapper.Positionable#POSITIONABLE.
RADIO.Positionable	The #CONTROLLABLE that will transmit the radio calls.
RADIO.Power	Power of the antenna is Watts.
RADIO:SetAlias(alias)	Set alias of the transmitter.
RADIO:SetFileName(FileName)	Set the file name for the radio transmission.
RADIO:SetFrequency(Frequency)	Set the frequency for the radio transmission.
RADIO:SetLoop(Loop)	Set message looping on or off.
RADIO:SetModulation(Modulation)	Set AM or FM modulation of the radio transmitter.
RADIO:SetPower(Power)	Check validity of the power passed and sets RADIO.Power
RADIO:SetSubtitle(Subtitle, 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 This function is especially usefull to stop the broadcast of looped transmissions
RADIO.Subtitle	Subtitle of the transmission.
RADIO.SubtitleDuration	Duration of the Subtitle in seconds.
RADIO.alias	Name of the radio transmitter.

Fields and Methods inherited from BASE	Description
RADIO.ClassID	The ID number of the class.
RADIO.ClassName	The name of the class.
RADIO.ClassNameAndID	The name of the class concatenated with the ID number of the class.
RADIO:ClearState(Object, StateName)	Clear the state of an object.
RADIO:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)	Creation of a Birth Event.
RADIO:CreateEventCrash(EventTime, Initiator)	Creation of a Crash Event.
RADIO:CreateEventDead(EventTime, Initiator)	Creation of a Dead Event.
RADIO:CreateEventRemoveUnit(EventTime, Initiator)	Creation of a Remove Unit Event.
RADIO:CreateEventTakeoff(EventTime, Initiator)	Creation of a Takeoff Event.
RADIO:CreateEventUnitLost(EventTime, Initiator)	Creation of a Crash Event.
RADIO:E(Arguments)	Log an exception which will be traced always.
RADIO:EventDispatcher()	Returns the event dispatcher
RADIO:EventRemoveAll()	Remove all subscribed events
RADIO:F(Arguments)	Trace a function call.
RADIO:F2(Arguments)	Trace a function call level 2.
RADIO:F3(Arguments)	Trace a function call level 3.
RADIO:GetClassID()	Get the ClassID of the class instance.
RADIO:GetClassName()	Get the ClassName of the class instance.
RADIO:GetClassNameAndID()	Get the ClassName + ClassID of the class instance.
RADIO:GetEventPriority()	Get the Class Event processing Priority.
RADIO:GetParent(Child, FromClass)	This is the worker method to retrieve the Parent class.
RADIO:GetState(Object, Key)	Get a Value given a Key from the Object.
RADIO:HandleEvent(Event, EventFunction)	Subscribe to a DCS Event.
RADIO:I(Arguments)	Log an information which will be traced always.
RADIO:Inherit(Child, Parent)	This is the worker method to inherit from a parent class.
RADIO:IsInstanceOf(ClassName)	This is the worker method to check if an object is an (sub)instance of a class.
RADIO:IsTrace()	Enquires if tracing is on (for the class).
RADIO:New()	BASE constructor.
RADIO:OnEvent(EventData)	Occurs when an object is completely destroyed.
RADIO:OnEventBaseCaptured(EventData)	Occurs when a ground unit captures either an airbase or a farp.
RADIO:OnEventBirth(EventData)	Occurs when any object is spawned into the mission.
RADIO:OnEventCrash(EventData)	Occurs when any aircraft crashes into the ground and is completely destroyed.
RADIO:OnEventDead(EventData)	Occurs when an object is dead.
RADIO:OnEventDetailedFailure(EventData)	Unknown precisely what creates this event, likely tied into newer damage model.
RADIO:OnEventEjection(EventData)	Occurs when a pilot ejects from an aircraft initiator : The unit that has ejected
RADIO:OnEventEngineShutdown(EventData)	Occurs when any aircraft shuts down its engines.
RADIO:OnEventEngineStartup(EventData)	Occurs when any aircraft starts its engines.
RADIO:OnEventHit(EventData)	Occurs whenever an object is hit by a weapon.
RADIO:OnEventHumanFailure(EventData)	Occurs when any system fails on a human controlled aircraft.
RADIO:OnEventKill(EventData)	Occurs on the death of a unit.
RADIO:OnEventLand(EventData)	Occurs when an aircraft lands at an airbase, farp or ship initiator : The unit that has landed place: Object that the unit landed on.
RADIO:OnEventLandingAfterEjection(EventData)	Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.
RADIO:OnEventMarkAdded(EventData)	Occurs when a new mark was added.
RADIO:OnEventMarkChange(EventData)	Occurs when a mark text was changed.
RADIO:OnEventMarkRemoved(EventData)	Occurs when a mark was removed.
RADIO:OnEventMissionEnd(EventData)	Occurs when a mission ends
RADIO:OnEventMissionStart(EventData)	Occurs when a mission starts
RADIO:OnEventPilotDead(EventData)	Occurs when the pilot of an aircraft is killed.
RADIO:OnEventPlayerEnterUnit(EventData)	Occurs when any player assumes direct control of a unit.
RADIO:OnEventPlayerLeaveUnit(EventData)	Occurs when any player relieves control of a unit to the AI.
RADIO:OnEventRefueling(EventData)	Occurs when an aircraft connects with a tanker and begins taking on fuel.
RADIO:OnEventRefuelingStop(EventData)	Occurs when an aircraft is finished taking fuel.
RADIO:OnEventScore(EventData)	Occurs when any modification to the "Score" as seen on the debrief menu would occur.
RADIO:OnEventShootingEnd(EventData)	Occurs when any unit stops firing its weapon.
RADIO:OnEventShootingStart(EventData)	Occurs when any unit begins firing a weapon that has a high rate of fire.
RADIO:OnEventShot(EventData)	Occurs whenever any unit in a mission fires a weapon.
RADIO:OnEventTakeoff(EventData)	Occurs when an aircraft takes off from an airbase, farp, or ship.
RADIO:OnEventUnitLost(EventData)	Occurs when the game thinks an object is destroyed.
RADIO:ScheduleOnce(Start, SchedulerFunction, ...)	Schedule a new time event.
RADIO:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)	Schedule a new time event.
RADIO:ScheduleStop(SchedulerFunction)	Stops the Schedule.
RADIO.Scheduler
RADIO:SetEventPriority(EventPriority)	Set the Class Event processing Priority.
RADIO:SetState(Object, Key, Value)	Set a state or property of the Object given a Key and a Value.
RADIO:T(Arguments)	Trace a function logic level 1.
RADIO:T2(Arguments)	Trace a function logic level 2.
RADIO:T3(Arguments)	Trace a function logic level 3.
RADIO:TraceAll(TraceAll)	Trace all methods in MOOSE
RADIO:TraceClass(Class)	Set tracing for a class
RADIO:TraceClassMethod(Class, Method)	Set tracing for a specific method of class
RADIO:TraceLevel(Level)	Set trace level
RADIO:TraceOff()	Set trace off.
RADIO:TraceOn()	Set trace on.
RADIO:TraceOnOff(TraceOnOff)	Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.
RADIO:UnHandleEvent(Event)	UnSubscribe to a DCS event.
RADIO._
RADIO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function call.
RADIO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)	Trace a function logic.
RADIO.__
RADIO:onEvent(event)

Type Core.Radio

Type BEACON

After attaching a #BEACON to your Wrapper.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 Wrapper.Unit#UNIT or a Wrapper.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 Wrapper.Positionable#POSITIONABLE, but **it won't follow the Wrapper.Positionable#POSITIONABLE** ! This means that you should only use it with Wrapper.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)

#string BEACON.ClassName

Name of the class "BEACON".

Wrapper.Controllable#CONTROLLABLE BEACON.Positionable

The #CONTROLLABLE that will receive radio capabilities.

#BEACON.System BEACON.System

#BEACON.Type BEACON.Type

BEACON.name

Function(s)

BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)

Activates a TACAN BEACON on an Aircraft.

Defined in:

BEACON

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

BEACON:ActivateICLS(Channel, Callsign, Duration)

Activates an ICLS BEACON.

The unit the BEACON is attached to should be an aircraft carrier supporting this system.

Defined in:

BEACON

Parameters:

#number Channel

ICLS channel.

#string Callsign

The Message that is going to be coded in Morse and broadcasted by the beacon.

#number Duration

How long will the beacon last in seconds. Omit for forever.

Return value:

#BEACON:

self

BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)

Activates a TACAN BEACON.

Defined in:

BEACON

Parameters:

#number Channel

TACAN channel, i.e. the "10" part in "10Y".

#string Mode

TACAN mode, i.e. the "Y" part in "10Y".

#string Message

The Message that is going to be coded in Morse and broadcasted by the beacon.

#boolean Bearing

If true, beacon provides bearing information. If false (or nil), only distance information is available.

#number Duration

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:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon

BEACON:New(Positionable)

Create a new BEACON Object.

This doesn't activate the beacon, though, use BEACON.ActivateTACAN etc. If you want to create a BEACON, you probably should use Wrapper.Positionable#POSITIONABLE.GetBeacon() instead.

Defined in:

BEACON

Parameter:

Wrapper.Positionable#POSITIONABLE Positionable

The Positionable that will receive radio capabilities.

Return value:

#BEACON:

Beacon object or #nil if the 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

Defined in:

BEACON

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)