setCurrentChannel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 53: Line 53:
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''setCurrentChannel''' channelID |SYNTAX=
| '''setCurrentChannel''' id |SYNTAX=


|p1= channelID: [[Number]] - [[Channel IDs|channelID]] |PARAMETER1=
|p1= id: [[Number]] - [[Channel IDs|channelID]] |PARAMETER1=


| [[Boolean]] |RETURNVALUE=
| [[Boolean]] |RETURNVALUE=

Revision as of 09:19, 29 October 2020

-wrong parameter ("a3") defined!-[[:Category:Introduced with a3 version 1.42|1.42]]
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
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
For Custom Radio (see radioChannelCreate)
Groups:
Radio and Chat

Syntax

Syntax:
setCurrentChannel id
Parameters:
id: Number - channelID
Return Value:
Boolean

Examples

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

Additional Information

See also:
getPlayerChannelcurrentChannelenableChannelchannelEnabledradioChannelCreate

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.