radioChannelCreate: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Lou Montana (talk | contribs) m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>") |
||
(13 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Scripting Commands]] | [[Category:Scripting Commands]] | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| TKOH | | | TKOH |Game name= | ||
|1.00| | |1.00|Game version= | ||
| | |serverExec= server |Exec= | ||
|arg= global|= | |arg= global|Multiplayer Arguments= | ||
|eff= global|= | |eff= global|Multiplayer Effects= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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. 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. '''Server only'''. |= | | 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. 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. '''Server only'''. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''radioChannelCreate''' [color, label, callSign, units, sentenceType] |= | | '''radioChannelCreate''' [color, label, callSign, units, sentenceType] |SYNTAX= | ||
|p1= [color, label, callSign, units, sentenceType]: [[Array]] | |p1= [color, label, callSign, units, sentenceType]: [[Array]] | ||
|p2= color: [[Array]] - RGBA color values |= | |p2= color: [[Array]] - RGBA color values |PARAMETER2= | ||
|x1= <code>_index = '''radioChannelCreate''' [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2]];</code> |= | |p3= label: [[String]] - label |PARAMETER2= | ||
|p4= callSign: [[String]] - call sign |PARAMETER3= | |||
|p5= units: [[Array]] - list of units in the channel |PARAMETER4= | |||
|p6= sentenceType (Optional): [[Boolean]] (Default: [[true]]) | |||
* [[true]] - use ''Protocol'' message color from <tt>[[getArray]] ([[configFile]] >> "RscChatListDefault" >> "colorMessageProtocol")</tt> | |||
* [[false]] - use ''Normal'' message color from <tt>[[getArray]] ([[configFile]] >> "RscChatListDefault" >> "colorMessage")</tt> |PARAMETER5= | |||
| [[Number]] - created channel ID (used in [[customChat]] command), 0 if failed |RETURNVALUE= | |||
|x1= <code>_index = '''radioChannelCreate''' [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2]];</code> |Example1= | |||
|x2= <code>_index = '''radioChannelCreate''' <nowiki>[[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2],</nowiki> [[false]]<nowiki>];</nowiki> | |x2= <code>_index = '''radioChannelCreate''' <nowiki>[[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2],</nowiki> [[false]]<nowiki>];</nowiki> | ||
// disable automatic quotes for chat in channel ( | // disable automatic quotes for chat in channel (Arma 3)</code> |Example2= | ||
|x3= Create custom channel and add all players to it, present and JIP:<code>[[if]] ([[isServer]]) [[then]] | |x3= Create custom channel and add all players to it, present and JIP:<code>[[if]] ([[isServer]]) [[then]] | ||
Line 35: | Line 38: | ||
[[private]] _channelID = [[radioChannelCreate]] [[0.96, 0.34, 0.13, 0.8], _channelName, "%UNIT_NAME", []]; | [[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]}; | [[if]] (_channelID == 0) [[exitWith]] {[[diag_log]] [[format]] ["Custom channel '%1' creation failed!", _channelName]}; | ||
[_channelID, {_this [[radioChannelAdd]] <nowiki | [_channelID, {_this [[radioChannelAdd]] [<nowiki/>[[player]]]}] [[remoteExec]] ["call", [0, -2] [[select]] [[isDedicated]], _channelName]; | ||
};</code> |= | };</code> |= | ||
|mp= Execute on the server |= | |mp= Execute on the server |= | ||
| [[radioChannelAdd]], [[radioChannelRemove]], [[radioChannelSetCallSign]], [[radioChannelSetLabel]], [[customChat]], [[customRadio]], [[setCurrentChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[getPlayerChannel]] |= | | [[radioChannelAdd]], [[radioChannelRemove]], [[radioChannelSetCallSign]], [[radioChannelSetLabel]], [[customChat]], [[customRadio]], [[setCurrentChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[getPlayerChannel]] |SEEALSO= | ||
}} | }} | ||
Line 62: | Line 65: | ||
<dd class="note"> | <dd class="note"> | ||
Make sure you add all units you intend to speak or receive messages on created custom channel to the channel. | Make sure you add all units you intend to speak or receive messages on created custom channel to the channel. | ||
</dd> | |||
</dl> | |||
<!-- DISCONTINUE Notes --> | |||
<!-- CONTINUE Notes --> | |||
<dl class="command_description"> | |||
<dd class="notedate">Posted on October 12, 2017 - 12:27 (UTC)</dd> | |||
<dt class="note">[[User:Demellion|Demellion]]</dt> | |||
<dd class="note"> | |||
'''WARNING''': Be aware that created channels order and count are different between server and client. '''Example 3''' shown that server-side channel ID is actually ''4'', while client [[currentChannel]] on the same channel results in ''9''. | |||
Behaviour is yet unknown for me. | |||
</dd> | </dd> | ||
</dl> | </dl> | ||
<!-- DISCONTINUE Notes --> | <!-- DISCONTINUE Notes --> |
Revision as of 11:28, 19 March 2020
Description
- Description:
- 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. 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. Server only.
- Multiplayer:
- Execute on the server
- Groups:
- Uncategorised
Syntax
- Syntax:
- radioChannelCreate [color, label, callSign, units, sentenceType]
- Parameters:
- [color, label, callSign, units, sentenceType]: Array
- color: Array - RGBA color values
- label: String - label
- callSign: String - call sign
- units: Array - list of units in the channel
- sentenceType (Optional): Boolean (Default: true)
- true - use Protocol message color from getArray (configFile >> "RscChatListDefault" >> "colorMessageProtocol")
- false - use Normal message color from getArray (configFile >> "RscChatListDefault" >> "colorMessage")
- Return Value:
- Number - created channel ID (used in customChat command), 0 if failed
Examples
- Example 1:
_index = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2]];
- Example 2:
_index = radioChannelCreate [[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2], false]; // disable 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:
- radioChannelAddradioChannelRemoveradioChannelSetCallSignradioChannelSetLabelcustomChatcustomRadiosetCurrentChannelcurrentChannelenableChannelchannelEnabledgetPlayerChannel
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
Notes
Bottom Section
- Posted on January 21, 2016 - 13:30 (UTC)
- Killzone Kid
- Make sure you add all units you intend to speak or receive messages on created custom channel to the channel.
- Posted on October 12, 2017 - 12:27 (UTC)
- Demellion
- WARNING: Be aware that created channels order and count are different between server and client. Example 3 shown that server-side channel ID is actually 4, while client currentChannel on the same channel results in 9. Behaviour is yet unknown for me.
Categories:
- Scripting Commands
- Introduced with Take On Helicopters version 1.00
- Take On Helicopters: New Scripting Commands
- Take On Helicopters: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands: Global Effect
- Scripting Commands: Server Execution
- Scripting Commands Take On Helicopters
- Take On Helicopters: New Scripting Commands List
- Arma 3: New Scripting Commands List
- Scripting Commands Arma 3