enableChannel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|1.42|Game version=
|1.42


|eff= local |Multiplayer Effects=
|eff= local


|gr1= Radio and Chat |GROUP1=
|gr1= Radio and Chat


| Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel. If the channel was disabled in [[Description.ext]] or [[server.cfg]], it can be enabled with this command, however the UI functionality changes will be local to the PC executing this command.
| Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel. If the channel was disabled in [[Description.ext]] or [[server.cfg]], it can be enabled with this command, however the UI functionality changes will be local to the PC executing this command.
Line 58: Line 58:
{{!}} 15
{{!}} 15
{{!}}}
{{!}}}
|DESCRIPTION=


| channelID [[enableChannel]] enable |SYNTAX=


|p1= channelID: [[Number]] - [[Channel IDs|channel ID]]|PARAMETER1=
| channelID [[enableChannel]] enable


|p2= enable: [[Boolean]] - [[true]] to enable, [[false]] to disable (both VoN and chat) |PARAMETER2=
|p1= channelID: [[Number]] - [[Channel IDs|channel ID]]


| [[Nothing]] |RETURNVALUE=
|p2= enable: [[Boolean]] - [[true]] to enable, [[false]] to disable (both VoN and chat)


|s2= channelID [[enableChannel]] [chat, VoN] {{Since|arma3|1.59.135661|y}} |SYNTAX2=
| [[Nothing]]
 
|s2= channelID [[enableChannel]] [chat, VoN] {{Since|arma3|1.59.135661|y}}


|p21= channelID: [[Number]] - [[Channel IDs|channel ID]] |PARAMETER21=
|p21= channelID: [[Number]] - [[Channel IDs|channel ID]] |PARAMETER21=
Line 76: Line 76:
|p23= chat: [[Boolean]] - [[true]] to enable text chat |PARAMETER23=
|p23= chat: [[Boolean]] - [[true]] to enable text chat |PARAMETER23=


|p24= VoN: [[Boolean]] - [[true]] to enable voice chat |PARAMETER4=
|p24= VoN: [[Boolean]] - [[true]] to enable voice chat


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]


|x1= <code>0 [[enableChannel]] [[false]]; {{cc|Disable user ability to send voice and text on global channel}}</code> |EXAMPLE1=
|x1= <code>0 [[enableChannel]] [[false]]; {{cc|Disable user ability to send voice and text on global channel}}</code>


|x2= <code>0 [[enableChannel]] [<nowiki/>[[true]], [[false]]]; {{cc|Enable user ability to send text but disable voice on global channel}}</code> |EXAMPLE2=
|x2= <code>0 [[enableChannel]] [<nowiki/>[[true]], [[false]]]; {{cc|Enable user ability to send text but disable voice on global channel}}</code>


|[[currentChannel]], [[setCurrentChannel]], [[getPlayerChannel]], [[channelEnabled]], [[radioChannelCreate]] |SEEALSO=
|[[currentChannel]], [[setCurrentChannel]], [[getPlayerChannel]], [[channelEnabled]], [[radioChannelCreate]]
}}
}}


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>

Revision as of 01:35, 18 January 2021

Arma 3 logo black.png1.42
LELocal
Hover & click on the images for description

Description

Description:
Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel. If the channel was disabled in Description.ext or server.cfg, it can be enabled with this command, however the UI functionality changes will be local to the PC executing this command.
ⓘ
This command:
  • cannot disable Global channel for the admin or server host, because Global channel is always available for the admin
  • does not disable incoming text or voice
  • Prior to Arma 3 v2.01.146856 did not interrupt own client's transmission in progress (but prevented any further ones)
  • does not affect chat related scripting commands such as vehicleChat, globalRadio etc.
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:
channelID enableChannel enable
Parameters:
channelID: Number - channel ID
enable: Boolean - true to enable, false to disable (both VoN and chat)
Return Value:
Nothing

Alternative Syntax

Syntax:
channelID enableChannel [chat, VoN] Template:Since
Parameters:
channelID: Number - channel ID
[chat, VoN]: Array
chat: Boolean - true to enable text chat
VoN: Boolean - true to enable voice chat
Return Value:
Nothing

Examples

Example 1:
0 enableChannel false; // Disable user ability to send voice and text on global channel
Example 2:
0 enableChannel [true, false]; // Enable user ability to send text but disable voice on global channel

Additional Information

See also:
currentChannelsetCurrentChannelgetPlayerChannelchannelEnabledradioChannelCreate

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=enableChannel&oldid=204720"