Difference between revisions of "sideRadio"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
(39 intermediate revisions by 12 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#S|COMREF]]
+
{{Command|Comments=
 +
____________________________________________________________________________________________
  
<h2 style="color:#000066">'''sideRadio ''radioName'''''</h2>
+
| ofp |Game name=
  
'''Operand types:'''
+
|1.00|Game version=
  
'''radioName:''' [[String]]
+
|arg= global |Multiplayer Arguments=
  
'''Type of returned value:'''
+
|eff= local |Multiplayer Effects=
 +
____________________________________________________________________________________________
  
[[Nothing]]
+
| 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]]).
 +
<br><br>Note:  When transmitting unit gets killed, transmission will be interrupted, however when receiving unit gets killed, the transmission continues to play. |DESCRIPTION=
 +
____________________________________________________________________________________________
  
'''Description:'''
+
| unit '''sideRadio''' radioName |SYNTAX=
  
Send message to side radio channel.
+
|p1= unit: [[Object]] - unit to transmit |PARAMETER1=
  
Message is defined in [[description.ext]] file.
+
|p2= radioName: [[String]] - class name from CfgRadio |PARAMETER2=
  
 +
|p3= |PARAMETER3=
  
'''Example:'''
+
| [[Nothing]] |RETURNVALUE=
  
soldierOne '''sideRadio''' "messageOne"
+
|s2= [side, identity] '''sideRadio''' radioName |SYNTAX2=
 +
 
 +
|p21= [side, identity]: [[Array]] |PARAMETER21=
 +
|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:
 +
* "Base"
 +
* "HQ"
 +
* "PAPA_BEAR"
 +
* "AirBase"
 +
* "BLU"
 +
* "OPF"
 +
* "IND"
 +
* "IND_G" |PARAMETER23=
 +
 
 +
|p24= radioName: [[String]] - class name from CfgRadio |PARAMETER4=
 +
|r2=  [[Nothing]] |RETURNVALUE=
 +
____________________________________________________________________________________________
 +
 
 +
|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=
 +
 
 +
}}
 +
 
 +
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
<dd class="notedate">Posted on 03:47, 12 February 2007
 +
<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>
 +
[[Category:Scripting Commands|SIDERADIO]]
 +
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|SIDERADIO]]
 +
[[Category:Scripting Commands OFP 1.46|SIDERADIO]]
 +
[[Category:Scripting Commands ArmA|SIDERADIO]]
 +
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Radio_Control|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 +
 
 +
<!-- 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 22:39, 6 April 2020

Introduced with Operation Flashpoint version 1.001.00
Arguments of this scripting command don't have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
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).

Note: When transmitting unit gets killed, transmission will be interrupted, however when receiving unit gets killed, the transmission continues to play.

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, identity]: Array
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:
sideChatgroupRadiocustomRadiovehicleRadioglobalRadiodirectSaycommandRadio

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Posted on 03:47, 12 February 2007
Ceeeb
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".

Bottom Section

Posted on December 3, 2016 - 21:32 (UTC)
Killzone Kid
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";