DCS command transmitMessage

From DCS World Wiki - Hoggitworld.com
Revision as of 08:29, 26 May 2021 by Grimes (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Task: TransmitMessage Added with: 1.5
Hierarchy: Scripting Root > Tasks > Command > TransmitMessage
Tasking Type: Command
For: Airplanes, Helicopters, Ground Vehicles, Ships
Available Under: All tasks types
Description: Transmits an audio message from the unit/group over the currently active radio frequency and modulation. This message will be effected by the radio simulation present within the game. Messages may be inaudible due to distance or obstructions. If the simulation deems the player can hear that the transmission exists (even as static) the subtitles may be displayed.
Format: This task needs to be in the following format.
TransmitMessage = { 
  id = 'TransmitMessage', 
  params = {
    duration = number,
    subtitle = string,
    loop = boolean,
    file = string,

Required parameters: file

file: sound file name to be played.

Optional Parameters: duration, loop, subtitle

loop: if set to true the radio message will repeat the moment the audio message has ended.

duration: Length of time the subtitles will be displayed. Not applicable if loop is set to true.

subtitle: Text to appear in the radio message queue (default top left corner of screen)

Enumerators: N/A
Examples: The following will transmit a message from a group named "someFlight" and play the wave file tusk_onstation.wav.
   local msg = { 
     id = 'TransmitMessage', 
     params = {
       duration = 5,
       subtitle = "Radio Message",
       loop = false,
       file ="l10n/DEFAULT/tusk_onstation.wav",
Notes: For reducing radio communications or outright silencing the group see the relevant options. Prohibit WP Pass Report and Silence

See article Mission Editor: AI Tasking for more information on how AI tasking is handled within DCS.

Task List: Task Wrappers: mission, ComboTask, ControlledTask, WrappedAction

Tasks: AttackGroup, AttackUnit, Bombing, Strafing, CarpetBombing, AttackMapObject, BombingRunway, orbit, refueling, land, follow, followBigFormation, escort, Embarking, fireAtPoint, hold, FAC_AttackGroup, EmbarkToTransport, DisembarkFromTransport, CargoTransportation, goToWaypoint, groundEscort, RecoveryTanker

En-route Tasks: engageTargets, engageTargetsInZone, engageGroup, engageUnit, awacs, tanker, ewr, FAC_engageGroup, FAC

Commands: script, setCallsign, setFrequency, setFrequencyForUnit, switchWaypoint, stopRoute, switchAction, setInvisible, setImmortal, setUnlimitedFuel, activateBeacon, deactivateBeacon, activateICLS, deactivateICLS, eplrs, start, transmitMessage, stopTransmission, smoke_on_off, ActivateLink4, deactivateLink4, activateACLS, deactivateACLS, LoadingShip

Options: ROE, Reaction To Threat, Radar Using, Flare Using, Formation, RTB On Bingo, silence, Disperse on Attack, Alarm State, RTB on Out of Ammo, ECM Using, Prohibit AA, Prohibit Jettison, Prohibit Afterburner, Prohibit AG, Missile Attack Range, Prohibit WP Pass Report, Engage Air Weapons, Option Radio Usage Contact, Option Radio Usage Engage, Option Radio Usage Kill, AC Engagement Range Restriction, jett tanks if empty, forced attack, Altitude Restriction for AAA Min, restrict targets, Altitude Restriction for AAA Max, Prefer Vertical