setCurrentChannel: Difference between revisions

Latest revision as of 13:15, 1 October 2024

Hover & click on the images for description

Description

Description:

Sets given channel as current chat channel. Scripted way of selecting desired channel on the UI. The given channel may be disabled (see enableChannel), this is why this command returns boolean, true on success or false on failure.

Channel ID number correspondence
Default Channels						Custom Channels
Global	Side	Command	Group	Vehicle	Direct	CC 1	CC 2	CC 3	CC 4	CC 5	CC 6	CC 7	CC 8	CC 9	CC 10
0	1	2	3	4	5	6	7	8	9	10	11	12	13	14	15

Groups:

Radio and Chat

Syntax

Syntax:: setCurrentChannel channelID
Parameters:: channelID: Number - channel ID
Return Value:: Boolean - true on success

Examples

Example 1:: _isDirectSelected = setCurrentChannel 5; // sets Direct channel as current active

Additional Information

See also:: getPlayerChannel currentChannel enableChannel channelEnabled radioChannelCreate

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-______________________________________________________________________________________________
-| a3 |= Game name
+|game1= arma3
+|version1= 1.42
-|1.42|= Game version
+|eff= local
-|eff= local |Multiplayer Arguments=
+|gr1= Radio and Chat
-__________________________________________________________________________________________
-| Sets given channel as current chat channel. Scripted way of selecting desired channel on the UI. The given channel may be disabled (see [[enableChannel]]), this is why this command returns boolean, [[true]] on success or [[false]] on failure. Correspondence between channel and number:
+|descr= Sets given channel as current chat channel. Scripted way of selecting desired channel on the UI.
-* 0 <nowiki>=</nowiki> Global
+The given channel may be disabled (see [[enableChannel]]), this is why this command returns boolean, [[true]] on success or [[false]] on failure.
-* 1 <nowiki>=</nowiki> Side
+{{{!}} class="wikitable align-center"
-* 2 <nowiki>=</nowiki> Command
+! colspan="16" {{!}} [[Channel IDs|Channel ID]] number correspondence
-* 3 <nowiki>=</nowiki> Group
+{{!}}-
-* 4 <nowiki>=</nowiki> Vehicle
+! colspan="6" {{!}} Default Channels
-* 5 <nowiki>=</nowiki> Direct
+! colspan="10" {{!}} Custom Channels
-* 6-15 <nowiki>=</nowiki> Custom Radio (see [[radioChannelCreate]])
+{{!}}- style="font-size: .9em"
-|DESCRIPTION=
+{{!}} Global
-____________________________________________________________________________________________
+{{!}} Side
+{{!}} Command
+{{!}} Group
+{{!}} Vehicle
+{{!}} Direct
+{{!}} CC&nbsp;1
+{{!}} CC&nbsp;2
+{{!}} CC&nbsp;3
+{{!}} CC&nbsp;4
+{{!}} CC&nbsp;5
+{{!}} CC&nbsp;6
+{{!}} CC&nbsp;7
+{{!}} CC&nbsp;8
+{{!}} CC&nbsp;9
+{{!}} CC&nbsp;10
+{{!}}-
+{{!}} 0
+{{!}} 1
+{{!}} 2
+{{!}} 3
+{{!}} 4
+{{!}} 5
+{{!}} 6
+{{!}} 7
+{{!}} 8
+{{!}} 9
+{{!}} 10
+{{!}} 11
+{{!}} 12
+{{!}} 13
+{{!}} 14
+{{!}} 15
+{{!}}}
-| '''setCurrentChannel''' channel |SYNTAX=
+|s1= [[setCurrentChannel]] channelID
-|p1= channel: [[Number]] |PARAMETER1=
+|p1= channelID: [[Number]] - [[Channel IDs|channel ID]]
-| [[Boolean]] |RETURNVALUE=
+|r1= [[Boolean]] - [[true]] on success
-____________________________________________________________________________________________
-|x1= <code>_isDirectSelected = [[setCurrentChannel]] 5; // sets Direct channel as current active</code> |EXAMPLE1=
-____________________________________________________________________________________________
-|[[getPlayerChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[radioChannelCreate]]|SEEALSO=
+|x1= <sqf>_isDirectSelected = setCurrentChannel 5; // sets Direct channel as current active</sqf>
+|seealso= [[getPlayerChannel]] [[currentChannel]] [[enableChannel]] [[channelEnabled]] [[radioChannelCreate]]
 }}
-<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:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Radio_Control|{{uc:{{PAGENAME}}}}]]
-<!-- CONTINUE Notes -->
-<dl class="command_description">
-<dd class="notedate">Posted on December 9, 2015 - 16:45 (UTC)</dd>
-<dt class="note">[[User:Commy2|Commy2]]</dt>
-<dd class="note">
-This command can be used together with custom radio channels, but an offset of 5 must be added to the index from radioChannelCreate.
-<code>_index = [[radioChannelCreate]] [[1, 0, 0, 1], "Custom Channel 1", "%UNIT_NAME", [player]];
-[[setCurrentChannel]] (_index + 5);
-</code>
-</dd>
-</dl>
-<!-- DISCONTINUE Notes -->