commandRadio: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(description alt syntax format example)
m (Some wiki formatting)
 
(74 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|arg= global |= Arguments in MP
|version2= 1.50


|eff= local |= Effects in MP
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Sends the audio message to the command radio channel. Must have assigned "ItemRadio" to send or receive the transmission. The message is defined in CfgRadio in the [[description.ext]] file or config radio protocol. The transmission will play only on the PC where command was executed. If you need the transmission to play on all computers, you have to execute it globally (see [[remoteExec]]).
|game4= arma3
<br><br>Note:  When transmitting unit gets killed, transmission will be interrupted, however when receiving unit gets killed, the transmission continues to play. |= Description
|version4= 0.50
____________________________________________________________________________________________


| unit '''commandRadio''' radioName |= Syntax
|arg= global


|p1= unit: [[Object]] - unit to transmit |= PARAMETER1
|eff= local


|p2= radioName: [[String]] - class name from CfgRadio |= PARAMETER2
|gr1= Radio and Chat


|p3= |= PARAMETER3
|gr2= Sounds


| [[Nothing]] |= RETURNVALUE
|descr= Sends the audio message to the command radio channel. The message is defined in CfgRadio in the [[Description.ext|description.ext]] file or config radio protocol. The transmission will play only on the PC where command was executed. If you need the transmission to play on all computers, you have to execute it globally (see [[remoteExec]]).
{{Feature|important|
The unit must have an [[assignItem|assigned]] radio item (such as '''''"ItemRadio"''''') to see or transmit the messages.
A radio item must have the property <syntaxhighlight lang="cpp" inline>simulation = "ItemRadio";</syntaxhighlight> in its [[CfgWeapons_Config_Reference#simulation.3D.22Weapon.22|CfgWeapons config]].
}}
{{Feature|informative|When transmitting unit gets killed, transmission will be interrupted. However when receiving unit gets killed, the transmission continues to play.}}
 
|s1= unit [[commandRadio]] radioName
 
|p1= unit: [[Object]] - unit to transmit
 
|p2= radioName: [[String]] - class name from CfgRadio
 
|r1= [[Nothing]]
 
|s2= [side, identity] [[commandRadio]] radioName


|s2= [side, identity] '''commandRadio''' chatText |= Syntax
|p21= side: [[Side]] - side to which the transmission will be played


|p21= [side, identity]: [[Array]] |= Parameter 1
|p22= identity: [[String]] - class name of one of the identities in CfgHQIdentities. Possible identities in {{arma3}} are:
|p22= side: [[Side]] - side to which the transmission will be played |= Parameter 2
{{Columns|3|
|p23= identity: [[String]] - class name of one of the identities in CfgHQIdentities. Possible identities in Arma 3 are:
* "Base"
* "Base"
* "HQ"
* "HQ"
Line 36: Line 49:
* "OPF"
* "OPF"
* "IND"
* "IND"
* "IND_G" |= Parameter 3
* "IND_G"
|p24= radioName: [[String]] - class name from CfgRadio |= Parameter 4
}}
|r2= [[Nothing]] |= Return value
 
|p24= radioName: [[String]] - class name from CfgRadio
 
|r2= [[Nothing]]


|x1= <code>_soldierOne [[commandRadio]] "messageOne";</code>|= EXAMPLE1
|x1= <sqf>_soldierOne commandRadio "messageOne";</sqf>
|x2= <code>[[player]] [[commandRadio]] [[configName]] [[selectRandom]] ("true" [[configClasses]] ([[configFile]] >> "CfgRadio"));</code>|= EXAMPLE2
|x3= <code><nowiki>[</nowiki>[[west]], "Base"] [[commandRadio]] [[configName]] [[selectRandom]] ("true" [[configClasses]] ([[configFile]] >> "CfgRadio"));</code>|= EXAMPLE3


____________________________________________________________________________________________
|x2= <sqf>player commandRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));</sqf>


|[[sideRadio]], [[groupRadio]], [[customRadio]], [[vehicleRadio]], [[globalRadio]], [[directSay]], [[commandChat]]  |= SEEALSO
|x3= <sqf>[west, "Base"] commandRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));</sqf>


| |= MPBEHAVIOUR
|seealso= [[sideRadio]] [[groupRadio]] [[customRadio]] [[vehicleRadio]] [[globalRadio]] [[directSay]] [[commandChat]]
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Nikita320106
<!-- Note Section BEGIN -->
|timestamp= 20100624085500
<dd class="notedate">Posted on June 24, 2010 - 8:55 (CEST)
|text= ''example:''<sqf>_unit commandRadio "SentCmdHide";</sqf>
<dt class="note">[[User:Nikita320106|Nikita320106]] <dd class="note">''example:''<code> _unit commandRadio "SentCmdHide";</code>
radio command from CA_Dubbing config should work
radio command from CA_Dubbing config should work
}}


<!-- Note Section END -->
{{Note
</dl>
|user= Killzone_Kid
 
|timestamp= 20161203213300
<h3 style='display:none'>Bottom Section</h3>
|text= To transmit user custom sounds (see [[Multiplayer_Custom_Sounds_Tutorial]]), prefix the full filename including file extension with #.
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
For example if there is a custom user sound file called {{hl|MySound.ogg}}, to play it on the radio use:
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
<sqf>player commandRadio "#MySound.ogg";</sqf>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:34, 1 July 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Sends the audio message to the command radio channel. The message is defined in CfgRadio in the description.ext file or config radio protocol. The transmission will play only on the PC where command was executed. If you need the transmission to play on all computers, you have to execute it globally (see remoteExec).
⚠
The unit must have an assigned radio item (such as "ItemRadio") to see or transmit the messages. A radio item must have the property simulation = "ItemRadio"; in its CfgWeapons config.
ⓘ
When transmitting unit gets killed, transmission will be interrupted. However when receiving unit gets killed, the transmission continues to play.
Groups:
Radio and ChatSounds

Syntax

Syntax:
unit commandRadio radioName
Parameters:
unit: Object - unit to transmit
radioName: String - class name from CfgRadio
Return Value:
Nothing

Alternative Syntax

Syntax:
[side, identity] commandRadio radioName
Parameters:
side: Side - side to which the transmission will be played
identity: String - class name of one of the identities in CfgHQIdentities. Possible identities in Arma 3 are:
  • "Base"
  • "HQ"
  • "PAPA_BEAR"
  • "AirBase"
  • "BLU"
  • "OPF"
  • "IND"
  • "IND_G"
radioName: String - class name from CfgRadio
Return Value:
Nothing

Examples

Example 1:
_soldierOne commandRadio "messageOne";
Example 2:
player commandRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));
Example 3:
[west, "Base"] commandRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));

Additional Information

See also:
sideRadio groupRadio customRadio vehicleRadio globalRadio directSay commandChat

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Nikita320106 - c
Posted on Jun 24, 2010 - 08:55 (UTC)
example:
_unit commandRadio "SentCmdHide";
radio command from CA_Dubbing config should work
Killzone_Kid - c
Posted on Dec 03, 2016 - 21:33 (UTC)
To transmit user custom sounds (see Multiplayer_Custom_Sounds_Tutorial), prefix the full filename including file extension with #. For example if there is a custom user sound file called MySound.ogg, to play it on the radio use:
player commandRadio "#MySound.ogg";
Retrieved from "https://community.bistudio.com/wiki?title=commandRadio&oldid=325178"