radioChannelCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
 
(80 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command


{{Command|= Comments
|game1= tkoh
|version1= 1.00


____________________________________________________________________________________________
|game2= arma3
|version2= 0.50


| TKOH |= Game name
|serverExec= server


|1.00|= Game version
|arg= global
|exec= server|= Exec
|arg= global|= Arguments in MP
|eff= global|= Effects in MP
____________________________________________________________________________________________


| Create a custom radio channel with the given color, label, call sign and registered characters. The index returned can be used to manipulate the created channel later.
|eff= global


There are 10 slots for custom radio channels. The command will find an unused index in this range and create it when found. |= Description
|gr1= Radio and Chat
____________________________________________________________________________________________


| '''radioChannelCreate''' [color, label, callSign, units]|= Syntax
|gr2= Custom Radio and Chat


|p1= color: [[Array]] - RGBA color values |= Parameter 1
|descr= Create a custom radio channel with the given color, label, call sign and registered characters.
|p2= label: [[String]] - label |= Parameter 2
The '''[[Channel IDs|custom channel ID]]''' returned can be used to manipulate the created channel later.
|p3= callSign: [[String]] - call sign |= Parameter 3
There are 10 slots for custom radio channels which would correspond to channels 6-15 (see [[getPlayerChannel]]).
|p4= units: [[Array]] - list of units in the channel |= Parameter 4
The command will find an unused index in this range and create it when found.


| [[Number]] |= Return value
|s1= [[radioChannelCreate]] [color, label, callSign, units, sentenceType]
____________________________________________________________________________________________


| s2= '''radioChannelCreate''' [color, label, callSign, characters, sentenceType] |= Syntax
|p1= color: [[Array]] - [[Color|RGBA color]] values
|p21= color: [[Array]] - RGBA color values |= Parameter 1
|p22= label: [[String]] - label |= Parameter 2
|p23= callSign: [[String]] - call sign |= Parameter 3
|p24= characters: [[Array]] - list of units in the channel |= Parameter 4
|p25= sentenceType: [[Boolean]] - enable putting all chat messages in quotations (default: true) |= Parameter 5
| r2= [[Number]] |= Return value


|x1= <code>_index = '''radioChannelCreate''' [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player]];</code> |=
|p2= label: [[String]] - label


|mp= Execute on the server |=
|p3= callSign: [[String]] - call sign - see [[radioChannelSetCallSign]]
| [[radioChannelAdd]], [[radioChannelRemove]], [[radioChannelSetCallSign]], [[radioChannelSetLabel]], [[customChat]], [[customRadio]] |= See also


}}
|p4= units: [[Array]] - list of units in the channel
 
|p5= sentenceType: [[Boolean]] - (Optional, default [[true]])
* [[true]] - use ''Protocol'' message color from <sqf inline>getArray (configFile >> "RscChatListDefault" >> "colorMessageProtocol")</sqf>
* [[false]] - use ''Normal'' message color from <sqf inline>getArray (configFile >> "RscChatListDefault" >> "colorMessage")</sqf>
 
|r1= [[Number]] - created '''[[Channel IDs|custom channel ID]]''' (used in [[customChat]] command), 0 if failed
 
|x1= <sqf>_channelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2]];</sqf>
 
|x2= <sqf>
_channelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2], true];
// using true also disables automatic quotes for chat in channel (Arma 3)
</sqf>


<h3 style="display:none">Notes</h3>
|x3= Create custom channel and add all players to it, present and JIP:
<dl class="command_description">
<sqf>if (isServer) then
<!-- Note Section BEGIN -->
{
private _channelName = "Q-dance Radio";
private _channelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], _channelName, "%UNIT_NAME", []];
if (_channelID == 0) exitWith {diag_log format ["Custom channel '%1' creation failed!", _channelName]};
[_channelID, {_this radioChannelAdd [player]}] remoteExec ["call", [0, -2] select isDedicated, _channelName];
};
</sqf>


<!-- Note Section END -->
|seealso= [[radioChannelAdd]] [[radioChannelRemove]] [[radioChannelSetCallSign]] [[radioChannelSetLabel]] [[customChat]] [[customRadio]] [[setCurrentChannel]] [[currentChannel]] [[enableChannel]] [[channelEnabled]] [[getPlayerChannel]] [[radioChannelInfo]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
|user= Killzone_Kid
[[Category:Take On Helicopters: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|timestamp= 20160121133000
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
|text= Make sure you add all units you intend to speak or receive messages on created custom channel to the channel.
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
}}


{{subst:Add new note/construct|
{{Note
Alternate syntax example:
|user= Hypoxic125
<code>_index = '''radioChannelCreate''' [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player], false];
|timestamp= 20221101063808
// disable automatic quotes for chat in channel (ArmA 3)</code>
|text= Units are removed from the chat channel on RESPAWN. Be sure to add units back to their custom chat channels upon respawn via [[Event_Scripts#onPlayerRespawn.sqf|onPlayerRespawn.sqf]] or [[Arma_3:_Event_Handlers#Respawn|Respawn Event Handler]].
}}
}}

Latest revision as of 01:42, 12 March 2024

Hover & click on the images for description

Description

Description:
Create a custom radio channel with the given color, label, call sign and registered characters. The custom channel ID returned can be used to manipulate the created channel later. There are 10 slots for custom radio channels which would correspond to channels 6-15 (see getPlayerChannel). The command will find an unused index in this range and create it when found.
Groups:
Radio and ChatCustom Radio and Chat

Syntax

Syntax:
radioChannelCreate [color, label, callSign, units, sentenceType]
Parameters:
color: Array - RGBA color values
label: String - label
callSign: String - call sign - see radioChannelSetCallSign
units: Array - list of units in the channel
sentenceType: Boolean - (Optional, default true)
Return Value:
Number - created custom channel ID (used in customChat command), 0 if failed

Examples

Example 1:
_channelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2]];
Example 2:
_channelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2], true]; // using true also disables automatic quotes for chat in channel (Arma 3)
Example 3:
Create custom channel and add all players to it, present and JIP:
if (isServer) then { private _channelName = "Q-dance Radio"; private _channelID = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], _channelName, "%UNIT_NAME", []]; if (_channelID == 0) exitWith {diag_log format ["Custom channel '%1' creation failed!", _channelName]}; [_channelID, {_this radioChannelAdd [player]}] remoteExec ["call", [0, -2] select isDedicated, _channelName]; };

Additional Information

See also:
radioChannelAdd radioChannelRemove radioChannelSetCallSign radioChannelSetLabel customChat customRadio setCurrentChannel currentChannel enableChannel channelEnabled getPlayerChannel radioChannelInfo

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 Jan 21, 2016 - 13:30 (UTC)
Make sure you add all units you intend to speak or receive messages on created custom channel to the channel.
Hypoxic125 - c
Posted on Nov 01, 2022 - 06:38 (UTC)
Units are removed from the chat channel on RESPAWN. Be sure to add units back to their custom chat channels upon respawn via onPlayerRespawn.sqf or Respawn Event Handler.