setCurrentChannel: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| a3 |Game name= | | a3 |Game name= | ||
| Line 9: | Line 8: | ||
|gr1= Radio and Chat |GROUP1= | |gr1= Radio and Chat |GROUP1= | ||
| 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. | | 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. | ||
| Line 51: | Line 49: | ||
For Custom Radio (see [[radioChannelCreate]]) | For Custom Radio (see [[radioChannelCreate]]) | ||
|DESCRIPTION= | |DESCRIPTION= | ||
| '''setCurrentChannel''' channelID |SYNTAX= | | '''setCurrentChannel''' channelID |SYNTAX= | ||
| Line 58: | Line 55: | ||
| [[Boolean]] - [[true]] on success |RETURNVALUE= | | [[Boolean]] - [[true]] on success |RETURNVALUE= | ||
|x1= <code>_isDirectSelected = [[setCurrentChannel]] 5; // sets Direct channel as current active</code> |EXAMPLE1= | |x1= <code>_isDirectSelected = [[setCurrentChannel]] 5; // sets Direct channel as current active</code> |EXAMPLE1= | ||
|[[getPlayerChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[radioChannelCreate]]|SEEALSO= | |[[getPlayerChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[radioChannelCreate]]|SEEALSO= | ||
Revision as of 02:28, 17 January 2021
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.
For Custom Radio (see radioChannelCreate)channel ID number correspondence Global Side Command Group Vehicle Direct Custom1 Custom2 Custom3 Custom4 Custom5 Custom6 Custom7 Custom8 Custom9 Custom10 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
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
[[Category:Introduced with a3 version 1.42]][[ Category: a3: New Scripting Commands | SETCURRENTCHANNEL]][[ Category: a3: Scripting Commands | SETCURRENTCHANNEL]]
Notes
Bottom Section
- Posted on December 9, 2015 - 16:45 (UTC)
- Commy2
-
This command can be used together with custom radio channels, but an offset of 5 must be added to the index from radioChannelCreate.
_index = radioChannelCreate [[1, 0, 0, 1], "Custom Channel 1", "%UNIT_NAME", [player]]; setCurrentChannel (_index + 5);
- Posted on October 29, 2020 - 07:49 (UTC)
- R3vo
- In order to complement commy2's note. See Channel IDs.