enableChannel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
m (Some wiki formatting)
Line 8: Line 8:
|gr1= Radio and Chat
|gr1= Radio and Chat


|descr= 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.
|descr= Enables/disables UI functionality which is responsible for sending text or voice chat to the given chat channel.
{{Feature|Informative|
{{Feature|Informative|
This command:
This command:
* can override [[Description.ext]] or [[server.cfg]]'s channel setting
* cannot disable Global channel for the admin or server host, because Global channel is always available for the admin
* 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
* 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)
* actively interrupts (since {{arma3}} v2.02) the current communication in progress
* does not affect chat related scripting commands such as [[vehicleChat]], [[globalRadio]] etc.
* does not affect chat related scripting commands such as [[vehicleChat]], [[globalRadio]] etc.
}}
}}


{{{!}} class{{=}}"wikitable" style{{=}}"text-align: center"
{{{!}} class{{=}}"wikitable" style{{=}}"text-align: center"
! colspan{{=}}"16" {{!}} [[Channel IDs|Channel ID]] number correspondence
! colspan{{=}}"16" {{!}} [[Channel IDs|Channel ID]] number correspondence
{{!}}-
{{!}}-
{{!}} colspan{{=}}"6" {{!}} Default Channels
{{!}} colspan{{=}}"6" {{!}} Default Channels
Line 66: Line 67:
|r1= [[Nothing]]
|r1= [[Nothing]]


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


|p21= channelID: [[Number]] - [[Channel IDs|channel ID]]
|p21= channelID: [[Number]] - [[Channel IDs|channel ID]]


|p22= [chat, VoN]: [[Array]]
|p22= chat: [[Boolean]] - [[true]] to enable text chat


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


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


|x1= <code>0 [[enableChannel]] [[false]]; {{cc|Disable user ability to send voice and text on global channel}}</code>
|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>
|x2= <code>0 [[enableChannel]] [<nowiki/>[[true]], [[false]]]; {{cc|enable user ability to send text but disable voice on global channel}}</code>


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

Revision as of 19:35, 5 August 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.
ⓘ
This command:
  • can override Description.ext or server.cfg's channel setting
  • 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
  • actively interrupts (since Arma 3 v2.02) the current communication in progress
  • 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: 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
Retrieved from "https://community.bistudio.com/wiki?title=enableChannel&oldid=291441"