setCurrentChannel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (format)
m (template:command argument fix)
Line 17: Line 17:
* 5 <nowiki>=</nowiki> Direct
* 5 <nowiki>=</nowiki> Direct
* 6-15 <nowiki>=</nowiki> Custom Radio (see [[radioChannelCreate]])
* 6-15 <nowiki>=</nowiki> Custom Radio (see [[radioChannelCreate]])
|= Description
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''setCurrentChannel''' channel |= Syntax
| '''setCurrentChannel''' channel |SYNTAX=


|p1= channel: [[Number]] |= Parameter 1
|p1= channel: [[Number]] |PARAMETER1=


| [[Boolean]] |= Return value
| [[Boolean]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_isDirectSelected = [[setCurrentChannel]] 5; // sets Direct channel as current active</code> |= Example 1
|x1= <code>_isDirectSelected = [[setCurrentChannel]] 5; // sets Direct channel as current active</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


|[[getPlayerChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[radioChannelCreate]]|= See also
|[[getPlayerChannel]], [[currentChannel]], [[enableChannel]], [[channelEnabled]], [[radioChannelCreate]]|SEEALSO=


}}
}}

Revision as of 15:46, 7 April 2019

-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. Correspondence between channel and number:
  • 0 = Global
  • 1 = Side
  • 2 = Command
  • 3 = Group
  • 4 = Vehicle
  • 5 = Direct
  • 6-15 = Custom Radio (see radioChannelCreate)
Groups:
Uncategorised

Syntax

Syntax:
setCurrentChannel channel
Parameters:
channel: Number
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);