radioChannelCreate: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>") |
Lou Montana (talk | contribs) (Fix Category:Pages using duplicate arguments in template calls and add category) |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| Line 8: | Line 6: | ||
|1.00|Game version= | |1.00|Game version= | ||
|serverExec= server |Exec= | |serverExec= server |Exec= | ||
|arg= global|Multiplayer Arguments= | |arg= global|Multiplayer Arguments= | ||
|eff= global|Multiplayer Effects= | |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 | | 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. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[radioChannelCreate]] [color, label, callSign, units, sentenceType] |SYNTAX= | ||
|p1= | |||
|p2= | |p1= color: [[Array]] - RGBA color values |PARAMETER1= | ||
|p2= label: [[String]] - label |PARAMETER2= | |||
|p3= callSign: [[String]] - call sign |PARAMETER3= | |||
|p4= units: [[Array]] - list of units in the channel |PARAMETER4= | |||
|p4 | |||
|p5= sentenceType (Optional): [[Boolean]] (Default: [[true]]) | |||
| | |||
* [[true]] - use ''Protocol'' message color from <tt>[[getArray]] ([[configFile]] >> "RscChatListDefault" >> "colorMessageProtocol")</tt> | * [[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= | * [[false]] - use ''Normal'' message color from <tt>[[getArray]] ([[configFile]] >> "RscChatListDefault" >> "colorMessage")</tt> |PARAMETER5= | ||
|x1= <code>_index = | | [[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 = | |x2= <code>_index = [[radioChannelCreate]] <nowiki>[[0.96, 0.34, 0.13, 0.8], "Q-dance Radio", "%UNIT_NAME", [player1, player2],</nowiki> [[false]]<nowiki>];</nowiki> | ||
{{cc|disable automatic quotes for chat in channel ({{arma3}})}}</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 39: | Line 44: | ||
[[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/>[[player]]]}] [[remoteExec]] ["call", [0, -2] [[select]] [[isDedicated]], _channelName]; | [_channelID, {_this [[radioChannelAdd]] [<nowiki/>[[player]]]}] [[remoteExec]] ["call", [0, -2] [[select]] [[isDedicated]], _channelName]; | ||
};</code> |= | };</code> |EXAMPLE3= | ||
| [[radioChannelAdd]], [[radioChannelRemove]], [[radioChannelSetCallSign]], [[radioChannelSetLabel]], [[customChat]], [[customRadio]], [[setCurrentChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[getPlayerChannel]] |SEEALSO= | | [[radioChannelAdd]], [[radioChannelRemove]], [[radioChannelSetCallSign]], [[radioChannelSetLabel]], [[customChat]], [[customRadio]], [[setCurrentChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[getPlayerChannel]] |SEEALSO= | ||
}} | }} | ||
| Line 49: | Line 52: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<dd class="notedate">Posted on January 21, 2016 - 13:30 (UTC)</dd> | <dd class="notedate">Posted on January 21, 2016 - 13:30 (UTC)</dd> | ||
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | <dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt> | ||
| Line 66: | Line 57: | ||
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> | </dd> | ||
<dd class="notedate">Posted on October 12, 2017 - 12:27 (UTC)</dd> | <dd class="notedate">Posted on October 12, 2017 - 12:27 (UTC)</dd> | ||
<dt class="note">[[User:Demellion|Demellion]]</dt> | <dt class="note">[[User:Demellion|Demellion]]</dt> | ||
| Line 77: | Line 64: | ||
Behaviour is yet unknown for me. | Behaviour is yet unknown for me. | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
< | |||
<h3 style="display:none">Bottom Section</h3> | |||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Command Group: Radio Control]] | |||
Revision as of 18:04, 16 August 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.
- Groups:
- Uncategorised
Syntax
- Syntax:
- radioChannelCreate [color, label, callSign, units, sentenceType]
- Parameters:
- 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
- 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.