customRadio: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Feature | Important | " to "{{Feature|important|")
 
(53 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 0.50


|0.50|= Game version
|arg= global


|arg= global |= Arguments in MP
|eff= local


|eff= local |= Effects in MP
|gr1= Radio and Chat
____________________________________________________________________________________________


| Sends the message to the custom radio channel. The message is defined in the [[description.ext]] file or radio protocol.  |= Description
|gr2= Sounds
____________________________________________________________________________________________


| unit '''customRadio''' [channel, message] |= Syntax
|gr3= Custom Radio and Chat


|p1= unit: [[Object]] |= PARAMETER1
|descr= Sends the message to the custom radio channel. The message is defined in the [[Description.ext|description.ext]] file or radio protocol.


|p2= [channel, message]: [[Array]] |= PARAMETER2
{{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.}}


|p3= channel: [[Number]] - custom radio channel id returned by [[radioChannelCreate]] command |= PARAMETER3
|s1= unit [[customRadio]] [customChannelID, message]


|p4= message: [[String]] |= PARAMETER4
|p1= unit: [[Object]]


| [[Nothing]] |= RETURNVALUE
|p2= customChannelID: [[Number]] - [[Channel IDs|custom channel ID]] returned by [[radioChannelCreate]] command


|p3= message: [[String]]


|x1= <code>_soldierOne [[customRadio]] [1, "WordEnemy"];</code>|= EXAMPLE1
|r1= [[Nothing]]


____________________________________________________________________________________________
|x1= <sqf>_soldierOne customRadio [1, "WordEnemy"];</sqf>


| [[radioChannelCreate]], [[customChat]], [[sideRadio]], [[groupRadio]], [[vehicleRadio]], [[globalRadio]], [[directSay]] |= SEEALSO
|seealso= [[radioChannelCreate]] [[customChat]] [[sideRadio]] [[groupRadio]] [[vehicleRadio]] [[globalRadio]] [[directSay]]
}}


| |= MPBEHAVIOUR
{{Note
____________________________________________________________________________________________
|user= Killzone_Kid
|timestamp= 20161203213500
|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:
<sqf>player customRadio [1, "#MySound.ogg"];</sqf>
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on December 3, 2016 - 21:35 (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]] [[customRadio]] [1, "#MySound.ogg"];</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 21:46, 16 May 2024

Hover & click on the images for description

Description

Description:
Sends the message to the custom radio channel. The message is defined in the description.ext file or radio protocol.
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 ChatSoundsCustom Radio and Chat

Syntax

Syntax:
unit customRadio [customChannelID, message]
Parameters:
unit: Object
customChannelID: Number - custom channel ID returned by radioChannelCreate command
message: String
Return Value:
Nothing

Examples

Example 1:
_soldierOne customRadio [1, "WordEnemy"];

Additional Information

See also:
radioChannelCreate customChat sideRadio groupRadio vehicleRadio globalRadio directSay

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
Killzone_Kid - c
Posted on Dec 03, 2016 - 21:35 (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 customRadio [1, "#MySound.ogg"];