sideRadio: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Some wiki formatting)
(48 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|eff= local |Multiplayer Effects=
|game4= arma2
|version4= 1.00


|gr1= Radio and Chat |GROUP1=
|game5= arma2oa
|version5= 1.50


|gr2= Sounds |GROUP2=
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00


| Sends the audio message to the side 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]]).
|game7= 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=
|version7= 0.50
____________________________________________________________________________________________


| unit '''sideRadio''' 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 side 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.}}


|s2= [side, identity] '''sideRadio''' radioName |SYNTAX2=
|s1= unit [[sideRadio]] radioName


|p21= [side, identity]: [[Array]] |PARAMETER21=
|p1= unit: [[Object]] - unit to transmit
|p22= side: [[Side]] - side to which the transmission will be played |PARAMETER22=
 
|p23= identity: [[String]] - class name of one of the identities in CfgHQIdentities. Possible identities in Arma 3 are:
|p2= radioName: [[String]] - class name from {{hl|CfgRadio}}
 
|r1= [[Nothing]]
 
|s2= [side, identity] [[sideRadio]] radioName
 
|p21= side: [[Side]] - side to which the transmission will be played
 
|p22= identity: [[String]] - class name of one of the identities in CfgHQIdentities. Possible identities in {{arma3}} are:
{{Columns|4|
* "Base"
* "Base"
* "HQ"
* "HQ"
Line 41: Line 55:
* "OPF"
* "OPF"
* "IND"
* "IND"
* "IND_G" |PARAMETER23=
* "IND_G"
}}
 
|p24= radioName: [[String]] - class name from {{hl|CfgRadio}}
 
|r2= [[Nothing]]
 
|x1= <sqf>_soldierOne sideRadio "messageOne";</sqf>


|p24= radioName: [[String]] - class name from CfgRadio |PARAMETER4=
|x2= <sqf>player sideRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));</sqf>
|r2=  [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________
 
|x1= <code>_soldierOne [[sideRadio]] "messageOne";</code> |EXAMPLE1=
|x2= <code>[[player]] [[sideRadio]] [[configName]] [[selectRandom]] ("true" [[configClasses]] ([[configFile]] >> "CfgRadio"));</code> |EXAMPLE2=
|x3= <code><nowiki>[</nowiki>[[west]], "Base"] [[sideRadio]] [[configName]] [[selectRandom]] ("true" [[configClasses]] ([[configFile]] >> "CfgRadio"));</code>|EXAMPLE3=
____________________________________________________________________________________________


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


|seealso= [[sideChat]] [[groupRadio]] [[customRadio]] [[vehicleRadio]] [[globalRadio]] [[directSay]] [[commandRadio]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Ceeeb
<!-- Note Section BEGIN -->
|timestamp= 20070212034700
<dd class="notedate">Posted on 03:47, 12 February 2007
|text= In '''OFP v1.96''', sideRadio messages can be sent from 2 abstract sources: "Papa_Bear" and "Base FireFly". Use sideRadio on an array in the form [SIDE,"base"],[SIDE,"HQ"],[SIDE,"Papa_bear"] or [SIDE,"airbase"], where SIDE is the [[side]] broadcasting. "HQ", "base" and "Papa_bear" seem to be the same object. The callsign strings can be re-defined using a stringTable.csv file, using STR_CFG_PAPABEAR and STR_CFG_FIREFLYBASE.  ''Example : [EAST,"base"] sideRadio "returnToBase"''.  
<dt class="note">[[User:Ceeeb|Ceeeb]]
}}
<dd class="note">
In '''OFP v1.96''', sideRadio messages can be sent from 2 abstract sources: "Papa_Bear" and "Base FireFly". Use sideRadio on an array in the form [SIDE,"base"],[SIDE,"HQ"],[SIDE,"Papa_bear"] or [SIDE,"airbase"], where SIDE is the [[side]] broadcasting. "HQ", "base" and "Papa_bear" seem to be the same object. The callsign strings can be re-defined using a stringTable.csv file, using STR_CFG_PAPABEAR and STR_CFG_FIREFLYBASE.  ''Example : [EAST,"base"] sideRadio "returnToBase"''.  
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|SIDERADIO]]
|user= Killzone_Kid
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
|timestamp= 20161203213200
[[Category:Scripting Commands OFP 1.96|SIDERADIO]]
|text= 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 {{hl|MySound.ogg}}, to play it on the radio use:
[[Category:Scripting Commands OFP 1.46|SIDERADIO]]
<sqf>player sideRadio "#MySound.ogg";</sqf>  
{{GameCategory|arma1|Scripting Commands}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 3, 2016 - 21:32 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
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 <tt>MySound.ogg</tt>, to play it on the radio use:
<code>[[player]] [[sideRadio]] "#MySound.ogg";</code>  
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 17:29, 25 July 2022

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo 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 side 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 sideRadio radioName
Parameters:
unit: Object - unit to transmit
radioName: String - class name from CfgRadio
Return Value:
Nothing

Alternative Syntax

Syntax:
[side, identity] sideRadio 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 sideRadio "messageOne";
Example 2:
player sideRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));
Example 3:
[west, "Base"] sideRadio configName selectRandom ("true" configClasses (configFile >> "CfgRadio"));

Additional Information

See also:
sideChat groupRadio customRadio vehicleRadio globalRadio directSay commandRadio

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
Ceeeb - c
Posted on Feb 12, 2007 - 03:47 (UTC)
In OFP v1.96, sideRadio messages can be sent from 2 abstract sources: "Papa_Bear" and "Base FireFly". Use sideRadio on an array in the form [SIDE,"base"],[SIDE,"HQ"],[SIDE,"Papa_bear"] or [SIDE,"airbase"], where SIDE is the side broadcasting. "HQ", "base" and "Papa_bear" seem to be the same object. The callsign strings can be re-defined using a stringTable.csv file, using STR_CFG_PAPABEAR and STR_CFG_FIREFLYBASE. Example : [EAST,"base"] sideRadio "returnToBase".
Killzone_Kid - c
Posted on Dec 03, 2016 - 21:32 (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 sideRadio "#MySound.ogg";
Retrieved from "https://community.bistudio.com/wiki?title=sideRadio&oldid=329184"